Telnyx

{ "data": { "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "record_type": "ip_connection", "active": true, "anchorsite_override": "Latency", "connection_name": "string", "created_at": "2018-02-02T22:25:27.521Z", "updated_at": "2018-02-02T22:25:27.521Z", "webhook_event_url": "https://example.com", "webhook_event_failover_url": "https://failover.example.com", "webhook_api_version": "1", "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

IP Connection ID

Response

Successful response with details about a connection.

data

Connection · object

Show child attributes

data.id

string<int64>

Identifies the specific resource.

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

data.record_type

string

Identifies the type of the resource.

Example:

"ip_connection"

data.active

boolean

Defaults to true

Example:

true

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

data.connection_name

string

Example:

"string"

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

string<uri> | null

The URL where webhooks related to this connection will be sent.

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.

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

string<int64>

Identifies the associated outbound voice profile.

Example:

"1293384261075731499"

data.tags

string[]

Tags associated with the connection.

Example:

["tag1", "tag2"]

Example:

{
  "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "record_type": "ip_connection",
  "active": true,
  "anchorsite_override": "Latency",
  "connection_name": "string",
  "created_at": "2018-02-02T22:25:27.521Z",
  "updated_at": "2018-02-02T22:25:27.521Z",
  "webhook_event_url": "https://example.com",
  "webhook_event_failover_url": "https://failover.example.com",
  "webhook_api_version": "1",
  "outbound_voice_profile_id": "1293384261075731499"
}

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