Providers

List providers

Retrieve a collection of providers

GEThttp://127.0.0.1:8888/api/providers

Query parameters

Response

Body

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

const response = await fetch('http://127.0.0.1:8888/api/providers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Create a provider

Add a new provider into system.

POSThttp://127.0.0.1:8888/api/providers

Body

name*string

The name of the trunk.

enabledboolean

Whether to enable the provider.

brandstring

The brand of trunk.

auth_modeenum

Authentication mode:
Can be either:

IP_AUTH:
REGISTER_AUTH:
ACCEPT_REGISTER:
TEAMS:
WHATS_APP:

IP_AUTHREGISTER_AUTHACCEPT_REGISTERTEAMSWHATS_APP

transport*enum

The trunk transport protocol:
Can be either:

UDP:
TCP:
TLS:

UDPTCPTLS

hostname*all of

The hostname of trunk.

port*all of

The port pf trunk.

auth_idstring

Authentication ID, i.e. SIP username.

usernamestring

Authentication username.

passwordstring

Password for authentication.

registrationboolean

Whether registration is required.

register_intervalinteger (int32)

Interval for registry refreshment, in seconds.

outbound_server*string

The outbound server hostname of the trunk.

outbound_server_port*all of

The outbound server port of the trunk.

inlanboolean

Whether the trunk under LAN or not.

single_via_headerboolean

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

rewrite_via_ipboolean

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

verify_portboolean

Verify the port when receiving SIP messages from trunk

keep_aliveboolean

Send OPTIONS message for keep alive.

concurrency*integer (int32)

The max number of concurrent calls.

keep_alive_intervalinteger (int32)

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

Adjust the SDP direction for call hold.

remove_srtp_infoboolean

Remove crypto line in the SDP.

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.

inbound_parametersobject

outbound_parametersobject

Response

Created

Body

idall of

The unique ID of trunk.

Request

const response = await fetch('http://127.0.0.1:8888/api/providers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "transport": "UDP",
      "hostname": {},
      "port": {},
      "outbound_server": "text",
      "outbound_server_port": {}
    }),
});
const data = await response.json();

Response

{
  "id": {}
}

Retrieve a provider

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

GEThttp://127.0.0.1:8888/api/providers/{id}

Path parameters

id*all of

The unique ID of trunk.

Response

Body

idall of

The unique ID of trunk.

namestring

The name of the trunk.

enabledboolean

Whether to enable the provider.

brandstring

The brand of trunk.

auth_modeenum

Authentication mode:
Can be either:

IP_AUTH:
REGISTER_AUTH:
ACCEPT_REGISTER:
TEAMS:
WHATS_APP:

IP_AUTHREGISTER_AUTHACCEPT_REGISTERTEAMSWHATS_APP

transportenum

The trunk transport protocol:
Can be either:

UDP:
TCP:
TLS:

UDPTCPTLS

hostnameall of

The hostname of trunk.

portall of

The port pf trunk.

auth_idstring

Authentication ID, i.e. SIP username.

usernamestring

Authentication username.

registrationboolean

Whether registration is required.

register_intervalinteger (int32)

Interval for registry refreshment, in seconds.

outbound_serverstring

The outbound server hostname of the trunk.

outbound_server_portall of

The outbound server port of the trunk.

inlanboolean

Whether the trunk under LAN or not.

single_via_headerboolean

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

rewrite_via_ipboolean

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

verify_portboolean

Verify the port when receiving SIP messages from trunk

keep_aliveboolean

Send OPTIONS message for keep alive.

keep_alive_intervalinteger (int32)

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

Adjust the SDP direction for call hold.

remove_srtp_infoboolean

Remove crypto line in the SDP.

did_numbersstring

inbound_parametersobject

outbound_parametersobject

sharedboolean

The flag of whether the trunk is shared.

Request

const response = await fetch('http://127.0.0.1:8888/api/providers/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": {},
  "name": "text",
  "enabled": true,
  "brand": "text",
  "auth_mode": "IP_AUTH",
  "transport": "UDP",
  "hostname": {},
  "port": {},
  "auth_id": "text",
  "username": "text",
  "registration": true,
  "outbound_server": "text",
  "outbound_server_port": {},
  "inlan": false,
  "single_via_header": true,
  "rewrite_via_ip": true,
  "verify_port": true,
  "keep_alive": true,
  "additional_ips": "text",
  "adjust_sdp_direction": true,
  "remove_srtp_info": true,
  "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": "ID"
  },
  "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": {
      "value": "ID"
    }
  },
  "shared": false
}

Update provider

Update properties of provider by it's unique ID.

POSThttp://127.0.0.1:8888/api/providers/{id}

Path parameters

id*all of

The unique ID of trunk.

Body

namestring

The name of the trunk.

enabledboolean

Whether to enable the provider.

transportenum

The trunk transport protocol:
Can be either:

UDP:
TCP:
TLS:

UDPTCPTLS

hostnameall of

The hostname of trunk.

portall of

The port pf trunk.

auth_idstring

Authentication ID, i.e. SIP username.

usernamestring

Authentication username.

passwordstring

Password for authentication.

registrationboolean

Whether registration is required.

register_intervalinteger (int32)

Interval for registry refreshment, in seconds.

outbound_serverstring

The outbound server hostname of the trunk.

outbound_server_portall of

The outbound server port of the trunk.

inlanboolean

Whether the trunk under LAN or not.

single_via_headerboolean

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

rewrite_via_ipboolean

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

verify_portboolean

Verify the port when receiving SIP messages from trunk

keep_aliveboolean

Send OPTIONS message for keep alive.

keep_alive_intervalinteger (int32)

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

Adjust the SDP direction for call hold.

remove_srtp_infoboolean

Remove crypto line in the SDP.

did_numbersstring

inbound_parametersobject

outbound_parametersobject

Response

Request

const response = await fetch('http://127.0.0.1:8888/api/providers/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

PreviousMembers NextStatus

const response = await fetch('http://127.0.0.1:8888/api/providers/{id}', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({}), }); const data = await response.json();

const response = await fetch('http://127.0.0.1:8888/api/providers', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "name": "text", "transport": "UDP", "hostname": {}, "port": {}, "outbound_server": "text", "outbound_server_port": {} }), }); const data = await response.json();

{ "id": {}, "name": "text", "enabled": true, "brand": "text", "auth_mode": "IP_AUTH", "transport": "UDP", "hostname": {}, "port": {}, "auth_id": "text", "username": "text", "registration": true, "outbound_server": "text", "outbound_server_port": {}, "inlan": false, "single_via_header": true, "rewrite_via_ip": true, "verify_port": true, "keep_alive": true, "additional_ips": "text", "adjust_sdp_direction": true, "remove_srtp_info": true, "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": "ID" }, "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": { "value": "ID" } }, "shared": false }