Providers

List providers

Retrieve a collection of providers

get

/providers

Authorizations

Query parameters

filterstring

Use the filter query parameter to retrieve just a subset of a collection.

searchstring

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystring

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32 · default: 0

Use the skip query parameter to set the number of items to skip at the start of a collection.

topinteger · int32 · min: 1 · max: 100 · default: 100

Use the top query parameter to specify the page size of the result set.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/providers' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

{
  "count": 100,
  "items": [
    {
      "name": "text",
      "enabled": true,
      "brand": "text",
      "did_numbers": "text",
      "shared": true,
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "hostname": "text",
      "port": 80
    }
  ]
}

OK

Create a provider

Add a new provider into system.

post

/providers

Authorizations

Body

namestring · min: 1 · max: 64required

The name of the trunk.

enabledboolean · default: true

Whether to enable the provider.

brandstring · min: 1 · max: 64

The brand of trunk.

auth_idstring · max: 64

Authentication ID, i.e. SIP username.

usernamestring · max: 64

Authentication username.

passwordstring

Password for authentication.

registrationboolean · default: true

Whether registration is required.

register_intervalinteger · int32 · default: 600

Interval for registry refreshment, in seconds.

outbound_serverstringrequired

The outbound server hostname of the trunk.

inlanboolean · default: false

Whether the trunk under LAN or not.

single_via_headerboolean · default: true

Whether this trunk is only accept single Via SIP header or not.

rewrite_via_ipboolean · default: true

Rewrite the host IP of Via header by public IP when sending the request to trunk.

verify_portboolean · default: true

Verify the port when receiving SIP messages from trunk

keep_aliveboolean · default: true

Send OPTIONS message for keep alive.

concurrencyinteger · int32required

The max number of concurrent calls.

keep_alive_intervalinteger · int32 · default: 360

Keep alive message sending interval (seconds).

additional_ipsstring

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_sdp_directionboolean · default: true

Adjust the SDP direction for call hold.

remove_srtp_infoboolean · default: true

Remove crypto line in the SDP.

stir_shaken_signature_requiredboolean · default: false

Whether to enable STIR/SHAKEN signature.

did_numbersstring

The 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.

auth_modestring · enum

Authentication mode:
Can be either:

• IP_AUTH:
• REGISTER_AUTH:
• ACCEPT_REGISTER:
• TEAMS:
• WHATS_APP:

Options: IP_AUTH, REGISTER_AUTH, ACCEPT_REGISTER, TEAMS, WHATS_APP

transportstring · enumrequired

The trunk transport protocol:
Can be either:

• UDP:
• TCP:
• TLS:

Options: UDP, TCP, TLS

hostnameall ofrequired

The hostname of trunk.

Server hostname or IP address

portall ofrequired

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

outbound_server_portall ofrequired

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

inbound_parametersobject

outbound_parametersobject

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/providers' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "enabled": true,
    "brand": "text",
    "auth_id": "text",
    "username": "text",
    "password": "text",
    "registration": true,
    "register_interval": 600,
    "outbound_server": "text",
    "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",
    "auth_mode": "IP_AUTH",
    "transport": "UDP",
    "hostname": "text",
    "port": 80,
    "outbound_server_port": 80,
    "inbound_parameters": {
      "enable_stir_shaken_validation": false,
      "pai_header_parameter_name": "verstat",
      "pass_api_header_to_uad": false,
      "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": "ID",
      "drop_calls_with_verification_status": [
        "text"
      ]
    },
    "outbound_parameters": {
      "request_line_uri_user_part": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "request_line_uri_host_part": {
        "custom_value": "text",
        "value": "TRUNK_HOST_PORT"
      },
      "contact_user_part": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "contact_host_part": {
        "custom_value": "text",
        "value": "TRUNK_HOST_PORT"
      },
      "to_display_name": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "to_user_part": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "to_host_part": {
        "custom_value": "text",
        "value": "TRUNK_HOST_PORT"
      },
      "from_display_name": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "from_user_part": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "from_host_part": {
        "custom_value": "text",
        "value": "TRUNK_HOST_PORT"
      },
      "remote_party_id_called_party_display_name": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "remote_party_id_called_party_user_part": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "remote_party_id_called_party_host_part": {
        "custom_value": "text",
        "value": "TRUNK_HOST_PORT"
      },
      "remote_party_id_calling_party_display_name": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "remote_party_id_calling_party_user_part": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "remote_party_id_calling_party_host_part": {
        "custom_value": "text",
        "value": "TRUNK_HOST_PORT"
      },
      "p_asserted_identity_display_name": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "p_asserted_identity_user_part": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "p_asserted_identity_host_part": {
        "custom_value": "text",
        "value": "TRUNK_HOST_PORT"
      },
      "p_preferred_identify_display_name": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "p_preferred_identify_user_part": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "p_preferred_identify_host_part": {
        "custom_value": "text",
        "value": "TRUNK_HOST_PORT"
      },
      "p_called_party_id_display_name": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "p_called_party_id_user_part": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "p_called_party_id_host_part": {
        "custom_value": "text",
        "value": "TRUNK_HOST_PORT"
      },
      "privacy_types_supported": {
        "value": "ID"
      }
    }
  }'

201

4XX

201

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created

Retrieve a provider

Get details of a provider by it's unique ID.

get

/providers/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of trunk.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/providers/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

{
  "name": "text",
  "enabled": true,
  "brand": "text",
  "auth_id": "text",
  "username": "text",
  "registration": true,
  "register_interval": 600,
  "outbound_server": "text",
  "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",
  "shared": true,
  "auth_mode": "IP_AUTH",
  "transport": "UDP",
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "hostname": "text",
  "port": 80,
  "outbound_server_port": 80,
  "inbound_parameters": {
    "enable_stir_shaken_validation": false,
    "pai_header_parameter_name": "verstat",
    "pass_api_header_to_uad": false,
    "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": "ID",
    "drop_calls_with_verification_status": [
      "text"
    ]
  },
  "outbound_parameters": {
    "request_line_uri_user_part": {
      "custom_value": "text",
      "value": "AUTH_ID"
    },
    "request_line_uri_host_part": {
      "custom_value": "text",
      "value": "TRUNK_HOST_PORT"
    },
    "contact_user_part": {
      "custom_value": "text",
      "value": "AUTH_ID"
    },
    "contact_host_part": {
      "custom_value": "text",
      "value": "TRUNK_HOST_PORT"
    },
    "to_display_name": {
      "custom_value": "text",
      "value": "AUTH_ID"
    },
    "to_user_part": {
      "custom_value": "text",
      "value": "AUTH_ID"
    },
    "to_host_part": {
      "custom_value": "text",
      "value": "TRUNK_HOST_PORT"
    },
    "from_display_name": {
      "custom_value": "text",
      "value": "AUTH_ID"
    },
    "from_user_part": {
      "custom_value": "text",
      "value": "AUTH_ID"
    },
    "from_host_part": {
      "custom_value": "text",
      "value": "TRUNK_HOST_PORT"
    },
    "remote_party_id_called_party_display_name": {
      "custom_value": "text",
      "value": "AUTH_ID"
    },
    "remote_party_id_called_party_user_part": {
      "custom_value": "text",
      "value": "AUTH_ID"
    },
    "remote_party_id_called_party_host_part": {
      "custom_value": "text",
      "value": "TRUNK_HOST_PORT"
    },
    "remote_party_id_calling_party_display_name": {
      "custom_value": "text",
      "value": "AUTH_ID"
    },
    "remote_party_id_calling_party_user_part": {
      "custom_value": "text",
      "value": "AUTH_ID"
    },
    "remote_party_id_calling_party_host_part": {
      "custom_value": "text",
      "value": "TRUNK_HOST_PORT"
    },
    "p_asserted_identity_display_name": {
      "custom_value": "text",
      "value": "AUTH_ID"
    },
    "p_asserted_identity_user_part": {
      "custom_value": "text",
      "value": "AUTH_ID"
    },
    "p_asserted_identity_host_part": {
      "custom_value": "text",
      "value": "TRUNK_HOST_PORT"
    },
    "p_preferred_identify_display_name": {
      "custom_value": "text",
      "value": "AUTH_ID"
    },
    "p_preferred_identify_user_part": {
      "custom_value": "text",
      "value": "AUTH_ID"
    },
    "p_preferred_identify_host_part": {
      "custom_value": "text",
      "value": "TRUNK_HOST_PORT"
    },
    "p_called_party_id_display_name": {
      "custom_value": "text",
      "value": "AUTH_ID"
    },
    "p_called_party_id_user_part": {
      "custom_value": "text",
      "value": "AUTH_ID"
    },
    "p_called_party_id_host_part": {
      "custom_value": "text",
      "value": "TRUNK_HOST_PORT"
    },
    "privacy_types_supported": {
      "value": "ID"
    }
  }
}

OK

Update provider

Update properties of provider by it's unique ID.

post

/providers/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of trunk.

The unique ID of the resource.

Body

namestring · min: 1 · max: 64

The name of the trunk.

enabledboolean · default: true

Whether to enable the provider.

auth_idstring · max: 64

Authentication ID, i.e. SIP username.

usernamestring · max: 64

Authentication username.

passwordstring

Password for authentication.

registrationboolean · default: true

Whether registration is required.

register_intervalinteger · int32 · default: 600

Interval for registry refreshment, in seconds.

outbound_serverstring

The outbound server hostname of the trunk.

inlanboolean · default: false

Whether the trunk under LAN or not.

single_via_headerboolean · default: true

Whether this trunk is only accept single Via SIP header or not.

rewrite_via_ipboolean · default: true

Rewrite the host IP of Via header by public IP when sending the request to trunk.

verify_portboolean · default: true

Verify the port when receiving SIP messages from trunk

keep_aliveboolean · default: true

Send OPTIONS message for keep alive.

keep_alive_intervalinteger · int32 · default: 360

Keep alive message sending interval (seconds).

concurrencyinteger · int32

The max number of concurrent calls.

additional_ipsstring

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_sdp_directionboolean · default: true

Adjust the SDP direction for call hold.

remove_srtp_infoboolean · default: true

Remove crypto line in the SDP.

stir_shaken_signature_requiredboolean · default: false

Whether to enable STIR/SHAKEN signature.

did_numbersstring

The 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.

transportstring · enum

The trunk transport protocol:
Can be either:

• UDP:
• TCP:
• TLS:

Options: UDP, TCP, TLS

hostnameall of

The hostname of trunk.

Server hostname or IP address

portall of

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

outbound_server_portall of

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

inbound_parametersobject

outbound_parametersobject

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/providers/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "enabled": true,
    "auth_id": "text",
    "username": "text",
    "password": "text",
    "registration": true,
    "register_interval": 600,
    "outbound_server": "text",
    "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",
    "transport": "UDP",
    "hostname": "text",
    "port": 80,
    "outbound_server_port": 80,
    "inbound_parameters": {
      "enable_stir_shaken_validation": false,
      "pai_header_parameter_name": "verstat",
      "pass_api_header_to_uad": false,
      "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": "ID",
      "drop_calls_with_verification_status": [
        "text"
      ]
    },
    "outbound_parameters": {
      "request_line_uri_user_part": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "request_line_uri_host_part": {
        "custom_value": "text",
        "value": "TRUNK_HOST_PORT"
      },
      "contact_user_part": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "contact_host_part": {
        "custom_value": "text",
        "value": "TRUNK_HOST_PORT"
      },
      "to_display_name": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "to_user_part": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "to_host_part": {
        "custom_value": "text",
        "value": "TRUNK_HOST_PORT"
      },
      "from_display_name": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "from_user_part": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "from_host_part": {
        "custom_value": "text",
        "value": "TRUNK_HOST_PORT"
      },
      "remote_party_id_called_party_display_name": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "remote_party_id_called_party_user_part": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "remote_party_id_called_party_host_part": {
        "custom_value": "text",
        "value": "TRUNK_HOST_PORT"
      },
      "remote_party_id_calling_party_display_name": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "remote_party_id_calling_party_user_part": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "remote_party_id_calling_party_host_part": {
        "custom_value": "text",
        "value": "TRUNK_HOST_PORT"
      },
      "p_asserted_identity_display_name": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "p_asserted_identity_user_part": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "p_asserted_identity_host_part": {
        "custom_value": "text",
        "value": "TRUNK_HOST_PORT"
      },
      "p_preferred_identify_display_name": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "p_preferred_identify_user_part": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "p_preferred_identify_host_part": {
        "custom_value": "text",
        "value": "TRUNK_HOST_PORT"
      },
      "p_called_party_id_display_name": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "p_called_party_id_user_part": {
        "custom_value": "text",
        "value": "AUTH_ID"
      },
      "p_called_party_id_host_part": {
        "custom_value": "text",
        "value": "TRUNK_HOST_PORT"
      },
      "privacy_types_supported": {
        "value": "ID"
      }
    }
  }'

200

4XX

200

No body

OK