Inbound Trunk Object#
Json API object with type voice_in_trunks. You can get several type of inbound trunks: SIP, PSTN.
Request#
URI Parameters#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
id |
|
Yes |
Unique ID identifier of the Trunk. |
Data Attributes#
Name |
Type |
Description |
|---|---|---|
priority |
|
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 |
|
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 |
|
Maximum number of simultaneous calls for the trunk. |
ringing_timeout |
|
Ring time in seconds. Supported values are integers from 1 to 32. Null uses the platform default. If the call is not connected within this time, the transaction is ended with the disconnect code Ringing timeout. |
name |
|
Friendly name of the trunk. Unique among the trunks and trunk groups of the account — they share one name space. |
external_reference_id |
|
Optional identifier for the inbound trunk in the customer’s external system. Maximum length is 100 characters. |
cli_format |
|
raw - Do not alter CLI. e164 - Attempt to convert CLI to E.164 format (default). 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 |
|
You may prefix the CLI with an optional |
description |
|
Optional description of the trunk. |
pop |
|
Point of Presence the trunk is pinned to. Possible values: |
configuration |
Trunk configuration complex object. |
|
created_at |
DateTime |
Trunk created at DateTime |
Object Relationships#
Name |
Type |
Description |
|---|---|---|
voice_in_trunk_group |
to-one |
Attributes Configuration#
Name |
Type |
Nullable |
Description |
|---|---|---|---|
type |
|
No |
SIP configuration complex object. |
attributes |
No |
SIP configuration attributes object. |
Name |
Type |
Nullable |
Description |
|---|---|---|---|
type |
|
No |
PSTN configuration complex object. |
attributes |
No |
PSTN configuration attributes object. |
Configuration Attributes#
Name |
Type |
Nullable |
Description |
|---|---|---|---|
username |
|
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 |
|
Yes |
Host part of R-URI in INVITE request. Required while |
port |
|
Yes |
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). Must be empty while |
codecs |
Array of |
No |
Codecs offered on calls to the trunk, in priority order: the first has the highest priority. Holds at least one value, without repeats. Possible values: |
rx_dtmf_format_id |
|
No |
The method id for receiving DTMF signals from customers equipment. Possible values: |
tx_dtmf_format_id |
|
No |
The method of sending DTMF signals to the customer’s equipment. Possible values: |
resolve_ruri |
|
No |
Replace host part of the R-URI by resolved IP address. |
auth_enabled |
|
No |
Enable authorization for the SIP server. |
auth_user |
|
Yes |
Authorization user for the SIP server. Required while |
auth_password |
|
Yes |
Authorization password for the SIP server. Required while |
auth_from_user |
|
Yes |
Specify user in a from field instead of CallerID (overrides CallerID). Some equipment require from; to be equivalent to Auth user. |
auth_from_domain |
|
Yes |
Sets default from domain in SIP messages. Some equipment may require specific From Domain. |
sst_enabled |
|
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 |
|
Yes |
Minimal SIP Session timer value (Default 600 seconds). See RFC 4028 for more details. |
sst_max_timer |
|
Yes |
Maximal SIP Session timer value (Default 900 seconds). See RFC 4028 for more details. |
sst_accept_501 |
|
No |
Do not drop the call after receiving SIP 501 response for non-critical messages. |
sip_timer_b |
|
No |
INVITE transaction timeout (Default 8000ms). See RFC 3261 Section 17.1.1.2 for more details. |
dns_srv_failover_timer |
|
Yes |
Invite transaction timeout for each of gateways with DNS SRV rerouting (Default 2000ms). |
rtp_ping |
|
Yes |
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 |
|
No |
Disconnect the call if the RTP packets do not arrive within the specified time. |
force_symmetric_rtp |
|
Yes |
Forced to work in Symmetric RTP / COMEDIA mode. |
symmetric_rtp_ignore_rtcp |
|
Yes |
Avoid switching RTP session based on RTCP packet while working in Symmetric RTP / COMEDIA. Only RTP packets will be considered. |
rerouting_disconnect_code_ids |
|
Yes |
|
sst_session_expires |
|
Yes |
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 |
|
No |
SIP method which will be used for session update. See RFC 4028 for more details. Possible values: |
transport_protocol_id |
|
No |
Transport protocol ID. Possible values: |
max_transfers |
|
No |
Max count of the REFER requests. |
max_30x_redirects |
|
No |
Max count of 301/302 redirects. |
media_encryption_mode |
|
No |
Media encryption mode. See RFC4568 about SRTP SDES, RFC5764 about SRTP DTLS, and RFC6189 about ZRTP for more details. Possible values: |
ice_mode |
|
No |
ICE (Interactive Connectivity Establishment) for calls to the trunk: not used, accepted when the trunk offers it, or initiated by DIDWW. Possible values: |
rtcp_mux_mode |
|
No |
RTP and RTCP multiplexed on one port: not used, accepted when the trunk offers it, or initiated by DIDWW. Possible values: |
rtcp_feedback_mode |
|
No |
RTCP feedback (AVPF): not used, accepted when the trunk offers it, or initiated by DIDWW. Possible values: |
stir_shaken_mode |
|
No |
Stir/Shaken mode. See STIR/SHAKEN for more details. Possible values: |
allowed_rtp_ips |
Array of |
Yes |
The allowed RTP IPs: IPv4 or IPv6, single or subnet. Up to 10 items. Null means no restriction. |
network_protocol_priority |
|
No |
Network protocol priority for SIP routing. Possible values: |
enabled_sip_registration |
|
No |
Enables SIP registration for the trunk. Enabling it generates |
use_did_in_ruri |
|
No |
Uses the called DID in the R-URI. Can be |
incoming_auth_username |
|
Yes |
Generated SIP registration username. Read-only: sending it is rejected. |
incoming_auth_password |
|
Yes |
Generated SIP registration password. Read-only: sending it is rejected. |
diversion_relay_policy |
|
No |
Controls how Diversion information is relayed. Possible values: |
diversion_inject_mode |
|
No |
Controls how Diversion information is injected. Possible values: |
cnam_lookup |
|
No |
Enables inbound CNAM lookup. |
Name |
Type |
Nullable |
Description |
|---|---|---|---|
dst |
|
No |
Number calls are forwarded to, in E.164 without the leading |