IP Connections

IP connection operations

List Ip connections

Returns a list of your IP 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 IP connections.

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

Bad request

401

Unauthorized

404

Resource not found

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

telnyx.IPConnection.list(page={"number":1, "size":20})
Response samples
application/json
{
  • "data": [
    • {
      • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      • "record_type": "ip_connection",
      • "active": true,
      • "anchorsite_override": "Latency",
      • "connection_name": "string",
      • "transport_protocol": "UDP",
      • "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": "rtcp-mux",
        • "capture_enabled": true,
        • "report_frequency_secs": 10
        },
      • "created_at": "2018-02-02T22:25:27.521Z",
      • "updated_at": "2018-02-02T22:25:27.521Z",
      • "inbound": {
        • "ani_number_format": "+E.164",
        • "dnis_number_format": "+e164",
        • "codecs": [
          • "G722"
          ],
        • "default_primary_ip_id": "192.0.2.1",
        • "default_secondary_ip_id": "198.51.100.1",
        • "default_tertiary_ip_id": "203.0.113.1",
        • "default_routing_method": "sequential",
        • "channel_limit": 10,
        • "generate_ringback_tone": true,
        • "isup_headers_enabled": true,
        • "prack_enabled": true,
        • "privacy_zone_enabled": true,
        • "sip_compact_headers_enabled": true,
        • "sip_region": "US",
        • "sip_subdomain": "string",
        • "sip_subdomain_receive_settings": "only_my_connections",
        • "timeout_1xx_secs": 10,
        • "timeout_2xx_secs": 10,
        • "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",
        • "tech_prefix": "string",
        • "ip_authentication_method": "token",
        • "ip_authentication_token": "string",
        • "outbound_voice_profile_id": "1293384261075731499"
        }
      }
    ],
  • "meta": {
    • "total_pages": 3,
    • "total_results": 55,
    • "page_number": 2,
    • "page_size": 25
    }
}

Create an Ip connection

Creates an IP connection.

SecuritybearerAuth
Request
Request Body schema: application/json
required

Parameters that can be defined during IP connection creation

active
boolean

Defaults to true

anchorsite_override
string (Anchorsite Override)
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.

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

One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication.

Enum: "UDP" "TCP" "TLS"
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 (DTMF Type)
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.

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 or null (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"
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 or null (Ios Push Credential Id)
Default: null

The uuid of the push credential for Ios

android_push_credential_id
string or null (Android Push Credential Id)
Default: null

The uuid of the push credential for Android

webhook_event_url
string <url>

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

webhook_event_failover_url
string or null <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_api_version
string
Default: "1"

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

Enum: "1" "2"
webhook_timeout_secs
integer or null [ 0 .. 30 ]
Default: null

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

object (Connection RTCP Settings)
object (Create Inbound Ip Request)
object (Outband Ip)
Responses
201

Successful response with details about an IP connection.

Response Schema: application/json
object (Ip Connection)
id
string <int64>

Identifies the type of resource.

record_type
string

Identifies the type of the resource.

active
boolean

Defaults to true

anchorsite_override
string (Anchorsite Override)
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.

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

One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication.

Enum: "UDP" "TCP" "TLS"
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 (DTMF Type)
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.

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 or null (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"
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.

webhook_event_url
string <url>

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

webhook_event_failover_url
string or null <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_api_version
string
Default: "1"

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

Enum: "1" "2"
webhook_timeout_secs
integer or null [ 0 .. 30 ]
Default: null

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

object (Connection RTCP Settings)
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.

object (Inbound Ip)
object (Outband Ip)
422

Bad request

post/ip_connections
Request samples
application/json
{
  • "active": true,
  • "anchorsite_override": "Latency",
  • "connection_name": "string",
  • "transport_protocol": "UDP",
  • "default_on_hold_comfort_noise_enabled": true,
  • "dtmf_type": "RFC 2833",
  • "encode_contact_header_enabled": true,
  • "encrypted_media": "SRTP",
  • "onnet_t38_passthrough_enabled": false,
  • "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": "rtcp-mux",
    • "capture_enabled": true,
    • "report_frequency_secs": 10
    },
  • "inbound:": {
    • "ani_number_format": "+E.164",
    • "dns_number_format": "+e164",
    • "codecs": "G722",
    • "default_primary_ip_id": "192.168.0.0",
    • "default_tertiary_ip_id": "192.168.0.0",
    • "default_secondary_ip_id": "192.168.0.0",
    • "default_routing_method": "sequential",
    • "channel_limit": 10,
    • "generate_ringback_tone": true,
    • "isup_headers_enabled": true,
    • "prack_enabled": true,
    • "privacy_zone_enabled": true,
    • "sip_compact_headers_enabled": true,
    • "sip_region": "US",
    • "sip_subdomain": "test",
    • "sip_subdomain_receive_settings": "only_my_connections",
    • "timeout_1xx_secs": 10,
    • "timeout_2xx_secs": 20,
    • "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",
    • "tech_prefix": "string",
    • "ip_authentication_method": "token",
    • "ip_authentication_token": "string",
    • "outbound_voice_profile_id": "1293384261075731499"
    }
}
Response samples
application/json
{
  • "data": {
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "ip_connection",
    • "active": true,
    • "anchorsite_override": "Latency",
    • "connection_name": "string",
    • "transport_protocol": "UDP",
    • "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": "rtcp-mux",
      • "capture_enabled": true,
      • "report_frequency_secs": 10
      },
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "updated_at": "2018-02-02T22:25:27.521Z",
    • "inbound": {
      • "ani_number_format": "+E.164",
      • "dnis_number_format": "+e164",
      • "codecs": [
        • "G722"
        ],
      • "default_primary_ip_id": "192.0.2.1",
      • "default_secondary_ip_id": "198.51.100.1",
      • "default_tertiary_ip_id": "203.0.113.1",
      • "default_routing_method": "sequential",
      • "channel_limit": 10,
      • "generate_ringback_tone": true,
      • "isup_headers_enabled": true,
      • "prack_enabled": true,
      • "privacy_zone_enabled": true,
      • "sip_compact_headers_enabled": true,
      • "sip_region": "US",
      • "sip_subdomain": "string",
      • "sip_subdomain_receive_settings": "only_my_connections",
      • "timeout_1xx_secs": 10,
      • "timeout_2xx_secs": 10,
      • "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",
      • "tech_prefix": "string",
      • "ip_authentication_method": "token",
      • "ip_authentication_token": "string",
      • "outbound_voice_profile_id": "1293384261075731499"
      }
    }
}

Delete an Ip connection

Deletes an existing IP connection.

SecuritybearerAuth
Request
path Parameters
id
required
string

Identifies the type of resource.

Responses
200

Successful response with details about an IP connection.

Response Schema: application/json
object (Ip Connection)
id
string <int64>

Identifies the type of resource.

record_type
string

Identifies the type of the resource.

active
boolean

Defaults to true

anchorsite_override
string (Anchorsite Override)
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.

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

One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication.

Enum: "UDP" "TCP" "TLS"
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 (DTMF Type)
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.

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 or null (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"
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.

webhook_event_url
string <url>

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

webhook_event_failover_url
string or null <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_api_version
string
Default: "1"

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

Enum: "1" "2"
webhook_timeout_secs
integer or null [ 0 .. 30 ]
Default: null

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

object (Connection RTCP Settings)
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.

object (Inbound Ip)
object (Outband Ip)
401

Unauthorized

404

Resource not found

422

Bad request

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

res = telnyx.IPConnection.retrieve("id")
res.delete()
Response samples
application/json
{
  • "data": {
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "ip_connection",
    • "active": true,
    • "anchorsite_override": "Latency",
    • "connection_name": "string",
    • "transport_protocol": "UDP",
    • "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": "rtcp-mux",
      • "capture_enabled": true,
      • "report_frequency_secs": 10
      },
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "updated_at": "2018-02-02T22:25:27.521Z",
    • "inbound": {
      • "ani_number_format": "+E.164",
      • "dnis_number_format": "+e164",
      • "codecs": [
        • "G722"
        ],
      • "default_primary_ip_id": "192.0.2.1",
      • "default_secondary_ip_id": "198.51.100.1",
      • "default_tertiary_ip_id": "203.0.113.1",
      • "default_routing_method": "sequential",
      • "channel_limit": 10,
      • "generate_ringback_tone": true,
      • "isup_headers_enabled": true,
      • "prack_enabled": true,
      • "privacy_zone_enabled": true,
      • "sip_compact_headers_enabled": true,
      • "sip_region": "US",
      • "sip_subdomain": "string",
      • "sip_subdomain_receive_settings": "only_my_connections",
      • "timeout_1xx_secs": 10,
      • "timeout_2xx_secs": 10,
      • "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",
      • "tech_prefix": "string",
      • "ip_authentication_method": "token",
      • "ip_authentication_token": "string",
      • "outbound_voice_profile_id": "1293384261075731499"
      }
    }
}

Retrieve an Ip connection

Retrieves the details of an existing ip connection.

SecuritybearerAuth
Request
path Parameters
id
required
string

IP Connection ID

Responses
200

Successful response with details about an IP connection.

Response Schema: application/json
object (Ip Connection)
id
string <int64>

Identifies the type of resource.

record_type
string

Identifies the type of the resource.

active
boolean

Defaults to true

anchorsite_override
string (Anchorsite Override)
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.

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

One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication.

Enum: "UDP" "TCP" "TLS"
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 (DTMF Type)
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.

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 or null (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"
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.

webhook_event_url
string <url>

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

webhook_event_failover_url
string or null <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_api_version
string
Default: "1"

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

Enum: "1" "2"
webhook_timeout_secs
integer or null [ 0 .. 30 ]
Default: null

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

object (Connection RTCP Settings)
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.

object (Inbound Ip)
object (Outband Ip)
401

Unauthorized

404

Resource not found

422

Bad request

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

telnyx.IPConnection.retrieve("id")
Response samples
application/json
{
  • "data": {
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "ip_connection",
    • "active": true,
    • "anchorsite_override": "Latency",
    • "connection_name": "string",
    • "transport_protocol": "UDP",
    • "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": "rtcp-mux",
      • "capture_enabled": true,
      • "report_frequency_secs": 10
      },
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "updated_at": "2018-02-02T22:25:27.521Z",
    • "inbound": {
      • "ani_number_format": "+E.164",
      • "dnis_number_format": "+e164",
      • "codecs": [
        • "G722"
        ],
      • "default_primary_ip_id": "192.0.2.1",
      • "default_secondary_ip_id": "198.51.100.1",
      • "default_tertiary_ip_id": "203.0.113.1",
      • "default_routing_method": "sequential",
      • "channel_limit": 10,
      • "generate_ringback_tone": true,
      • "isup_headers_enabled": true,
      • "prack_enabled": true,
      • "privacy_zone_enabled": true,
      • "sip_compact_headers_enabled": true,
      • "sip_region": "US",
      • "sip_subdomain": "string",
      • "sip_subdomain_receive_settings": "only_my_connections",
      • "timeout_1xx_secs": 10,
      • "timeout_2xx_secs": 10,
      • "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",
      • "tech_prefix": "string",
      • "ip_authentication_method": "token",
      • "ip_authentication_token": "string",
      • "outbound_voice_profile_id": "1293384261075731499"
      }
    }
}

Update an Ip connection

Updates settings of an existing IP connection.

SecuritybearerAuth
Request
path Parameters
id
required
string

Identifies the type of resource.

Request Body schema: application/json
required

Parameters that can be updated in a IP connection

active
boolean

Defaults to true

anchorsite_override
string (Anchorsite Override)
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.

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

One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication.

Enum: "UDP" "TCP" "TLS"
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 (DTMF Type)
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.

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 or null (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"
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 or null (Ios Push Credential Id)
Default: null

The uuid of the push credential for Ios

android_push_credential_id
string or null (Android Push Credential Id)
Default: null

The uuid of the push credential for Android

webhook_event_url
string <url>

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

webhook_event_failover_url
string or null <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_api_version
string
Default: "1"

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

Enum: "1" "2"
webhook_timeout_secs
integer or null [ 0 .. 30 ]
Default: null

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

object (Connection RTCP Settings)
object (Inbound Ip)
object (Outband Ip)
Responses
200

Successful response with details about an IP connection.

Response Schema: application/json
object (Ip Connection)
id
string <int64>

Identifies the type of resource.

record_type
string

Identifies the type of the resource.

active
boolean

Defaults to true

anchorsite_override
string (Anchorsite Override)
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.

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

One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication.

Enum: "UDP" "TCP" "TLS"
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 (DTMF Type)
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.

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 or null (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"
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.

webhook_event_url
string <url>

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

webhook_event_failover_url
string or null <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_api_version
string
Default: "1"

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

Enum: "1" "2"
webhook_timeout_secs
integer or null [ 0 .. 30 ]
Default: null

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

object (Connection RTCP Settings)
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.

object (Inbound Ip)
object (Outband Ip)
401

Unauthorized

404

Resource not found

422

Bad request

patch/ip_connections/{id}
Request samples
application/json
{
  • "active": true,
  • "anchorsite_override": "Latency",
  • "connection_name": "string",
  • "transport_protocol": "UDP",
  • "default_on_hold_comfort_noise_enabled": true,
  • "dtmf_type": "RFC 2833",
  • "encode_contact_header_enabled": true,
  • "encrypted_media": "SRTP",
  • "onnet_t38_passthrough_enabled": false,
  • "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": "rtcp-mux",
    • "capture_enabled": true,
    • "report_frequency_secs": 10
    },
  • "inbound:": {
    • "ani_number_format": "+E.164",
    • "dns_number_format": "+e164",
    • "codecs": "G722",
    • "default_primary_ip_id": "192.168.0.0",
    • "default_tertiary_ip_id": "192.168.0.0",
    • "default_secondary_ip_id": "192.168.0.0",
    • "default_routing_method": "sequential",
    • "channel_limit": 10,
    • "generate_ringback_tone": true,
    • "isup_headers_enabled": true,
    • "prack_enabled": true,
    • "privacy_zone_enabled": true,
    • "sip_compact_headers_enabled": true,
    • "sip_region": "US",
    • "sip_subdomain": "test",
    • "sip_subdomain_receive_settings": "only_my_connections",
    • "timeout_1xx_secs": 10,
    • "timeout_2xx_secs": 20,
    • "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",
    • "tech_prefix": "string",
    • "ip_authentication_method": "token",
    • "ip_authentication_token": "string",
    • "outbound_voice_profile_id": "1293384261075731499"
    }
}
Response samples
application/json
{
  • "data": {
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "ip_connection",
    • "active": true,
    • "anchorsite_override": "Latency",
    • "connection_name": "string",
    • "transport_protocol": "UDP",
    • "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": "rtcp-mux",
      • "capture_enabled": true,
      • "report_frequency_secs": 10
      },
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "updated_at": "2018-02-02T22:25:27.521Z",
    • "inbound": {
      • "ani_number_format": "+E.164",
      • "dnis_number_format": "+e164",
      • "codecs": [
        • "G722"
        ],
      • "default_primary_ip_id": "192.0.2.1",
      • "default_secondary_ip_id": "198.51.100.1",
      • "default_tertiary_ip_id": "203.0.113.1",
      • "default_routing_method": "sequential",
      • "channel_limit": 10,
      • "generate_ringback_tone": true,
      • "isup_headers_enabled": true,
      • "prack_enabled": true,
      • "privacy_zone_enabled": true,
      • "sip_compact_headers_enabled": true,
      • "sip_region": "US",
      • "sip_subdomain": "string",
      • "sip_subdomain_receive_settings": "only_my_connections",
      • "timeout_1xx_secs": 10,
      • "timeout_2xx_secs": 10,
      • "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",
      • "tech_prefix": "string",
      • "ip_authentication_method": "token",
      • "ip_authentication_token": "string",
      • "outbound_voice_profile_id": "1293384261075731499"
      }
    }
}