Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 3.41 KB

CredentialConnection.md

File metadata and controls

53 lines (37 loc) · 3.41 KB
Raw

CredentialConnection

Properties

Name Type Description Notes
id String Identifies the type of resource. [optional]
recordType String Identifies the type of the resource. [optional]
active Boolean Defaults to true [optional]
userName String The user name to be used as part of the credentials. Must be 4-32 characters long and alphanumeric values only (no spaces or special characters). [optional]
password String The password to be used as part of the credentials. Must be 8 to 128 characters long. [optional]
createdAt String ISO-8601 formatted date indicating when the resource was created. [optional]
updatedAt String ISO-8601 formatted date indicating when the resource was updated. [optional]
anchorsiteOverride AnchorsiteOverride [optional]
connectionName String [optional]
sipUriCallingPreference SipUriCallingPreferenceEnum This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI <your-username>@telnyx.com will be connected to your Connection. You can also choose to allow only calls that are originated on any Connections under your account (internal). [optional]
defaultOnHoldComfortNoiseEnabled Boolean When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout. [optional]
dtmfType DtmfType [optional]
encodeContactHeaderEnabled Boolean Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios. [optional]
encryptedMedia EncryptedMedia [optional]
onnetT38PassthroughEnabled Boolean Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings. [optional]
webhookEventUrl String The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. [optional]
webhookEventFailoverUrl String The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. [optional]
webhookApiVersion WebhookApiVersionEnum Determines which webhook format will be used, Telnyx API v1 or v2. [optional]
webhookTimeoutSecs Integer Specifies how many seconds to wait before timing out a webhook. [optional]
rtcpSettings ConnectionRtcpSettings [optional]
inbound CredentialInbound [optional]
outbound CredentialOutbound [optional]

Enum: SipUriCallingPreferenceEnum

Name Value
DISABLED "disabled"
UNRESTRICTED "unrestricted"
INTERNAL "internal"

Enum: WebhookApiVersionEnum

Name Value
_1 "1"
_2 "2"