Update Inbound Trunk#

Updates an inbound trunk.

Request#

HTTP Method: PATCH

URI Path: /v3/voice_in_trunks/

URI Query Parameters#

Name

Type

Is Required?

Description

id

string

Yes

Unique ID identifier of Trunk.

Data Attributes#

Name

Type

Nullable

Is Required?

Description

priority

integer

No

Yes

The priority of this target host.
DIDWW will attempt to contact the target trunk with the lowest-numbered priority;
target trunk with the same priority will be tried in an order defined by the weight field.
The range is 0-65535. See RFC 2782 for more details.

weight

integer

No

Yes

A trunk selection mechanism.
The weight field specifies a relative weight for entries with the same priority.
Larger weights will be given a proportionately higher probability of being selected.
The range of this number is 0-65535.
In the presence of records containing weights greater than 0, records with weight 0 will have a very small chance of being selected.
See RFC 2782 for more details.

capacity_limit

integer

No

No

Maximum number of simultaneous calls for the trunk.

ringing_timeout

integer

No

No

Ring time in seconds. Supported values are integers from 1 to 32. If null, the timeout is undefined.
If the call is not connected within this time, the transaction is ended with the disconnect code Ringing timeout.

name

string

No

Yes

Friendly name of the trunk.

external_reference_id

string

Yes

No

Optional identifier for the inbound trunk in the customer’s external system. Maximum length is 100 characters.

cli_format

string

No

No

RAW - Do not alter CLI (default).
E164 - Attempt to convert CLI to E.164 format.
Local - Attempt to convert CLI to Localized format.
CLI format conversion may not work correctly for phone calls originating from outside the country of that specific DID.

cli_prefix

string

No

No

You may prefix the CLI with an optional + sign followed by up to 6 characters, including digits and #.

description

string

No

No

Optional description of the trunk.

configuration

One of sip_configurations,
pstn_configurations

N/A

Yes

Trunk configuration complex object.

Object Relationships#

Value

Description

voice_in_trunk_group

Trunk Group Object

pop

POP Object

Attributes Configuration#

Name

Type

Nullable

Is Required?

Description

type

sip_configurations

No

Yes

SIP configuration complex object.

attributes

sip_configuration_attributes

No

Yes

SIP configuration attributes object.

Configuration Attributes#

Name

Type

Nullable

Is Required?

Description

username

string

No

Yes

User part of R-URI in INVITE request.
You also may use “{DID}” pattern which will be replaced by called DID number in E164 format.
For example, you can set Username to “+{DID}”; if you wish to have it in +E164 format

host

string

No

Yes

Host part of R-URI in INVITE request.

port

integer

No

No

Port part of R-URI in INVITE request (is not mandatory).
If port is null, SRV record will be resolved (or A record if SRV is unavailable).

codec_ids

array

No

No

Codecs.

rx_dtmf_format_id

integer

No

No

The method id for receiving DTMF signals from customers equipment.
Possible values:
1 - RFC 2833
2 - SIP INFO application/dtmf-relay OR application/dtmf
3 - RFC 2833 OR SIP INFO

tx_dtmf_format_id

integer

No

No

The method of sending DTMF signals to the customer’s equipment.
Possible values:
0 - Disable sending
1 - RFC 2833
2 - SIP INFO application/dtmf-relay
4 - SIP INFO application/dtmf

resolve_ruri

boolean

No

No

Replace host part of the R-URI by resolved IP address.

auth_enabled

boolean

No

No

Enable authorization for the SIP server.

auth_user

string

No

No

Optional authorization user for the SIP server.

auth_password

string

No

No

Optional authorization password for the SIP server.

auth_from_user

string

No

No

Specify user in a from field instead of CallerID (overrides CallerID).
Some equipment require from; to be equivalent to Auth user.

auth_from_domain

string

No

No

Sets default from domain in SIP messages. Some equipment may require specific From Domain.

sst_enabled

boolean

No

No

Enable SIP Session timers customization.
SIP session timers are used to make sure that a session (dialog) is still alive,
even though there may have been a long time since the last in-dialog message.
If the other end is not responding, the dialog will be hung up automatically.
SIP session timers need to be supported by all end points for it to work.
It’s a SIP extension, standardized by the IETF.
See RFC 4028 for more details.

sst_min_timer

integer

No

No

Minimal SIP Session timer value (Default 600 seconds).
See RFC 4028 for more details.

sst_max_timer

integer

No

No

Maximal SIP Session timer value (Default 900 seconds).
See RFC 4028 for more details.

sst_accept_501

boolean

No

No

Do not drop the call after receiving SIP 501 response for non-critical messages.

sip_timer_b

integer

No

No

INVITE transaction timeout (Default 8000ms).
See RFC 3261 Section 17.1.1.2 for more details.

dns_srv_failover_timer

integer

No

No

Invite transaction timeout for each of gateways with DNS SRV rerouting (Default 2000ms).

rtp_ping

boolean

No

No

Use RTP PING when connecting a call.
After establishing the call, DIDWW will send empty RTP packet RTP PING.
It is necessary if both parties operate in Symmetric RTP / Comedia mode and expect the other party to start sending RTP first.

rtp_timeout

integer

No

No

Disconnect the call if the RTP packets do not arrive within the specified time.

force_symmetric_rtp

boolean

No

No

Forced to work in Symmetric RTP / COMEDIA mode.

symmetric_rtp_ignore_rtcp

boolean

No

No

Avoid switching RTP session based on RTCP packet while working in Symmetric RTP / COMEDIA.
Only RTP packets will be considered.

rerouting_disconnect_code_ids

array

No

No

Rerouting disconnect codes.

sst_session_expires

integer

No

No

Session-Expires header value. Optional, should be in range with sst_min_timer and sst_max_timer.
See RFC 4028 for more details.

sst_refresh_method_id

integer

No

No

SIP method which will be used for session update.
See RFC 4028 for more details.
Possible values:
1 - Invite
2 - Update
3 - Update fallback Invite

transport_protocol_id

integer

No

No

The transport layer that will be responsible for the actual transmission of SIP requests and responses:
1 - UDP
2 - TCP
3 - TLS.

max_transfers

integer

No

No

Max count of the REFER requests.

max_30x_redirects

integer

No

No

Max count of 301/302 redirects.

media_encryption_mode

string

No

No

Media encryption mode.
See RFC4568 about SRTP SDES, RFC5764 about SRTP DTLS, and RFC6189 about ZRTP for more details.
Possible values:
‘disabled’ - Disabled
‘srtp_sdes’ - SRTP SDES
‘srtp_dtls’ - SRTP DTLS
‘zrtp’ - ZRTP

stir_shaken_mode

string

No

No

Stir/Shaken mode.
See STIR/SHAKEN for more details.
Possible Values:
‘disabled’ - Do not send identity
‘original’ - Transit Identity header as is
‘pai’ - Add PAI, P-Attestation-Indicator, P-Origination-ID
‘original_pai’ - Transit Identity Header as is + Add PAI, P-Attestation Indicator, P-Origination-ID
‘verstat’ - Add P-Stir-Verstat, P-Attestation-Indicator, P-Origination-ID

allowed_rtp_ips

Array of strings

No

No

The allowed RTP IPs. Array from 0 to 10 items: IPv4 or IPv6, single or subnet.

network_protocol_priority

string

No

No

Network protocol priority for SIP routing.
Possible values:
force_ipv4 - Use IPv4 exclusively.
force_ipv6 - Use IPv6 exclusively.
any - Use either IPv4 or IPv6.
prefer_ipv4 - Prefer IPv4 but fall back to IPv6.
prefer_ipv6 - Prefer IPv6 but fall back to IPv4.

enabled_sip_registration

boolean

No

No

Enables SIP registration for the trunk.

use_did_in_ruri

boolean

No

No

Uses the called DID in the R-URI. This attribute works only when enabled_sip_registration is true.

diversion_relay_policy

string

No

No

Controls how Diversion information is relayed.
Possible values:
none - Do not relay the Diversion header.
as_is - Relay the Diversion header as received.
sip - Relay the Diversion header as a SIP URI.
tel - Relay the Diversion header as a TEL URI.

diversion_inject_mode

string

No

No

Controls how Diversion information is injected.
Possible values:
none - Do not add a Diversion header.
did_number - Add a Diversion header using the DID number in E.164 format.

cnam_lookup

boolean

No

No

Enables inbound CNAM lookup.

Examples#

http

 1PATCH /v3/voice_in_trunks/57a939dd-1600-41a6-80b1-f624e22a1f4c HTTP/1.1
 2Host: api.didww.com
 3Content-Type: application/vnd.api+json
 4Accept: application/vnd.api+json
 5Api-Key: [API token]
 6
 7{
 8  "data": {
 9    "id": "57a939dd-1600-41a6-80b1-f624e22a1f4c",
10    "type": "voice_in_trunks",
11    "attributes": {
12      "configuration": {
13        "type": "sip_configurations",
14        "attributes": {
15          "username": "new_username",
16          "host": "example.com",
17          "port": 5060,
18          "codec_ids": [
19            9,
20            7
21          ],
22          "rx_dtmf_format_id": 1,
23          "tx_dtmf_format_id": 1,
24          "resolve_ruri": true,
25          "auth_enabled": true,
26          "auth_user": "username",
27          "auth_password": "password",
28          "auth_from_user": "Office",
29          "auth_from_domain": "example.com",
30          "sst_enabled": false,
31          "sst_min_timer": 600,
32          "sst_max_timer": 900,
33          "sst_accept_501": true,
34          "sip_timer_b": 8000,
35          "dns_srv_failover_timer": 2000,
36          "rtp_ping": false,
37          "rtp_timeout": 30,
38          "force_symmetric_rtp": false,
39          "symmetric_rtp_ignore_rtcp": false,
40          "rerouting_disconnect_code_ids": [
41            58,
42            59
43          ],
44          "sst_session_expires": null,
45          "sst_refresh_method_id": 1,
46          "transport_protocol_id": 2,
47          "max_transfers": 0,
48          "max_30x_redirects": 0,
49          "media_encryption_mode": "disabled",
50          "stir_shaken_mode": "disabled",
51          "allowed_rtp_ips": null,
52          "network_protocol_priority": "prefer_ipv6",
53          "enabled_sip_registration": true,
54          "use_did_in_ruri": true,
55          "diversion_relay_policy": "tel",
56          "diversion_inject_mode": "did_number",
57          "cnam_lookup": true
58        }
59      }
60    }
61  }
62}

curl

1curl -i -X PATCH https://api.didww.com/v3/voice_in_trunks/57a939dd-1600-41a6-80b1-f624e22a1f4c -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --data-raw '{"data": {"attributes": {"configuration": {"attributes": {"allowed_rtp_ips": null, "auth_enabled": true, "auth_from_domain": "example.com", "auth_from_user": "Office", "auth_password": "password", "auth_user": "username", "cnam_lookup": true, "codec_ids": [9, 7], "diversion_inject_mode": "did_number", "diversion_relay_policy": "tel", "dns_srv_failover_timer": 2000, "enabled_sip_registration": true, "force_symmetric_rtp": false, "host": "example.com", "max_30x_redirects": 0, "max_transfers": 0, "media_encryption_mode": "disabled", "network_protocol_priority": "prefer_ipv6", "port": 5060, "rerouting_disconnect_code_ids": [58, 59], "resolve_ruri": true, "rtp_ping": false, "rtp_timeout": 30, "rx_dtmf_format_id": 1, "sip_timer_b": 8000, "sst_accept_501": true, "sst_enabled": false, "sst_max_timer": 900, "sst_min_timer": 600, "sst_refresh_method_id": 1, "sst_session_expires": null, "stir_shaken_mode": "disabled", "symmetric_rtp_ignore_rtcp": false, "transport_protocol_id": 2, "tx_dtmf_format_id": 1, "use_did_in_ruri": true, "username": "new_username"}, "type": "sip_configurations"}}, "id": "57a939dd-1600-41a6-80b1-f624e22a1f4c", "type": "voice_in_trunks"}}'

response

 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5  "data": {
 6    "id": "57a939dd-1600-41a6-80b1-f624e22a1f4c",
 7    "type": "voice_in_trunks",
 8    "attributes": {
 9      "priority": 1,
10      "capacity_limit": 10,
11      "weight": 2,
12      "name": "Office",
13      "cli_format": "e164",
14      "cli_prefix": "+",
15      "description": "custom description",
16      "ringing_timeout": 30,
17      "created_at": "2017-06-25T08:21:41.795Z",
18      "external_reference_id": null,
19      "configuration": {
20        "type": "sip_configurations",
21        "attributes": {
22          "username": "new_username",
23          "host": "example.com",
24          "port": 5060,
25          "codec_ids": [
26            9,
27            7
28          ],
29          "rx_dtmf_format_id": 1,
30          "tx_dtmf_format_id": 1,
31          "resolve_ruri": true,
32          "auth_enabled": true,
33          "auth_user": "username",
34          "auth_password": "password",
35          "auth_from_user": "Office",
36          "auth_from_domain": "example.com",
37          "sst_enabled": false,
38          "sst_min_timer": 600,
39          "sst_max_timer": 900,
40          "sst_accept_501": true,
41          "sip_timer_b": 8000,
42          "dns_srv_failover_timer": 2000,
43          "rtp_ping": false,
44          "rtp_timeout": 30,
45          "force_symmetric_rtp": false,
46          "symmetric_rtp_ignore_rtcp": false,
47          "rerouting_disconnect_code_ids": [
48            58,
49            59
50          ],
51          "sst_session_expires": null,
52          "sst_refresh_method_id": 1,
53          "transport_protocol_id": 2,
54          "max_transfers": 0,
55          "max_30x_redirects": 0,
56          "media_encryption_mode": "disabled",
57          "stir_shaken_mode": "disabled",
58          "allowed_rtp_ips": null,
59          "network_protocol_priority": "prefer_ipv6",
60          "enabled_sip_registration": true,
61          "use_did_in_ruri": true,
62          "diversion_relay_policy": "tel",
63          "diversion_inject_mode": "did_number",
64          "cnam_lookup": true
65        }
66      }
67    },
68    "relationships": {
69      "voice_in_trunk_group": {
70        "links": {
71          "self": "https://api.didww.com/v3/voice_in_trunks/57a939dd-1600-41a6-80b1-f624e22a1f4c/relationships/voice_in_trunk_group",
72          "related": "https://api.didww.com/v3/voice_in_trunks/57a939dd-1600-41a6-80b1-f624e22a1f4c/voice_in_trunk_group"
73        }
74      },
75      "pop": {
76        "links": {
77          "self": "https://api.didww.com/v3/voice_in_trunks/57a939dd-1600-41a6-80b1-f624e22a1f4c/relationships/pop",
78          "related": "https://api.didww.com/v3/voice_in_trunks/57a939dd-1600-41a6-80b1-f624e22a1f4c/pop"
79        }
80      }
81    }
82  }
83}

Other Responses#

Code

Success

Description

404

No

Not Found

401

No

Unauthorized