Create a credential connection

POST 
/credential_connections

Creates a credential connection.

Request

application/json

Body

required

Parameters that can be defined during credential connection creation

active boolean

Defaults to true

user_name stringrequired

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

password stringrequired

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

anchorsite_override Anchorsite Override (string)

Possible values: [Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany]

Default value: 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.

connection_name Connection Name (string)required

A user-assigned name to help manage the connection.

sip_uri_calling_preference string

Possible values: [disabled, unrestricted, internal]

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

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

dtmf_type DTMF Type (string)

Possible values: [RFC 2833, Inband, SIP INFO]

Default value: 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.

encode_contact_header_enabled boolean

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

encrypted_media EncryptedMedia (string)nullable

Possible values: [SRTP]

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

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

ios_push_credential_id Ios Push Credential Id (string)nullable

The uuid of the push credential for Ios

android_push_credential_id Android Push Credential Id (string)nullable

The uuid of the push credential for Android

webhook_event_url url

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

webhook_event_failover_url urlnullable

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_api_version string

Possible values: [1, 2, texml]

Default value: 1

Determines which webhook format will be used, Telnyx API v1, v2 or texml. Note - texml can only be set when the outbound object parameter call_parking_enabled is included and set to true.

webhook_timeout_secs integernullable

Possible values: <= 30

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

rtcp_settings

object

port

Possible values: [rtcp-mux, rtp+1]

Default value: rtp+1

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

capture_enabled boolean

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

report_frequency_secs integer

Default value: 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.

inbound

object

ani_number_format string

Possible values: [+E.164, E.164, +E.164-national, E.164-national]

Default value: E.164-national

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

dnis_number_format string

Possible values: [+e164, e164, national, sip_username]

Default value: e164

codecs string[]

Default value: G722,G711U,G711A,G729,OPUS,H.264

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.

channel_limit integer

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

generate_ringback_tone boolean

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

isup_headers_enabled boolean

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

prack_enabled boolean

Enable PRACK messages as defined in RFC3262.

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

sip_compact_headers_enabled boolean

Default value: true

Defaults to true.

timeout_1xx_secs integer

Possible values: >= 1 and <= 120

Default value: 3

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

timeout_2xx_secs string

Possible values: >= 1 and <= 600

Default value: 90

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

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

outbound

object

call_parking_enabled boolean

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.

ani_override string

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

ani_override_type string

Possible values: [always, normal, emergency]

Default value: always

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

channel_limit integer

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

instant_ringback_enabled boolean

Default value: true

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

generate_ringback_tone boolean

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

localization string

Default value: 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.

t38_reinvite_source string

Possible values: [telnyx, customer, disabled, passthru, caller-passthru, callee-passthru]

Default value: telnyx

This setting only affects connections with Fax-type Outbound Voice Profiles. The setting dictates whether or not Telnyx sends a t.38 reinvite.

By default, Telnyx will send the re-invite. If set to customer, the caller is expected to send the t.38 reinvite.

outbound_voice_profile_id int64

Identifies the associated outbound voice profile.

Responses

201: Successful response with details about a credential connection.

application/json

• Schema
• Example (from schema)

Schema

data

object

id int64

Identifies the type of resource.

record_type string

Identifies the type of the resource.

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

password string

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

created_at string

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

updated_at string

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

anchorsite_override Anchorsite Override (string)

Possible values: [Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany]

Default value: 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.

connection_name string

sip_uri_calling_preference string

Possible values: [disabled, unrestricted, internal]

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

default_on_hold_comfort_noise_enabled boolean

Default value: 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 DTMF Type (string)

Possible values: [RFC 2833, Inband, SIP INFO]

Default value: 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.

encode_contact_header_enabled boolean

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

encrypted_media EncryptedMedia (string)nullable

Possible values: [SRTP]

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

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

webhook_event_url url

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

webhook_event_failover_url urlnullable

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_api_version string

Possible values: [1, 2]

Default value: 1

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

webhook_timeout_secs integernullable

Possible values: <= 30

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

rtcp_settings

object

port

Possible values: [rtcp-mux, rtp+1]

Default value: rtp+1

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

capture_enabled boolean

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

report_frequency_secs integer

Default value: 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.

inbound

object

ani_number_format string

Possible values: [+E.164, E.164, +E.164-national, E.164-national]

Default value: E.164-national

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

dnis_number_format string

Possible values: [+e164, e164, national, sip_username]

Default value: e164

codecs string[]

Default value: G722,G711U,G711A,G729,OPUS,H.264

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.

channel_limit integer

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

generate_ringback_tone boolean

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

isup_headers_enabled boolean

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

prack_enabled boolean

Enable PRACK messages as defined in RFC3262.

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

sip_compact_headers_enabled boolean

Default value: true

Defaults to true.

timeout_1xx_secs integer

Possible values: >= 1 and <= 120

Default value: 3

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

timeout_2xx_secs string

Possible values: >= 1 and <= 600

Default value: 90

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

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

outbound

object

call_parking_enabled boolean

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.

ani_override string

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

ani_override_type string

Possible values: [always, normal, emergency]

Default value: always

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

channel_limit integer

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

instant_ringback_enabled boolean

Default value: true

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

generate_ringback_tone boolean

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

localization string

Default value: 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.

t38_reinvite_source string

Possible values: [telnyx, customer, disabled, passthru, caller-passthru, callee-passthru]

Default value: telnyx

This setting only affects connections with Fax-type Outbound Voice Profiles. The setting dictates whether or not Telnyx sends a t.38 reinvite.

By default, Telnyx will send the re-invite. If set to customer, the caller is expected to send the t.38 reinvite.

outbound_voice_profile_id int64

Identifies the associated outbound voice profile.

{
  "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",
    "webhook_timeout_secs": 25,
    "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,
      "privacy_zone_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": "telnyx",
      "outbound_voice_profile_id": "1293384261075731499"
    }
  }
}

401: Unauthorized

application/json

• Schema
• Example (from schema)
• Authentication Failed

Schema

errors

object[]

Array [

code string

detail string

meta

object

url uri

title string

source

object

pointer string

]

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "meta": {
        "url": "string"
      },
      "title": "string",
      "source": {
        "pointer": "string"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10009",
      "title": "Authentication failed",
      "detail": "Could not understand the provided credentials.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10009"
      }
    }
  ]
}

403: The user doesn't have the required permissions to perform the requested action.

application/json

• Schema
• Example (from schema)
• notAuthorized

Schema

errors

object[]

Array [

code string

detail string

meta

object

url uri

title string

source

object

pointer string

]

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "meta": {
        "url": "string"
      },
      "title": "string",
      "source": {
        "pointer": "string"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10010",
      "title": "Not authorized",
      "detail": "You are not authorized to access the requested resource.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10010"
      },
      "source": {
        "pointer": "/"
      }
    }
  ]
}

422: The request was well-formed but was unable to be followed due to semantic errors.

application/json

• Schema
• Example (from schema)
• unprocessableEntity

Schema

errors

object[]

Array [

code string

detail string

meta

object

url uri

title string

source

object

pointer string

]

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "meta": {
        "url": "string"
      },
      "title": "string",
      "source": {
        "pointer": "string"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10015",
      "title": "Bad Request",
      "detail": "Invalid dnis_format: test, was provided. Acceptable formats are +e164, e164, national, sip_username",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      },
      "source": {
        "pointer": "/inbound/dnis_number_format"
      }
    }
  ]
}

Loading...