Trunks
Manage your trunks.
Retrieve a collection of providers
Use the filter query parameter to retrieve just a subset of a collection.
Use the search query parameter to restrict the results of a request to match a search criterion.
Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.
Use the skip query parameter to set the number of items to skip at the start of a collection.
0Use the top query parameter to specify the page size of the result set.
100GET /api/providers HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 100,
"items": [
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"name": "text",
"enabled": true,
"brand": "text",
"hostname": "text",
"port": 80,
"did_numbers": "text",
"shared": true
}
]
}Add a new provider into system.
The name of the trunk.
Whether to enable the provider.
trueThe brand of trunk.
Authentication mode:
Can be either:
IP_AUTH:REGISTER_AUTH:ACCEPT_REGISTER:TEAMS:WHATS_APP:
The trunk transport protocol:
Can be either:
UDP:TCP:TLS:
The hostname of trunk.
Server hostname or IP address
The port pf trunk.
A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535. For TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port
80Authentication ID, i.e. SIP username.
Authentication username.
Password for authentication.
Whether registration is required.
trueInterval for registry refreshment, in seconds.
600The outbound server hostname of the trunk.
The outbound server port of the trunk.
A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535. For TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port
80Whether the trunk under LAN or not.
falseWhether this trunk is only accept single Via SIP header or not.
trueRewrite the host IP of Via header by public IP when sending the request to trunk.
trueVerify the port when receiving SIP messages from trunk
trueSend OPTIONS message for keep alive.
trueThe max number of concurrent calls.
Keep alive message sending interval (seconds).
360The additional IP addresses of provider.
A semicolon-separated list of IP addresses in CIDR format.
For example: 192.0.2.0/24;192.0.2.0/32 as defined in RFC 4632 and RFC 4291.
Adjust the SDP direction for call hold.
trueRemove crypto line in the SDP.
trueWhether to enable STIR/SHAKEN signature.
falseThe semicolon-separated list of DID/DDI pool number range or DID/DDI number. Assign a DID/DDI pool number range or DID/DDI number to the tenant. For example: 3000;12000-18000. The DID/DDI pool number range should not overlap with other tenant DID/DDI pool number ranges and numbers.
POST /api/providers HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2816
{
"name": "text",
"enabled": true,
"brand": "text",
"auth_mode": "IP_AUTH",
"transport": "UDP",
"hostname": "text",
"port": 80,
"auth_id": "text",
"username": "text",
"password": "text",
"registration": true,
"register_interval": 600,
"outbound_server": "text",
"outbound_server_port": 80,
"inlan": false,
"single_via_header": true,
"rewrite_via_ip": true,
"verify_port": true,
"keep_alive": true,
"concurrency": 1,
"keep_alive_interval": 360,
"additional_ips": "text",
"adjust_sdp_direction": true,
"remove_srtp_info": true,
"stir_shaken_signature_required": false,
"did_numbers": "text",
"inbound_parameters": {
"caller_num": "REQUEST_LINE_URI_USER_PART",
"caller_display_name": "REQUEST_LINE_URI_USER_PART",
"called_num": "REQUEST_LINE_URI_USER_PART",
"privacy_types_supported": "DEFAULT",
"enable_stir_shaken_validation": false,
"pai_header_parameter_name": "verstat",
"drop_calls_with_verification_status": [
"text"
],
"pass_api_header_to_uad": false
},
"outbound_parameters": {
"request_line_uri_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"request_line_uri_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"contact_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"contact_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"to_display_name": {
"value": "AUTH_ID",
"custom_value": "text"
},
"to_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"to_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"from_display_name": {
"value": "AUTH_ID",
"custom_value": "text"
},
"from_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"from_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"remote_party_id_called_party_display_name": {
"value": "AUTH_ID",
"custom_value": "text"
},
"remote_party_id_called_party_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"remote_party_id_called_party_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"remote_party_id_calling_party_display_name": {
"value": "AUTH_ID",
"custom_value": "text"
},
"remote_party_id_calling_party_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"remote_party_id_calling_party_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"p_asserted_identity_display_name": {
"value": "AUTH_ID",
"custom_value": "text"
},
"p_asserted_identity_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"p_asserted_identity_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"p_preferred_identify_display_name": {
"value": "AUTH_ID",
"custom_value": "text"
},
"p_preferred_identify_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"p_preferred_identify_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"p_called_party_id_display_name": {
"value": "AUTH_ID",
"custom_value": "text"
},
"p_called_party_id_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"p_called_party_id_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"privacy_types_supported": "DEFAULT"
}
}{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}Get details of a provider by it's unique ID.
The unique ID of trunk.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /api/providers/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"name": "text",
"enabled": true,
"brand": "text",
"auth_mode": "IP_AUTH",
"transport": "UDP",
"hostname": "text",
"port": 80,
"auth_id": "text",
"username": "text",
"registration": true,
"register_interval": 600,
"outbound_server": "text",
"outbound_server_port": 80,
"inlan": false,
"single_via_header": true,
"rewrite_via_ip": true,
"verify_port": true,
"keep_alive": true,
"keep_alive_interval": 360,
"concurrency": 1,
"additional_ips": "text",
"adjust_sdp_direction": true,
"remove_srtp_info": true,
"stir_shaken_signature_required": false,
"did_numbers": "text",
"inbound_parameters": {
"caller_num": "REQUEST_LINE_URI_USER_PART",
"caller_display_name": "REQUEST_LINE_URI_USER_PART",
"called_num": "REQUEST_LINE_URI_USER_PART",
"privacy_types_supported": "DEFAULT",
"enable_stir_shaken_validation": false,
"pai_header_parameter_name": "verstat",
"drop_calls_with_verification_status": [
"text"
],
"pass_api_header_to_uad": false
},
"outbound_parameters": {
"request_line_uri_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"request_line_uri_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"contact_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"contact_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"to_display_name": {
"value": "AUTH_ID",
"custom_value": "text"
},
"to_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"to_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"from_display_name": {
"value": "AUTH_ID",
"custom_value": "text"
},
"from_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"from_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"remote_party_id_called_party_display_name": {
"value": "AUTH_ID",
"custom_value": "text"
},
"remote_party_id_called_party_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"remote_party_id_called_party_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"remote_party_id_calling_party_display_name": {
"value": "AUTH_ID",
"custom_value": "text"
},
"remote_party_id_calling_party_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"remote_party_id_calling_party_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"p_asserted_identity_display_name": {
"value": "AUTH_ID",
"custom_value": "text"
},
"p_asserted_identity_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"p_asserted_identity_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"p_preferred_identify_display_name": {
"value": "AUTH_ID",
"custom_value": "text"
},
"p_preferred_identify_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"p_preferred_identify_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"p_called_party_id_display_name": {
"value": "AUTH_ID",
"custom_value": "text"
},
"p_called_party_id_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"p_called_party_id_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"privacy_types_supported": "DEFAULT"
},
"shared": true
}Update properties of provider by it's unique ID.
The unique ID of trunk.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe name of the trunk.
Whether to enable the provider.
trueThe trunk transport protocol:
Can be either:
UDP:TCP:TLS:
The hostname of trunk.
Server hostname or IP address
The port pf trunk.
A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535. For TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port
80Authentication ID, i.e. SIP username.
Authentication username.
Password for authentication.
Whether registration is required.
trueInterval for registry refreshment, in seconds.
600The outbound server hostname of the trunk.
The outbound server port of the trunk.
A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535. For TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port
80Whether the trunk under LAN or not.
falseWhether this trunk is only accept single Via SIP header or not.
trueRewrite the host IP of Via header by public IP when sending the request to trunk.
trueVerify the port when receiving SIP messages from trunk
trueSend OPTIONS message for keep alive.
trueKeep alive message sending interval (seconds).
360The max number of concurrent calls.
The additional IP addresses of provider.
A semicolon-separated list of IP addresses in CIDR format.
For example: 192.0.2.0/24;192.0.2.0/32 as defined in RFC 4632 and RFC 4291.
Adjust the SDP direction for call hold.
trueRemove crypto line in the SDP.
trueWhether to enable STIR/SHAKEN signature.
falseThe semicolon-separated list of DID/DDI pool number range or DID/DDI number. Assign a DID/DDI pool number range or DID/DDI number to the tenant. For example: 3000;12000-18000. The DID/DDI pool number range should not overlap with other tenant DID/DDI pool number ranges and numbers.
POST /api/providers/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2779
{
"name": "text",
"enabled": true,
"transport": "UDP",
"hostname": "text",
"port": 80,
"auth_id": "text",
"username": "text",
"password": "text",
"registration": true,
"register_interval": 600,
"outbound_server": "text",
"outbound_server_port": 80,
"inlan": false,
"single_via_header": true,
"rewrite_via_ip": true,
"verify_port": true,
"keep_alive": true,
"keep_alive_interval": 360,
"concurrency": 1,
"additional_ips": "text",
"adjust_sdp_direction": true,
"remove_srtp_info": true,
"stir_shaken_signature_required": false,
"did_numbers": "text",
"inbound_parameters": {
"caller_num": "REQUEST_LINE_URI_USER_PART",
"caller_display_name": "REQUEST_LINE_URI_USER_PART",
"called_num": "REQUEST_LINE_URI_USER_PART",
"privacy_types_supported": "DEFAULT",
"enable_stir_shaken_validation": false,
"pai_header_parameter_name": "verstat",
"drop_calls_with_verification_status": [
"text"
],
"pass_api_header_to_uad": false
},
"outbound_parameters": {
"request_line_uri_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"request_line_uri_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"contact_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"contact_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"to_display_name": {
"value": "AUTH_ID",
"custom_value": "text"
},
"to_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"to_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"from_display_name": {
"value": "AUTH_ID",
"custom_value": "text"
},
"from_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"from_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"remote_party_id_called_party_display_name": {
"value": "AUTH_ID",
"custom_value": "text"
},
"remote_party_id_called_party_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"remote_party_id_called_party_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"remote_party_id_calling_party_display_name": {
"value": "AUTH_ID",
"custom_value": "text"
},
"remote_party_id_calling_party_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"remote_party_id_calling_party_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"p_asserted_identity_display_name": {
"value": "AUTH_ID",
"custom_value": "text"
},
"p_asserted_identity_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"p_asserted_identity_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"p_preferred_identify_display_name": {
"value": "AUTH_ID",
"custom_value": "text"
},
"p_preferred_identify_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"p_preferred_identify_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"p_called_party_id_display_name": {
"value": "AUTH_ID",
"custom_value": "text"
},
"p_called_party_id_user_part": {
"value": "AUTH_ID",
"custom_value": "text"
},
"p_called_party_id_host_part": {
"value": "TRUNK_HOST_PORT",
"custom_value": "text"
},
"privacy_types_supported": "DEFAULT"
}
}No content
Get status of provider by it's unique ID.
The unique ID of trunk.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /api/providers/{id}/status HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "ONLINE"
}Destroy provider by it's unique ID.
The unique ID of trunk.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/providers/{id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content