PROVIDER

Retrive a list of SIP trunks/VoIP providers

GET /providers/list

Retrieves a list of SIP trunks/VoIP providers preconfigured, and a maximum of 100 providers will be returned each time.

Request

Placeholders

access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.
pagination
integer
required
The pagination of paging.
pagesize
integer
required
The pagesize of paging.
sort_by
enum
required
Values include "DEFAULT" and "Optional". Default value will be used when user does not specify value for this field.

Sample Request

https://example.com/api/providers/list?access_token=196ACE20C6F34027895F7F95402BB164&pagesize=100&pagination=1&sort_by=DEFAULT

Response

Placeholders

pagination
integer
required
The pagination of paging.
pagesize
integer
required
The pagesize of paging.
sort_by
enum
required
Values include "DEFAULT" and "Optional". Default value will be used when user does not specify value for this field.
page_count
integer
required
The total count of pages.
count
integer
required
Current pagesize.
providers
array
required
Collection of provider objects returned.
Show child attributes
- id
  string
  required
  ID of preconfigured provider.
- name
  string
  required
  Name of preconfigured provider.
- hostname
  string
  required
  SIP server hostname or IP address (also referred to as Registrar Server).
- port
  integer
  required
  Host port for SIP server.
- global
  boolean
  required
- tenantid
  string
  required
  Tenantid for SIP server.
- status
  string
  required
  Values: "REGISTERED" or "UNREGISTERED".

Sample Response

{
    "pagination": 1,
    "pagesize": 100,
    "sort_by": "DEFAULT",
    "page_count": 100,
    "count": 100,
    "providers": [
        {
            "name": "test",
            "hostname": "callcentric.com",
            "port": 5060
        }
    ]
}

Retrive settings for providers

GET /providers/show

Retrieves the settings of certain providers.

Request

Placeholders

access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.
id
string
required
ID of provider for which the settings will be obtained.

Sample Request

https://example.com/api/providers/show?access_token=196ACE20C6F34027895F7F95402BB164&id=3C13F923-1388-4E22-9782-D171FABC269D

Response

Placeholders

id
string
required
ID of preconfigured provider.
name
string
required
Name of preconfigured provider.
hostname
string
required
SIP server hostname. It could be either domain name or IP address.
port
integer
required
Host port for SIP server.
outbound_server
string
optional
Outbound server.
outbound_server_port
integer
optional
Port number for Outbound server.
auth_id
string
required
Authentication ID, i.e. SIP username.
password
string
required
Password for authentication.
max_concurrent_calls
integer
required
The maximum count of concurrent calls allowed.
reregister_interval
integer
required
Interval for registry refreshment, in seconds.
country
string
required
Country that the provider locates in.
provider_brand
string
required
Provider name.
website
string
optional
Official website for SIP trunks or VoIP providers.
username
string
optional
Username for SIP trunks or VoIP providers.
require_register
boolean
required
Indicates if SIP trunks or VoIP providers need to be registered.
provider_in_lan
boolean
required
global
boolean
required
in_parameters
array
required
Show child attributes
- Variable
  string
  required
  Variable of provider inbound rule param.
- SIP_Field
  string
  required
  SIP field of provider inbound rule param.
out_parameters
array
required
Show child attributes
- SIP_Field
  string
  required
  SIP field of provider inbound rule param.
- Variable
  string
  required
  Variable of provider inbound rule param.
- Custom_Value
  string
  required
  Custom value of provider inbound rule param.

Sample Response

{
    "id": "3C13F923-1388-4E22-9782-D171FABC269D",
    "name": "test",
    "hostname": "callcentric.com",
    "port": 5060,
    "outbound_server": "callcentric.com",
    "outbound_server_port": 5060,
    "auth_id": "test",
    "password": "test",
    "max_concurrent_calls": 100,
    "reregister_interval": 600,
    "country": "US",
    "provider_brand": "CallCentric",
    "website": "http://www.callcentric.com/",
    "username": "xxxxx",
    "require_register": true,
    "global": true,
    "provider_in_lan": true,
    "in_parameters": [
        {
            "Variable": "called_num",
            "SIP_Field": "sip_msg_default_value"
        },
        {
            "Variable": "caller_num",
            "SIP_Field": "sip_msg_default_value"
        },
        {
            "Variable": "outbound_caller_id",
            "SIP_Field": "sip_msg_default_value"
        },
        {
            "Variable": "caller_display_name",
            "SIP_Field": "sip_msg_default_value"
        },
        {
            "Variable": "called_display_name",
            "SIP_Field": "sip_msg_default_value"
        },
        {
            "Variable": "contact_uri",
            "SIP_Field": "sip_msg_default_value"
        }
    ],
    "out_parameters": [
        {
            "SIP_Field": "sip_msg_request_line_user",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_request_line_host",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_contact_user",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_contact_host",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_to_display_name",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_to_user",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_to_host",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_from_display_name",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_from_user",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_from_host",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_user_agent_text",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_p_asserted_id_display_name",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_p_asserted_id_user",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_p_asserted_id_host",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_p_preferred_id_display_name",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_p_preferred_id_user",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_p_preferred_id_host",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_p_called_party_id_display_name",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_p_called_party_id_user",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_p_called_party_id_host",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        }
    ]
}

Create a provider

POST /providers/create

Creates a new provider.

Request

Placeholders

access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.
name
string
required
Name of preconfigured provider.
hostname
string
required
SIP server hostname. It could be either domain name or IP address.
port
integer
required
Host port for SIP server.
outbound_server
string
optional
Outbound server.
outbound_server_port
integer
optional
Port number for Outbound server.
auth_id
string
required
Authentication ID, i.e. SIP username.
password
string
required
Password for authentication.
max_concurrent_calls
integer
required
The maximum count of concurrent calls allowed.
reregister_interval
integer
required
Interval for registry refreshment, in seconds.
country
string
required
Country that the provider locates in.
provider_brand
string
required
Provider name
website
string
optional
Official website for SIP trunks or VoIP providers.
username
string
optional
Username for SIP trunks or VoIP providers.
require_register
boolean
required
Indicates if SIP trunks or VoIP providers need to be registered.
provider_in_lan
boolean
required
global
boolean
required

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "name": "test",
    "hostname": "callcentric.com",
    "port": 5060,
    "outbound_server": "callcentric.com",
    "outbound_server_port": 5060,
    "auth_id": "test",
    "password": "test",
    "max_concurrent_calls": 100,
    "reregister_interval": 600,
    "country": "US",
    "provider_brand": "CallCentric",
    "website": "http://www.callcentric.com/",
    "username": "xxxx",
    "require_register": true,
    "provider_in_lan": false,
    "global": false
}

Response

Placeholders

Sample Response

Update a provider

POST /providers/update

Modify the settings of a provider.

Request

Placeholders

access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.
id
string
required
ID of preconfigured provider.
name
string
required
Name of preconfigured provider.
password
string
required
Password for authentication.
hostname
string
required
SIP server hostname. It could be either domain name or IP address.
port
integer
required
Host port for SIP server.
outbound_server
string
optional
Outbound server.
outbound_server_port
integer
optional
Port number for Outbound server.
auth_id
string
required
Authentication ID, i.e. SIP username.
max_concurrent_calls
integer
required
The maximum count of concurrent calls allowed.
reregister_interval
integer
required
Interval for registry refreshment, in seconds.
country
string
required
Country that the provider locates in.
provider_brand
string
required
Provider name.
website
string
optional
Official website for SIP trunks or VoIP providers.
username
string
optional
Username for SIP trunks or VoIP providers.
require_register
boolean
required
Indicates if SIP trunks or VoIP providers need to be registered.
provider_in_lan
boolean
required
global
boolean
required
in_parameters
array
required
Show child attributes
- Variable
  string
  required
  Variable of provider inbound rule param.
- SIP_Field
  string
  required
  SIP field of provider inbound rule param.
out_parameters
array
required
Show child attributes
- SIP_Field
  string
  required
  SIP field of provider inbound rule param.
- Variable
  string
  required
  Variable of provider inbound rule param.
- Custom_Value
  string
  required
  Custom value of provider inbound rule param.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "id": "3C13F923-1388-4E22-9782-D171FABC269D",
    "name": "test",
    "hostname": "callcentric.com",
    "port": 5060,
    "outbound_server": "callcentric.com",
    "outbound_server_port": 5060,
    "auth_id": "test",
    "max_concurrent_calls": 100,
    "reregister_interval": 600,
    "country": "US",
    "provider_brand": "CallCentric",
    "website": "http://www.callcentric.com/",
    "username": "xxxx",
    "require_register": true,
    "provider_in_lan": true,
    "global": true,
    "in_parameters": [
        {
            "Variable": "called_num",
            "SIP_Field": "sip_msg_default_value"
        },
        {
            "Variable": "caller_num",
            "SIP_Field": "sip_msg_default_value"
        },
        {
            "Variable": "outbound_caller_id",
            "SIP_Field": "sip_msg_default_value"
        },
        {
            "Variable": "caller_display_name",
            "SIP_Field": "sip_msg_default_value"
        },
        {
            "Variable": "called_display_name",
            "SIP_Field": "sip_msg_default_value"
        },
        {
            "Variable": "contact_uri",
            "SIP_Field": "sip_msg_default_value"
        }
    ],
    "out_parameters": [
        {
            "SIP_Field": "sip_msg_request_line_user",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_request_line_host",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_contact_user",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_contact_host",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_to_display_name",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_to_user",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_to_host",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_from_display_name",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_from_user",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_from_host",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_user_agent_text",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_p_asserted_id_display_name",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_p_asserted_id_user",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_p_asserted_id_host",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_p_preferred_id_display_name",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_p_preferred_id_user",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_p_preferred_id_host",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_p_called_party_id_display_name",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_p_called_party_id_user",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        },
        {
            "SIP_Field": "sip_msg_p_called_party_id_host",
            "Variable": "sip_msg_default_value",
            "Custom_Value": ""
        }
    ]
}

Response

Placeholders

Sample Response

Remove a provider

POST /providers/destroy

Deletes a configured provider.

Request

Placeholders

access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.
id
string
required
ID of provider to be deleted.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "id": "3C13F923-1388-4E22-9782-D171FABC269D"
}

Response

Placeholders

Sample Request

pagination

pagesize

sort_by

page_count

count

providers

id

name

hostname

port

global

tenantid

status

Sample Response

Sample Request

id

name

hostname

port

outbound_server

outbound_server_port

auth_id

password

max_concurrent_calls

reregister_interval

country

provider_brand

website

username

require_register

provider_in_lan

global

in_parameters

Variable

SIP_Field

out_parameters

SIP_Field

Variable

Custom_Value

Sample Response

Sample Request

Sample Response

Sample Request

Sample Response

Sample Request

Sample Response

`pagination`

`pagesize`

`sort_by`

`page_count`

`count`

`providers`

`id`

`name`

`hostname`

`port`

`global`

`tenantid`

`status`

`id`

`name`

`hostname`

`port`

`outbound_server`

`outbound_server_port`

`auth_id`

`password`

`max_concurrent_calls`

`reregister_interval`

`country`

`provider_brand`

`website`

`username`

`require_register`

`provider_in_lan`

`global`

`in_parameters`

`Variable`

`SIP_Field`

`out_parameters`

`SIP_Field`

`Variable`

`Custom_Value`