Credential Connections API

Credential connection operations API

List credential connections

Returns a list of your credential connections.

SecuritybearerAuth
Request
query Parameters
page[number]
integer >= 1
Default: 1

The page number to load

page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

filter[connection_name][contains]
string
Default: null

If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.

filter[outbound.outbound_voice_profile_id]
string <int64>

Identifies the associated outbound voice profile.

Example: filter[outbound.outbound_voice_profile_id]=1293384261075731499
sort
string
Default: "created_at"

Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

That is:

  • connection_name: sorts the result by the connection_name field in ascending order.

  • -connection_name: sorts the result by the connection_name field in descending order.

If not given, results are sorted by created_at in descending order.
Enum: "created_at" "connection_name" "active"
Example: sort=connection_name
Responses
200

Successful response with a list of credential connections.

Response Schema: application/json
Array of objects (Credential Connection)
object (PaginationMeta)
400

Bad request

401

Unauthorized

404

Resource not found

get/credential_connections
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.Comment.list(filter={"comment_record_type":"sub_number_order","comment_record_id":"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"})
Response samples
application/json
{
  • "data": [
    • {
      • "active": true,
      • "anchorsite_override": "Latency",
      • "connection_name": "string",
      • "created_at": "2018-02-02T22:25:27.521Z",
      • "default_on_hold_comfort_noise_enabled": true,
      • "dtmf_type": "RFC 2833",
      • "encode_contact_header_enabled": true,
      • "encrypted_media": "SRTP",
      • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      • "inbound": {
        • "ani_number_format": "+E.164",
        • "channel_limit": 10,
        • "codecs": [
          • "G722"
          ],
        • "dnis_number_format": "+e164",
        • "generate_ringback_tone": true,
        • "isup_headers_enabled": true,
        • "prack_enabled": true,
        • "privacy_zone_enabled": true,
        • "sip_compact_headers_enabled": true,
        • "timeout_1xx_secs": 10,
        • "timeout_2xx_secs": "15"
        },
      • "onnet_t38_passthrough_enabled": true,
      • "outbound": {
        • "ani_override": "string",
        • "ani_override_type": "always",
        • "call_parking_enabled": true,
        • "channel_limit": 10,
        • "generate_ringback_tone": true,
        • "instant_ringback_enabled": true,
        • "localization": "string",
        • "outbound_voice_profile_id": "1293384261075731499",
        • "t38_reinvite_source": "telnyx"
        },
      • "password": "my123secure456password789",
      • "record_type": "credential_connection",
      • "rtcp_settings": {
        • "capture_enabled": true,
        • "port": "rtp+1",
        • "report_frequency_seconds": 10
        },
      • "sip_uri_calling_preference": "disabled",
      • "updated_at": "2018-02-02T22:25:27.521Z",
      • "user_name": "myusername123",
      • "webhook_api_version": "1",
      • "webhook_event_failover_url": "https://failover.example.com",
      • "webhook_event_url": "https://example.com",
      • "webhook_timeout_secs": 25
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}

Create a credential connection

Creates a credential connection.

SecuritybearerAuth
Request
Request Body schema: application/json
required

Parameters that can be defined during credential connection creation

active
boolean

Defaults to true

anchorsite_override
string (AnchorsiteOverride)

Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

Enum: "Latency" "Chicago, IL" "Ashburn, VA" "San Jose, CA" "Sydney, Australia" "Amsterdam, Netherlands" "London, UK" "Toronto, Canada" "Vancouver, Canada" "Frankfurt, Germany"
connection_name
required
string
default_on_hold_comfort_noise_enabled
boolean
Default: false

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.

dtmf_type
string (DtmfType)

Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.

Enum: "RFC 2833" "Inband" "SIP INFO"
encode_contact_header_enabled
boolean
Default: false

Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.

encrypted_media
string (EncryptedMedia)

Enable use of SRTP or ZRTP for encryption. Valid values are those listed or null. Cannot be set to non-null if the transport_portocol is TLS.

Enum: "SRTP" "ZRTP"
object (CredentialInbound)
onnet_t38_passthrough_enabled
boolean
Default: false

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.

object (CredentialOutbound)
password
required
string

The password to be used as part of the credentials. Must be 8 to 128 characters long.

object (ConnectionRtcpSettings)
sip_uri_calling_preference
string
Default: "disabled"

This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI @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).

Enum: "disabled" "unrestricted" "internal"
user_name
required
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).

webhook_api_version
string
Default: "1"

Determines which webhook format will be used, Telnyx API v1 or v2.

Enum: "1" "2"
webhook_event_failover_url
string <url>
Default: ""

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'.

webhook_event_url
string <url>

The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

webhook_timeout_secs
integer [ 0 .. 30 ]
Default: null

Specifies how many seconds to wait before timing out a webhook.

Responses
201

Successful response with details about a credential connection.

Response Schema: application/json
object (CredentialConnection)
active
boolean

Defaults to true

anchorsite_override
string (AnchorsiteOverride)

Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

Enum: "Latency" "Chicago, IL" "Ashburn, VA" "San Jose, CA" "Sydney, Australia" "Amsterdam, Netherlands" "London, UK" "Toronto, Canada" "Vancouver, Canada" "Frankfurt, Germany"
connection_name
string
created_at
string

ISO-8601 formatted date indicating when the resource was created.

default_on_hold_comfort_noise_enabled
boolean
Default: true

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.

dtmf_type
string (DtmfType)

Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.

Enum: "RFC 2833" "Inband" "SIP INFO"
encode_contact_header_enabled
boolean
Default: false

Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.

encrypted_media
string (EncryptedMedia)

Enable use of SRTP or ZRTP for encryption. Valid values are those listed or null. Cannot be set to non-null if the transport_portocol is TLS.

Enum: "SRTP" "ZRTP"
id
string <int64>

Identifies the type of resource.

object (CredentialInbound)
onnet_t38_passthrough_enabled
boolean
Default: false

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.

object (CredentialOutbound)
password
string

The password to be used as part of the credentials. Must be 8 to 128 characters long.

record_type
string

Identifies the type of the resource.

object (ConnectionRtcpSettings)
sip_uri_calling_preference
string
Default: null

This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI @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).

Enum: "disabled" "unrestricted" "internal"
updated_at
string

ISO-8601 formatted date indicating when the resource was updated.

user_name
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).

webhook_api_version
string
Default: "1"

Determines which webhook format will be used, Telnyx API v1 or v2.

Enum: "1" "2"
webhook_event_failover_url
string <url>
Default: ""

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'.

webhook_event_url
string <url>

The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

webhook_timeout_secs
integer [ 0 .. 30 ]
Default: null

Specifies how many seconds to wait before timing out a webhook.

422

Bad request

post/credential_connections
Request samples
application/json
{
  • "active": true,
  • "anchorsite_override": "Latency",
  • "connection_name": "my name",
  • "default_on_hold_comfort_noise_enabled": false,
  • "dtmf_type": "RFC 2833",
  • "encode_contact_header_enabled": true,
  • "encrypted_media": "SRTP",
  • "inbound": {
    • "ani_number_format": "+E.164",
    • "channel_limit": 10,
    • "codecs": "G722",
    • "default_routing_method": "sequential",
    • "dnis_number_format": "+e164",
    • "generate_ringback_tone": true,
    • "isup_headers_enabled": true,
    • "prack_enabled": true,
    • "privacy_zone_enabled": true,
    • "sip_compact_headers_enabled": true,
    • "timeout_1xx_secs": 10,
    • "timeout_2xx_secs": 20
    },
  • "onnet_t38_passthrough_enabled": true,
  • "outbound": {
    • "ani_override": "always",
    • "call_parking_enabled": true,
    • "channel_limit": 10,
    • "generate_ringback_tone": true,
    • "instant_ringback_enabled": true,
    • "localization": "US",
    • "outbound_voice_profile_id": "1293384261075731499",
    • "t38_reinvite_source": "telnyx"
    },
  • "password": "my123secure456password789",
  • "rtcp_settings": {
    • "capture_enabled": true,
    • "port": "rtcp-mux",
    • "report_frequency_seconds": 10
    },
  • "sip_uri_calling_preference": " disabled",
  • "user_name": "myusername123",
  • "webhook_api_version": "1",
  • "webhook_event_failover_url": "https://failover.example.com",
  • "webhook_event_url": "https://example.com",
  • "webhook_timeout_secs": 25
}
Response samples
application/json
{
  • "data": {
    • "active": true,
    • "anchorsite_override": "Latency",
    • "connection_name": "string",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "default_on_hold_comfort_noise_enabled": true,
    • "dtmf_type": "RFC 2833",
    • "encode_contact_header_enabled": true,
    • "encrypted_media": "SRTP",
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "inbound": {
      • "ani_number_format": "+E.164",
      • "channel_limit": 10,
      • "codecs": [
        • "G722"
        ],
      • "dnis_number_format": "+e164",
      • "generate_ringback_tone": true,
      • "isup_headers_enabled": true,
      • "prack_enabled": true,
      • "privacy_zone_enabled": true,
      • "sip_compact_headers_enabled": true,
      • "timeout_1xx_secs": 10,
      • "timeout_2xx_secs": "15"
      },
    • "onnet_t38_passthrough_enabled": true,
    • "outbound": {
      • "ani_override": "string",
      • "ani_override_type": "always",
      • "call_parking_enabled": true,
      • "channel_limit": 10,
      • "generate_ringback_tone": true,
      • "instant_ringback_enabled": true,
      • "localization": "string",
      • "outbound_voice_profile_id": "1293384261075731499",
      • "t38_reinvite_source": "telnyx"
      },
    • "password": "my123secure456password789",
    • "record_type": "credential_connection",
    • "rtcp_settings": {
      • "capture_enabled": true,
      • "port": "rtp+1",
      • "report_frequency_seconds": 10
      },
    • "sip_uri_calling_preference": "disabled",
    • "updated_at": "2018-02-02T22:25:27.521Z",
    • "user_name": "myusername123",
    • "webhook_api_version": "1",
    • "webhook_event_failover_url": "https://failover.example.com",
    • "webhook_event_url": "https://example.com",
    • "webhook_timeout_secs": 25
    }
}

Delete a credential connection

Deletes an existing credential connection.

SecuritybearerAuth
Request
path Parameters
id
required
string

Identifies the resource.

Responses
200

Successful response with details about a credential connection.

Response Schema: application/json
object (CredentialConnection)
active
boolean

Defaults to true

anchorsite_override
string (AnchorsiteOverride)

Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

Enum: "Latency" "Chicago, IL" "Ashburn, VA" "San Jose, CA" "Sydney, Australia" "Amsterdam, Netherlands" "London, UK" "Toronto, Canada" "Vancouver, Canada" "Frankfurt, Germany"
connection_name
string
created_at
string

ISO-8601 formatted date indicating when the resource was created.

default_on_hold_comfort_noise_enabled
boolean
Default: true

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.

dtmf_type
string (DtmfType)

Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.

Enum: "RFC 2833" "Inband" "SIP INFO"
encode_contact_header_enabled
boolean
Default: false

Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.

encrypted_media
string (EncryptedMedia)

Enable use of SRTP or ZRTP for encryption. Valid values are those listed or null. Cannot be set to non-null if the transport_portocol is TLS.

Enum: "SRTP" "ZRTP"
id
string <int64>

Identifies the type of resource.

object (CredentialInbound)
onnet_t38_passthrough_enabled
boolean
Default: false

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.

object (CredentialOutbound)
password
string

The password to be used as part of the credentials. Must be 8 to 128 characters long.

record_type
string

Identifies the type of the resource.

object (ConnectionRtcpSettings)
sip_uri_calling_preference
string
Default: null

This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI @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).

Enum: "disabled" "unrestricted" "internal"
updated_at
string

ISO-8601 formatted date indicating when the resource was updated.

user_name
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).

webhook_api_version
string
Default: "1"

Determines which webhook format will be used, Telnyx API v1 or v2.

Enum: "1" "2"
webhook_event_failover_url
string <url>
Default: ""

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'.

webhook_event_url
string <url>

The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

webhook_timeout_secs
integer [ 0 .. 30 ]
Default: null

Specifies how many seconds to wait before timing out a webhook.

401

Unauthorized

404

Resource not found

422

Bad request

delete/credential_connections/{id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

res = telnyx.CredentialConnection.retrieve('id')
res.delete()
Response samples
application/json
{
  • "data": {
    • "active": true,
    • "anchorsite_override": "Latency",
    • "connection_name": "string",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "default_on_hold_comfort_noise_enabled": true,
    • "dtmf_type": "RFC 2833",
    • "encode_contact_header_enabled": true,
    • "encrypted_media": "SRTP",
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "inbound": {
      • "ani_number_format": "+E.164",
      • "channel_limit": 10,
      • "codecs": [
        • "G722"
        ],
      • "dnis_number_format": "+e164",
      • "generate_ringback_tone": true,
      • "isup_headers_enabled": true,
      • "prack_enabled": true,
      • "privacy_zone_enabled": true,
      • "sip_compact_headers_enabled": true,
      • "timeout_1xx_secs": 10,
      • "timeout_2xx_secs": "15"
      },
    • "onnet_t38_passthrough_enabled": true,
    • "outbound": {
      • "ani_override": "string",
      • "ani_override_type": "always",
      • "call_parking_enabled": true,
      • "channel_limit": 10,
      • "generate_ringback_tone": true,
      • "instant_ringback_enabled": true,
      • "localization": "string",
      • "outbound_voice_profile_id": "1293384261075731499",
      • "t38_reinvite_source": "telnyx"
      },
    • "password": "my123secure456password789",
    • "record_type": "credential_connection",
    • "rtcp_settings": {
      • "capture_enabled": true,
      • "port": "rtp+1",
      • "report_frequency_seconds": 10
      },
    • "sip_uri_calling_preference": "disabled",
    • "updated_at": "2018-02-02T22:25:27.521Z",
    • "user_name": "myusername123",
    • "webhook_api_version": "1",
    • "webhook_event_failover_url": "https://failover.example.com",
    • "webhook_event_url": "https://example.com",
    • "webhook_timeout_secs": 25
    }
}

Retrieve a credential connection

Retrieves the details of an existing credential connection.

SecuritybearerAuth
Request
path Parameters
id
required
string

Identifies the resource.

Responses
200

Successful response with details about a credential connection.

Response Schema: application/json
object (CredentialConnection)
active
boolean

Defaults to true

anchorsite_override
string (AnchorsiteOverride)

Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

Enum: "Latency" "Chicago, IL" "Ashburn, VA" "San Jose, CA" "Sydney, Australia" "Amsterdam, Netherlands" "London, UK" "Toronto, Canada" "Vancouver, Canada" "Frankfurt, Germany"
connection_name
string
created_at
string

ISO-8601 formatted date indicating when the resource was created.

default_on_hold_comfort_noise_enabled
boolean
Default: true

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.

dtmf_type
string (DtmfType)

Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.

Enum: "RFC 2833" "Inband" "SIP INFO"
encode_contact_header_enabled
boolean
Default: false

Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.

encrypted_media
string (EncryptedMedia)

Enable use of SRTP or ZRTP for encryption. Valid values are those listed or null. Cannot be set to non-null if the transport_portocol is TLS.

Enum: "SRTP" "ZRTP"
id
string <int64>

Identifies the type of resource.

object (CredentialInbound)
onnet_t38_passthrough_enabled
boolean
Default: false

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.

object (CredentialOutbound)
password
string

The password to be used as part of the credentials. Must be 8 to 128 characters long.

record_type
string

Identifies the type of the resource.

object (ConnectionRtcpSettings)
sip_uri_calling_preference
string
Default: null

This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI @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).

Enum: "disabled" "unrestricted" "internal"
updated_at
string

ISO-8601 formatted date indicating when the resource was updated.

user_name
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).

webhook_api_version
string
Default: "1"

Determines which webhook format will be used, Telnyx API v1 or v2.

Enum: "1" "2"
webhook_event_failover_url
string <url>
Default: ""

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'.

webhook_event_url
string <url>

The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

webhook_timeout_secs
integer [ 0 .. 30 ]
Default: null

Specifies how many seconds to wait before timing out a webhook.

400

Bad request

401

Unauthorized

404

Resource not found

get/credential_connections/{id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.CredentialConnection.retrieve("id")
Response samples
application/json
{
  • "data": {
    • "active": true,
    • "anchorsite_override": "Latency",
    • "connection_name": "string",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "default_on_hold_comfort_noise_enabled": true,
    • "dtmf_type": "RFC 2833",
    • "encode_contact_header_enabled": true,
    • "encrypted_media": "SRTP",
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "inbound": {
      • "ani_number_format": "+E.164",
      • "channel_limit": 10,
      • "codecs": [
        • "G722"
        ],
      • "dnis_number_format": "+e164",
      • "generate_ringback_tone": true,
      • "isup_headers_enabled": true,
      • "prack_enabled": true,
      • "privacy_zone_enabled": true,
      • "sip_compact_headers_enabled": true,
      • "timeout_1xx_secs": 10,
      • "timeout_2xx_secs": "15"
      },
    • "onnet_t38_passthrough_enabled": true,
    • "outbound": {
      • "ani_override": "string",
      • "ani_override_type": "always",
      • "call_parking_enabled": true,
      • "channel_limit": 10,
      • "generate_ringback_tone": true,
      • "instant_ringback_enabled": true,
      • "localization": "string",
      • "outbound_voice_profile_id": "1293384261075731499",
      • "t38_reinvite_source": "telnyx"
      },
    • "password": "my123secure456password789",
    • "record_type": "credential_connection",
    • "rtcp_settings": {
      • "capture_enabled": true,
      • "port": "rtp+1",
      • "report_frequency_seconds": 10
      },
    • "sip_uri_calling_preference": "disabled",
    • "updated_at": "2018-02-02T22:25:27.521Z",
    • "user_name": "myusername123",
    • "webhook_api_version": "1",
    • "webhook_event_failover_url": "https://failover.example.com",
    • "webhook_event_url": "https://example.com",
    • "webhook_timeout_secs": 25
    }
}

Update a credential connection

Updates settings of an existing credential connection.

SecuritybearerAuth
Request
path Parameters
id
required
string

Identifies the resource.

Request Body schema: application/json
required

Parameters that can be updated in a credential connection

active
boolean

Defaults to true

anchorsite_override
string (AnchorsiteOverride)

Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

Enum: "Latency" "Chicago, IL" "Ashburn, VA" "San Jose, CA" "Sydney, Australia" "Amsterdam, Netherlands" "London, UK" "Toronto, Canada" "Vancouver, Canada" "Frankfurt, Germany"
connection_name
string
default_on_hold_comfort_noise_enabled
boolean
Default: false

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.

dtmf_type
string (DtmfType)

Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.

Enum: "RFC 2833" "Inband" "SIP INFO"
encode_contact_header_enabled
boolean
Default: false

Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.

encrypted_media
string (EncryptedMedia)

Enable use of SRTP or ZRTP for encryption. Valid values are those listed or null. Cannot be set to non-null if the transport_portocol is TLS.

Enum: "SRTP" "ZRTP"
object (CredentialInbound)
onnet_t38_passthrough_enabled
boolean
Default: false

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.

object (CredentialOutbound)
password
string

The password to be used as part of the credentials. Must be 8 to 128 characters long.

object (ConnectionRtcpSettings)
sip_uri_calling_preference
string
Default: "disabled"

This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI @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).

Enum: "disabled" "unrestricted" "internal"
user_name
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).

webhook_api_version
string
Default: "1"

Determines which webhook format will be used, Telnyx API v1 or v2.

Enum: "1" "2"
webhook_event_failover_url
string <url>
Default: ""

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'.

webhook_event_url
string <url>

The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

webhook_timeout_secs
integer [ 0 .. 30 ]
Default: null

Specifies how many seconds to wait before timing out a webhook.

Responses
200

Successful response with details about a credential connection.

Response Schema: application/json
object (CredentialConnection)
active
boolean

Defaults to true

anchorsite_override
string (AnchorsiteOverride)

Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

Enum: "Latency" "Chicago, IL" "Ashburn, VA" "San Jose, CA" "Sydney, Australia" "Amsterdam, Netherlands" "London, UK" "Toronto, Canada" "Vancouver, Canada" "Frankfurt, Germany"
connection_name
string
created_at
string

ISO-8601 formatted date indicating when the resource was created.

default_on_hold_comfort_noise_enabled
boolean
Default: true

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.

dtmf_type
string (DtmfType)

Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.

Enum: "RFC 2833" "Inband" "SIP INFO"
encode_contact_header_enabled
boolean
Default: false

Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.

encrypted_media
string (EncryptedMedia)

Enable use of SRTP or ZRTP for encryption. Valid values are those listed or null. Cannot be set to non-null if the transport_portocol is TLS.

Enum: "SRTP" "ZRTP"
id
string <int64>

Identifies the type of resource.

object (CredentialInbound)
onnet_t38_passthrough_enabled
boolean
Default: false

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.

object (CredentialOutbound)
password
string

The password to be used as part of the credentials. Must be 8 to 128 characters long.

record_type
string

Identifies the type of the resource.

object (ConnectionRtcpSettings)
sip_uri_calling_preference
string
Default: null

This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI @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).

Enum: "disabled" "unrestricted" "internal"
updated_at
string

ISO-8601 formatted date indicating when the resource was updated.

user_name
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).

webhook_api_version
string
Default: "1"

Determines which webhook format will be used, Telnyx API v1 or v2.

Enum: "1" "2"
webhook_event_failover_url
string <url>
Default: ""

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'.

webhook_event_url
string <url>

The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

webhook_timeout_secs
integer [ 0 .. 30 ]
Default: null

Specifies how many seconds to wait before timing out a webhook.

401

Unauthorized

404

Resource not found

422

Bad request

patch/credential_connections/{id}
Request samples
application/json
{
  • "active": true,
  • "anchorsite_override": "Latency",
  • "connection_name": "my name",
  • "default_on_hold_comfort_noise_enabled": false,
  • "dtmf_type": "RFC 2833",
  • "encode_contact_header_enabled": true,
  • "encrypted_media": "SRTP",
  • "inbound": {
    • "ani_number_format": "+E.164",
    • "channel_limit": 10,
    • "codecs": "G722",
    • "default_routing_method": "sequential",
    • "dnis_number_format": "+e164",
    • "generate_ringback_tone": true,
    • "isup_headers_enabled": true,
    • "prack_enabled": true,
    • "privacy_zone_enabled": true,
    • "sip_compact_headers_enabled": true,
    • "timeout_1xx_secs": 10,
    • "timeout_2xx_secs": 20
    },
  • "onnet_t38_passthrough_enabled": true,
  • "outbound": {
    • "ani_override": "always",
    • "call_parking_enabled": true,
    • "channel_limit": 10,
    • "generate_ringback_tone": true,
    • "instant_ringback_enabled": true,
    • "localization": "US",
    • "outbound_voice_profile_id": "1293384261075731499",
    • "t38_reinvite_source": "telnyx"
    },
  • "password": "my123secure456password789",
  • "rtcp_settings": {
    • "capture_enabled": true,
    • "port": "rtcp-mux",
    • "report_frequency_seconds": 10
    },
  • "sip_uri_calling_preference": " disabled",
  • "user_name": "myusername123",
  • "webhook_api_version": "1",
  • "webhook_event_failover_url": "https://failover.example.com",
  • "webhook_event_url": "https://example.com",
  • "webhook_timeout_secs": 25
}
Response samples
application/json
{
  • "data": {
    • "active": true,
    • "anchorsite_override": "Latency",
    • "connection_name": "string",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "default_on_hold_comfort_noise_enabled": true,
    • "dtmf_type": "RFC 2833",
    • "encode_contact_header_enabled": true,
    • "encrypted_media": "SRTP",
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "inbound": {
      • "ani_number_format": "+E.164",
      • "channel_limit": 10,
      • "codecs": [
        • "G722"
        ],
      • "dnis_number_format": "+e164",
      • "generate_ringback_tone": true,
      • "isup_headers_enabled": true,
      • "prack_enabled": true,
      • "privacy_zone_enabled": true,
      • "sip_compact_headers_enabled": true,
      • "timeout_1xx_secs": 10,
      • "timeout_2xx_secs": "15"
      },
    • "onnet_t38_passthrough_enabled": true,
    • "outbound": {
      • "ani_override": "string",
      • "ani_override_type": "always",
      • "call_parking_enabled": true,
      • "channel_limit": 10,
      • "generate_ringback_tone": true,
      • "instant_ringback_enabled": true,
      • "localization": "string",
      • "outbound_voice_profile_id": "1293384261075731499",
      • "t38_reinvite_source": "telnyx"
      },
    • "password": "my123secure456password789",
    • "record_type": "credential_connection",
    • "rtcp_settings": {
      • "capture_enabled": true,
      • "port": "rtp+1",
      • "report_frequency_seconds": 10
      },
    • "sip_uri_calling_preference": "disabled",
    • "updated_at": "2018-02-02T22:25:27.521Z",
    • "user_name": "myusername123",
    • "webhook_api_version": "1",
    • "webhook_event_failover_url": "https://failover.example.com",
    • "webhook_event_url": "https://example.com",
    • "webhook_timeout_secs": 25
    }
}