Telnyx

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const credentialConnection = await client.credentialConnections.update('id');

console.log(credentialConnection.data);

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "credential_connection",
    "active": true,
    "user_name": "myusername123",
    "password": "my123secure456password789",
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "anchorsite_override": "Latency",
    "connection_name": "string",
    "sip_uri_calling_preference": "disabled",
    "default_on_hold_comfort_noise_enabled": true,
    "dtmf_type": "RFC 2833",
    "encode_contact_header_enabled": true,
    "encrypted_media": "SRTP",
    "onnet_t38_passthrough_enabled": true,
    "ios_push_credential_id": "ec0c8e5d-439e-4620-a0c1-9d9c8d02a836",
    "android_push_credential_id": "06b09dfd-7154-4980-8b75-cebf7a9d4f8e",
    "webhook_event_url": "https://example.com",
    "webhook_event_failover_url": "https://failover.example.com",
    "webhook_api_version": "1",
    "call_cost_in_webhooks": false,
    "webhook_timeout_secs": 25,
    "tags": [
      "tag1",
      "tag2"
    ],
    "rtcp_settings": {
      "port": "rtp+1",
      "capture_enabled": true,
      "report_frequency_seconds": 10
    },
    "inbound": {
      "ani_number_format": "+E.164",
      "dnis_number_format": "+e164",
      "codecs": [
        "G722"
      ],
      "channel_limit": 10,
      "generate_ringback_tone": true,
      "isup_headers_enabled": true,
      "prack_enabled": true,
      "sip_compact_headers_enabled": true,
      "timeout_1xx_secs": 10,
      "timeout_2xx_secs": 15,
      "shaken_stir_enabled": true
    },
    "outbound": {
      "call_parking_enabled": true,
      "ani_override": "string",
      "ani_override_type": "always",
      "channel_limit": 10,
      "instant_ringback_enabled": true,
      "generate_ringback_tone": true,
      "localization": "string",
      "t38_reinvite_source": "customer",
      "outbound_voice_profile_id": "1293384261075731499"
    }
  }
}

PATCH

credential_connections

{id}

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const credentialConnection = await client.credentialConnections.update('id');

console.log(credentialConnection.data);

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "credential_connection",
    "active": true,
    "user_name": "myusername123",
    "password": "my123secure456password789",
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "anchorsite_override": "Latency",
    "connection_name": "string",
    "sip_uri_calling_preference": "disabled",
    "default_on_hold_comfort_noise_enabled": true,
    "dtmf_type": "RFC 2833",
    "encode_contact_header_enabled": true,
    "encrypted_media": "SRTP",
    "onnet_t38_passthrough_enabled": true,
    "ios_push_credential_id": "ec0c8e5d-439e-4620-a0c1-9d9c8d02a836",
    "android_push_credential_id": "06b09dfd-7154-4980-8b75-cebf7a9d4f8e",
    "webhook_event_url": "https://example.com",
    "webhook_event_failover_url": "https://failover.example.com",
    "webhook_api_version": "1",
    "call_cost_in_webhooks": false,
    "webhook_timeout_secs": 25,
    "tags": [
      "tag1",
      "tag2"
    ],
    "rtcp_settings": {
      "port": "rtp+1",
      "capture_enabled": true,
      "report_frequency_seconds": 10
    },
    "inbound": {
      "ani_number_format": "+E.164",
      "dnis_number_format": "+e164",
      "codecs": [
        "G722"
      ],
      "channel_limit": 10,
      "generate_ringback_tone": true,
      "isup_headers_enabled": true,
      "prack_enabled": true,
      "sip_compact_headers_enabled": true,
      "timeout_1xx_secs": 10,
      "timeout_2xx_secs": 15,
      "shaken_stir_enabled": true
    },
    "outbound": {
      "call_parking_enabled": true,
      "ani_override": "string",
      "ani_override_type": "always",
      "channel_limit": 10,
      "instant_ringback_enabled": true,
      "generate_ringback_tone": true,
      "localization": "string",
      "t38_reinvite_source": "customer",
      "outbound_voice_profile_id": "1293384261075731499"
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Identifies the resource.

Body

application/json

Parameters that can be updated in a credential connection

active

boolean

Defaults to true

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

Example:

"myusername123"

password

string

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

Example:

"my123secure456password789"

anchorsite_override

enum<string>

default:Latency

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.

Available options:

Latency,

Chicago, IL,

Ashburn, VA,

San Jose, CA,

Sydney, Australia,

Amsterdam, Netherlands,

London, UK,

Toronto, Canada,

Vancouver, Canada,

Frankfurt, Germany

Example:

"Amsterdam, Netherlands"

connection_name

string

A user-assigned name to help manage the connection.

Example:

"office-connection"

sip_uri_calling_preference

enum<string>

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

Available options:

disabled,

unrestricted,

internal

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

enum<string>

default:RFC 2833

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.

Available options:

RFC 2833,

Inband,

SIP INFO

Example:

"Inband"

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

enum<string> | null

Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TLS.

Available options:

SRTP,

Example:

"SRTP"

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.

ios_push_credential_id

string | null

The uuid of the push credential for Ios

Example:

"ec0c8e5d-439e-4620-a0c1-9d9c8d02a836"

android_push_credential_id

string | null

The uuid of the push credential for Android

Example:

"06b09dfd-7154-4980-8b75-cebf7a9d4f8e"

webhook_event_url

string<uri>

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

Example:

"https://example.com"

webhook_event_failover_url

string<uri> | null

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

Example:

"https://failover.example.com"

webhook_api_version

enum<string>

default:1

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

Available options:

1,

2

Example:

"1"

webhook_timeout_secs

integer | null

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

Required range: 0 <= x <= 30

Example:

25

call_cost_in_webhooks

boolean

default:false

Specifies if call cost webhooks should be sent for this connection.

tags

string[]

Tags associated with the connection.

Example:

["tag1", "tag2"]

rtcp_settings

Connection RTCP Settings · object

Show child attributes

rtcp_settings.port

enum<string>

default:rtp+1

RTCP port by default is rtp+1, it can also be set to rtcp-mux

Available options:

rtcp-mux,

rtp+1

rtcp_settings.capture_enabled

boolean

default:false

BETA - Enable the capture and storage of RTCP messages to create QoS reports on the Telnyx Mission Control Portal.

Example:

true

rtcp_settings.report_frequency_secs

integer

default:5

RTCP reports are sent to customers based on the frequency set. Frequency is in seconds and it can be set to values from 5 to 3000 seconds.

Example:

10

Example:

{
  "port": "rtcp-mux",
  "capture_enabled": true,
  "report_frequency_secs": 10
}

inbound

Credential Inbound · object

Show child attributes

inbound.ani_number_format

enum<string>

default:E.164-national

This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls.

Available options:

+E.164,

E.164,

+E.164-national,

E.164-national

inbound.dnis_number_format

enum<string>

default:e164

Available options:

+e164,

e164,

national,

sip_username

inbound.codecs

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.

inbound.channel_limit

integer

When set, this will limit the total number of inbound calls to phone numbers associated with this connection.

inbound.generate_ringback_tone

boolean

default:false

Generate ringback tone through 183 session progress message with early media.

inbound.isup_headers_enabled

boolean

default:false

When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.)

inbound.prack_enabled

boolean

default:false

Enable PRACK messages as defined in RFC3262.

inbound.sip_compact_headers_enabled

boolean

default:true

Defaults to true.

inbound.timeout_1xx_secs

integer

default:3

Time(sec) before aborting if connection is not made.

Required range: 1 <= x <= 120

inbound.timeout_2xx_secs

integer

default:90

Time(sec) before aborting if call is unanswered (min: 1, max: 600).

Required range: 1 <= x <= 600

inbound.shaken_stir_enabled

boolean

default:false

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.

Example:

{
  "ani_number_format": "+E.164",
  "dnis_number_format": "+e164",
  "codecs": ["G722"],
  "default_routing_method": "sequential",
  "channel_limit": 10,
  "generate_ringback_tone": true,
  "isup_headers_enabled": true,
  "prack_enabled": true,
  "sip_compact_headers_enabled": true,
  "timeout_1xx_secs": 10,
  "timeout_2xx_secs": 20,
  "shaken_stir_enabled": true
}

outbound

Credential Outbound · object

Show child attributes

outbound.call_parking_enabled

boolean | null

default:false

Forces all SIP calls originated on this connection to be "parked" instead of "bridged" to the destination specified on the URI. Parked calls will return ringback to the caller and will await for a Call Control command to define which action will be taken next.

outbound.ani_override

string

default:""

Set a phone number as the ani_override value to override caller id number on outbound calls.

outbound.ani_override_type

enum<string>

default:always

Specifies when we apply your ani_override setting. Only applies when ani_override is not blank.

Available options:

always,

normal,

emergency

outbound.channel_limit

integer

When set, this will limit the total number of outbound calls to phone numbers associated with this connection.

outbound.instant_ringback_enabled

boolean

default:true

When set, ringback will not wait for indication before sending ringback tone to calling party.

outbound.generate_ringback_tone

boolean

default:false

Generate ringback tone through 183 session progress message with early media.

outbound.localization

string

default:US

A 2-character country code specifying the country whose national dialing rules should be used. For example, if set to US then any US number can be dialed without preprending +1 to the number. When left blank, Telnyx will try US and GB dialing rules, in that order, by default.

Example:

"US"

outbound.t38_reinvite_source

enum<string>

default:telnyx

This setting only affects connections with Fax-type Outbound Voice Profiles. The setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By default, Telnyx will send the re-invite. If set to customer, the caller is expected to send the t.38 reinvite.

Available options:

telnyx,

customer,

disabled,

passthru,

caller-passthru,

callee-passthru

outbound.outbound_voice_profile_id

string<int64>

Identifies the associated outbound voice profile.

Example:

"1293384261075731499"

Example:

{
  "call_parking_enabled": true,
  "ani_override": "always",
  "channel_limit": 10,
  "instant_ringback_enabled": true,
  "generate_ringback_tone": true,
  "localization": "US",
  "t38_reinvite_source": "customer",
  "outbound_voice_profile_id": "1293384261075731499"
}

Response

Successful response with details about a credential connection.

data

Credential Connection · object

Show child attributes

data.id

string<int64>

Identifies the type of resource.

Example:

"1293384261075731499"

data.record_type

string

Identifies the type of the resource.

Example:

"credential_connection"

data.active

boolean

Defaults to true

data.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). At least one of the first 5 characters must be a letter.

Example:

"myusername123"

data.password

string

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

Example:

"my123secure456password789"

data.created_at

string

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

Example:

"2018-02-02T22:25:27.521Z"

data.updated_at

string

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

Example:

"2018-02-02T22:25:27.521Z"

data.anchorsite_override

enum<string>

default:Latency

Available options:

Latency,

Chicago, IL,

Ashburn, VA,

San Jose, CA,

Sydney, Australia,

Amsterdam, Netherlands,

London, UK,

Toronto, Canada,

Vancouver, Canada,

Frankfurt, Germany

Example:

"Amsterdam, Netherlands"

data.connection_name

string

data.sip_uri_calling_preference

enum<string>

Available options:

disabled,

unrestricted,

internal

Example:

"disabled"

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

data.dtmf_type

enum<string>

default:RFC 2833

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.

Available options:

RFC 2833,

Inband,

SIP INFO

Example:

"Inband"

data.encode_contact_header_enabled

boolean

default:false

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

data.encrypted_media

enum<string> | null

Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TLS.

Available options:

SRTP,

Example:

"SRTP"

data.onnet_t38_passthrough_enabled

boolean

default:false

data.webhook_event_url

string<uri>

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

Example:

"https://example.com"

data.webhook_event_failover_url

string<uri> | null

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

Example:

"https://failover.example.com"

data.webhook_api_version

enum<string>

default:1

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

Available options:

1,

2

Example:

"1"

data.webhook_timeout_secs

integer | null

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

Required range: 0 <= x <= 30

Example:

25

data.call_cost_in_webhooks

boolean

default:false

Specifies if call cost webhooks should be sent for this connection.

data.tags

string[]

Tags associated with the connection.

Example:

["tag1", "tag2"]

data.rtcp_settings

Connection RTCP Settings · object

Show child attributes

data.rtcp_settings.port

enum<string>

default:rtp+1

RTCP port by default is rtp+1, it can also be set to rtcp-mux

Available options:

rtcp-mux,

rtp+1

data.rtcp_settings.capture_enabled

boolean

default:false

BETA - Enable the capture and storage of RTCP messages to create QoS reports on the Telnyx Mission Control Portal.

Example:

true

data.rtcp_settings.report_frequency_secs

integer

default:5

RTCP reports are sent to customers based on the frequency set. Frequency is in seconds and it can be set to values from 5 to 3000 seconds.

Example:

10

Example:

{
  "port": "rtcp-mux",
  "capture_enabled": true,
  "report_frequency_secs": 10
}

data.inbound

Credential Inbound · object

Show child attributes

data.inbound.ani_number_format

enum<string>

default:E.164-national

This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls.

Available options:

+E.164,

E.164,

+E.164-national,

E.164-national

data.inbound.dnis_number_format

enum<string>

default:e164

Available options:

+e164,

e164,

national,

sip_username

data.inbound.codecs

string[]

data.inbound.channel_limit

integer

When set, this will limit the total number of inbound calls to phone numbers associated with this connection.

data.inbound.generate_ringback_tone

boolean

default:false

Generate ringback tone through 183 session progress message with early media.

data.inbound.isup_headers_enabled

boolean

default:false

When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.)

data.inbound.prack_enabled

boolean

default:false

Enable PRACK messages as defined in RFC3262.

data.inbound.sip_compact_headers_enabled

boolean

default:true

Defaults to true.

data.inbound.timeout_1xx_secs

integer

default:3

Time(sec) before aborting if connection is not made.

Required range: 1 <= x <= 120

data.inbound.timeout_2xx_secs

integer

default:90

Time(sec) before aborting if call is unanswered (min: 1, max: 600).

Required range: 1 <= x <= 600

data.inbound.shaken_stir_enabled

boolean

default:false

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.

Example:

{
  "ani_number_format": "+E.164",
  "dnis_number_format": "+e164",
  "codecs": ["G722"],
  "default_routing_method": "sequential",
  "channel_limit": 10,
  "generate_ringback_tone": true,
  "isup_headers_enabled": true,
  "prack_enabled": true,
  "sip_compact_headers_enabled": true,
  "timeout_1xx_secs": 10,
  "timeout_2xx_secs": 20,
  "shaken_stir_enabled": true
}

data.outbound

Credential Outbound · object

Show child attributes

data.outbound.call_parking_enabled

boolean | null

default:false

data.outbound.ani_override

string

default:""

Set a phone number as the ani_override value to override caller id number on outbound calls.

data.outbound.ani_override_type

enum<string>

default:always

Specifies when we apply your ani_override setting. Only applies when ani_override is not blank.

Available options:

always,

normal,

emergency

data.outbound.channel_limit

integer

When set, this will limit the total number of outbound calls to phone numbers associated with this connection.

data.outbound.instant_ringback_enabled

boolean

default:true

When set, ringback will not wait for indication before sending ringback tone to calling party.

data.outbound.generate_ringback_tone

boolean

default:false

Generate ringback tone through 183 session progress message with early media.

data.outbound.localization

string

default:US

Example:

"US"

data.outbound.t38_reinvite_source

enum<string>

default:telnyx

Available options:

telnyx,

customer,

disabled,

passthru,

caller-passthru,

callee-passthru

data.outbound.outbound_voice_profile_id

string<int64>

Identifies the associated outbound voice profile.

Example:

"1293384261075731499"

Example:

{
  "call_parking_enabled": true,
  "ani_override": "always",
  "channel_limit": 10,
  "instant_ringback_enabled": true,
  "generate_ringback_tone": true,
  "localization": "US",
  "t38_reinvite_source": "customer",
  "outbound_voice_profile_id": "1293384261075731499"
}

Example:

{
  "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "record_type": "credential_connection",
  "active": true,
  "user_name": "myusername123",
  "password": "my123secure456password789",
  "created_at": "2018-02-02T22:25:27.521Z",
  "updated_at": "2018-02-02T22:25:27.521Z",
  "anchorsite_override": "Latency",
  "connection_name": "string",
  "sip_uri_calling_preference": "disabled",
  "default_on_hold_comfort_noise_enabled": true,
  "dtmf_type": "RFC 2833",
  "encode_contact_header_enabled": true,
  "encrypted_media": "SRTP",
  "onnet_t38_passthrough_enabled": true,
  "ios_push_credential_id": "ec0c8e5d-439e-4620-a0c1-9d9c8d02a836",
  "android_push_credential_id": "06b09dfd-7154-4980-8b75-cebf7a9d4f8e",
  "webhook_event_url": "https://example.com",
  "webhook_event_failover_url": "https://failover.example.com",
  "webhook_api_version": "1",
  "call_cost_in_webhooks": false,
  "webhook_timeout_secs": 25,
  "tags": ["tag1", "tag2"],
  "rtcp_settings": {
    "port": "rtp+1",
    "capture_enabled": true,
    "report_frequency_seconds": 10
  },
  "inbound": {
    "ani_number_format": "+E.164",
    "dnis_number_format": "+e164",
    "codecs": ["G722"],
    "channel_limit": 10,
    "generate_ringback_tone": true,
    "isup_headers_enabled": true,
    "prack_enabled": true,
    "sip_compact_headers_enabled": true,
    "timeout_1xx_secs": 10,
    "timeout_2xx_secs": 15,
    "shaken_stir_enabled": true
  },
  "outbound": {
    "call_parking_enabled": true,
    "ani_override": "string",
    "ani_override_type": "always",
    "channel_limit": 10,
    "instant_ringback_enabled": true,
    "generate_ringback_tone": true,
    "localization": "string",
    "t38_reinvite_source": "customer",
    "outbound_voice_profile_id": "1293384261075731499"
  }
}

Delete a credential connection Check a Credential Connection Registration Status

⌘I

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup