Outbound Trunk Object#

JSON:API object with type voice_out_trunks.

Authentication data is returned only inside data.attributes.authentication_method.

Request#

URI Parameters#

Name

Type

Is Required?

Description

id

string

Yes

Unique identifier of the outbound trunk.

Data Attributes#

Name

Type

Description

name

string

The outbound trunk name.

external_reference_id

string

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

allowed_rtp_ips

Array of strings

Allowed RTP IP addresses for media traffic.

on_cli_mismatch_action

string

The action applied when the CLI does not match the allowed DID list. Possible values: send_original_cli - pass the original From header value from your system to the destination without modification. reject_call - reject the call if the From header value does not match any DID allowed on the trunk. replace_cli - replace the CLI with one of the DIDs allowed on the trunk. randomize_cli - replace the CLI with a random DID allowed on the trunk.

capacity_limit

integer

The capacity limit of the outbound trunk.

allow_any_did_as_cli

boolean

When set to true, any eligible DID can be used as CLI for the trunk.

status

string

The status of the outbound trunk. Possible values: active - the trunk can be used for outbound traffic. blocked - outbound traffic on the trunk is blocked.

threshold_reached

boolean

Indicates whether the 24-hour threshold amount has been reached.

threshold_amount

string

The 24-hour threshold limit.

default_dst_action

string

The default destination action. Possible values: allow_all - allow calls to all destinations except the prefixes listed in dst_prefixes. reject_all - reject calls to all destinations except the prefixes listed in dst_prefixes.

dst_prefixes

Array of strings

The destination prefixes allowed or rejected based on default_dst_action. Each prefix is digits only, without a leading + or separators. Repeated prefixes are stored once.

emergency_enable_all

boolean

When set to true, all eligible DIDs of the account can be used for emergency calling on this trunk.

media_encryption_mode

string

Media encryption mode. Possible values: disabled - media encryption is turned off. srtp_sdes - use SRTP encryption with SDES key exchange. srtp_dtls - use SRTP encryption with DTLS key exchange. zrtp - use SRTP encryption with ZRTP key exchange.

ice_mode

string

ICE (Interactive Connectivity Establishment) for calls from the trunk: not used, accepted when the trunk offers it, or initiated by DIDWW. Possible values: disabled, accept, initiate. Defaults to accept.

rtcp_mux_mode

string

RTP and RTCP multiplexed on one port: not used, accepted when the trunk offers it, or initiated by DIDWW. Possible values: disabled, accept, initiate. Defaults to accept.

rtcp_feedback_mode

string

RTCP feedback (AVPF): not used, accepted when the trunk offers it, or initiated by DIDWW. Possible values: disabled, accept, initiate. Defaults to accept. With disabled, a call whose SDP offer uses a feedback profile (RTP/AVPF or UDP/TLS/RTP/SAVPF) is rejected with SIP 500 No suitable media. WebRTC clients always offer such a profile, so use accept or initiate for them.

codecs

Array of strings

Codecs offered on calls from the trunk, in priority order: the first has the highest priority. Holds at least one value, without repeats. Possible values: telephone_event, g723, g729, pcmu, pcma, gsm, g722, opus, amr, amr_wb. Defaults to pcma, pcmu, telephone_event.

callback_url

string

The callback URI. Can be null or a valid HTTP(S) URL.

force_symmetric_rtp

boolean

Enables symmetric RTP / COMEDIA mode.

rtp_ping

boolean

When enabled, DIDWW sends an empty RTP packet after call establishment.

rtp_timeout

integer

Disconnects the call if RTP packets do not arrive within the specified time. Supported values are from 30 to 600 seconds.

created_at

date&time

The date and time when the outbound trunk was created.

authentication_method

object

Authentication method object. See Authentication Method.

Authentication Method#

The outbound trunk authentication is returned in the authentication_method attribute.

Supported authentication method types:

  • credentials_and_ip - uses SIP credentials together with allowed IP addresses.

  • ip_only - uses allowed IP addresses only.

  • twilio - uses a Twilio Account SID for authentication.

Authentication Method Attributes by Type#

The following attributes are part of the authentication_method object:

Name

Type

Description

allowed_sip_ips

Array of strings

The allowed originating SIP IPs.

tech_prefix

string

Prefix stripped from the dialled number before routing. The maximum length is 8 characters and only digits and # are supported.

username

string

The digest authentication username.

password

string

The digest authentication password.

Object Relationships#

Name

Type

Description

dids

to-many

DID Object

emergency_dids

to-many

DIDs assigned for emergency calling on the outbound trunk.

Object Meta#

Name

Type

Description

spent_amount

string

Amount spent on this trunk over the last 24 hours, as a decimal string.