Skip to content

Latest commit

 

History

History
81 lines (53 loc) · 5 KB

InboundIp.md

File metadata and controls

81 lines (53 loc) · 5 KB

InboundIp

Properties

Name Type Description Notes
aniNumberFormat AniNumberFormatEnum This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls. [optional]
dnisNumberFormat DnisNumberFormatEnum [optional]
codecs List<String> Defines the list of codecs that Telnyx will send for inbound calls to a specific number on your portal account, in priority order. This only works when the Connection the number is assigned to uses Media Handling mode: default. OPUS and H.264 codecs are available only when using TCP or TLS transport for SIP. [optional]
defaultPrimaryIpId String The default primary IP to use for the number. Only settable if the connection is of IP authentication type. Value must be the ID of an authorized IP set on the connection. [optional]
defaultSecondaryIpId String The default secondary IP to use for the number. Only settable if the connection is of IP authentication type. Value must be the ID of an authorized IP set on the connection. [optional]
defaultTertiaryIpId String The default tertiary IP to use for the number. Only settable if the connection is of IP authentication type. Value must be the ID of an authorized IP set on the connection. [optional]
defaultRoutingMethod DefaultRoutingMethodEnum Default routing method to be used when a number is associated with the connection. Must be one of the routing method types or left blank, other values are not allowed. [optional]
channelLimit Integer When set, this will limit the total number of inbound calls to phone numbers associated with this connection. [optional]
generateRingbackTone Boolean Generate ringback tone through 183 session progress message with early media. [optional]
isupHeadersEnabled Boolean When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.) [optional]
prackEnabled Boolean Enable PRACK messages as defined in RFC3262. [optional]
privacyZoneEnabled Boolean By default, Telnyx does not send caller-id information when the caller has chosen to hide this information. When this option is enabled, Telnyx will send the SIP header Privacy:id plus the caller-id information so that the receiver side can choose when to hide it. [optional]
sipCompactHeadersEnabled Boolean Defaults to true. [optional]
sipRegion SipRegionEnum Selects which `sip_region` to receive inbound calls from. If null, the default region (US) will be used. [optional]
sipSubdomain String Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain &quot;example.sip.telnyx.com&quot; can be called from any SIP endpoint by using the SIP URI &quot;sip:@example.sip.telnyx.com&quot; where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls. [optional]
sipSubdomainReceiveSettings SipSubdomainReceiveSettingsEnum This option can be enabled to receive calls from: &quot;Anyone&quot; (any SIP endpoint in the public Internet) or &quot;Only my connections&quot; (any connection assigned to the same Telnyx user). [optional]
timeout1xxSecs Integer Time(sec) before aborting if connection is not made. [optional]
timeout2xxSecs Integer Time(sec) before aborting if call is unanswered (min: 1, max: 600). [optional]
shakenStirEnabled Boolean When enabled the SIP Connection will receive the Identity header with Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP transport. [optional]

Enum: AniNumberFormatEnum

Name Value
_E_164 "+E.164"
E_164 "E.164"
_E_164_NATIONAL "+E.164-national"
E_164_NATIONAL "E.164-national"

Enum: DnisNumberFormatEnum

Name Value
_E164 "+e164"
E164 "e164"
NATIONAL "national"
SIP_USERNAME "sip_username"

Enum: DefaultRoutingMethodEnum

Name Value
SEQUENTIAL "sequential"
ROUND_ROBIN "round-robin"

Enum: SipRegionEnum

Name Value
US "US"
EUROPE "Europe"
AUSTRALIA "Australia"

Enum: SipSubdomainReceiveSettingsEnum

Name Value
ONLY_MY_CONNECTIONS "only_my_connections"
FROM_ANYONE "from_anyone"