SKILL.md
<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->
Telnyx Sip - curl
Installation
# curl is pre-installed on macOS, Linux, and Windows 10+
Setup
export TELNYX_API_KEY="YOUR_API_KEY_HERE"
All examples below use $TELNYXAPIKEY for authentication.
Error Handling
All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:
# Check HTTP status code in response
response=$(curl -s -w "\n%{http_code}" \
-X POST "https://api.telnyx.com/v2/messages" \
-H "Authorization: Bearer $TELNYX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"to": "+13125550001", "from": "+13125550002", "text": "Hello"}')
http_code=$(echo "$response" | tail -1)
body=$(echo "$response" | sed '$d')
case $http_code in
2*) echo "Success: $body" ;;
422) echo "Validation error — check required fields and formats" ;;
429) echo "Rate limited — retry after delay"; sleep 1 ;;
401) echo "Authentication failed — check TELNYX_API_KEY" ;;
*) echo "Error $http_code: $body" ;;
esac
Common error codes: 401 invalid API key, 403 insufficient permissions, 404 resource not found, 422 validation error (check field formats), 429 rate limited (retry with exponential backoff).
Important Notes
- Pagination: List endpoints return paginated results. Use
page[number]andpage[size]query parameters to navigate pages. Checkmeta.total_pagesin the response.
List all Access IP Ranges
GET /accessipranges
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/access_ip_ranges"
Returns: cidrblock (string), createdat (date-time), description (string), id (string), status (enum: pending, added), updatedat (date-time), userid (string)
Create new Access IP Range
POST /accessipranges — Required: cidr_block
Optional: description (string)
curl \
-X POST \
-H "Authorization: Bearer $TELNYX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"cidr_block": "203.0.113.0/24"
}' \
"https://api.telnyx.com/v2/access_ip_ranges"
Returns: cidrblock (string), createdat (date-time), description (string), id (string), status (enum: pending, added), updatedat (date-time), userid (string)
Delete access IP ranges
DELETE /accessipranges/{accessiprange_id}
curl \
-X DELETE \
-H "Authorization: Bearer $TELNYX_API_KEY" \
"https://api.telnyx.com/v2/access_ip_ranges/550e8400-e29b-41d4-a716-446655440000"
Returns: cidrblock (string), createdat (date-time), description (string), id (string), status (enum: pending, added), updatedat (date-time), userid (string)
List connections
Returns a list of your connections irrespective of type.
GET /connections
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/connections?sort=connection_name"
Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), connectionname (string), createdat (string), id (string), outboundvoiceprofileid (string), recordtype (string), tags (array[string]), updatedat (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookevent_url (uri)
Retrieve a connection
Retrieves the high-level details of an existing connection. To retrieve specific authentication information, use the endpoint for the specific connection type.
GET /connections/{id}
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/connections/550e8400-e29b-41d4-a716-446655440000"
Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), connectionname (string), createdat (string), id (string), outboundvoiceprofileid (string), recordtype (string), tags (array[string]), updatedat (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookevent_url (uri)
List credential connections
Returns a list of your credential connections.
GET /credential_connections
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/credential_connections?sort=connection_name"
Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), password (string), recordtype (string), rtcpsettings (object), sipuricallingpreference (enum: disabled, unrestricted, internal), tags (array[string]), updatedat (string), username (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeout_secs (integer | null)
Create a credential connection
Creates a credential connection.
POST /credentialconnections — Required: username, password, connection_name
Optional: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), rtcpsettings (object), sipuricallingpreference (enum: disabled, unrestricted, internal), tags (array[string]), webhookapiversion (enum: 1, 2, texml), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)
curl \
-X POST \
-H "Authorization: Bearer $TELNYX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"user_name": "myusername123",
"password": "my123secure456password789",
"connection_name": "office-connection"
}' \
"https://api.telnyx.com/v2/credential_connections"
Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), password (string), recordtype (string), rtcpsettings (object), sipuricallingpreference (enum: disabled, unrestricted, internal), tags (array[string]), updatedat (string), username (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeout_secs (integer | null)
Retrieve a credential connection
Retrieves the details of an existing credential connection.
GET /credential_connections/{id}
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/credential_connections/550e8400-e29b-41d4-a716-446655440000"
Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), password (string), recordtype (string), rtcpsettings (object), sipuricallingpreference (enum: disabled, unrestricted, internal), tags (array[string]), updatedat (string), username (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeout_secs (integer | null)
Update a credential connection
Updates settings of an existing credential connection.
PATCH /credential_connections/{id}
Optional: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), password (string), rtcpsettings (object), sipuricallingpreference (enum: disabled, unrestricted, internal), tags (array[string]), username (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)
curl \
-X PATCH \
-H "Authorization: Bearer $TELNYX_API_KEY" \
-H "Content-Type: application/json" \
"https://api.telnyx.com/v2/credential_connections/550e8400-e29b-41d4-a716-446655440000"
Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), password (string), recordtype (string), rtcpsettings (object), sipuricallingpreference (enum: disabled, unrestricted, internal), tags (array[string]), updatedat (string), username (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeout_secs (integer | null)
Delete a credential connection
Deletes an existing credential connection.
DELETE /credential_connections/{id}
curl \
-X DELETE \
-H "Authorization: Bearer $TELNYX_API_KEY" \
"https://api.telnyx.com/v2/credential_connections/550e8400-e29b-41d4-a716-446655440000"
Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), password (string), recordtype (string), rtcpsettings (object), sipuricallingpreference (enum: disabled, unrestricted, internal), tags (array[string]), updatedat (string), username (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeout_secs (integer | null)
Check a Credential Connection Registration Status
Checks the registrationstatus for a credential connection, (registrationstatus) as well as the timestamp for the last SIP registration event (registrationstatusupdated_at)
POST /credentialconnections/{id}/actions/checkregistration_status
curl \
-X POST \
-H "Authorization: Bearer $TELNYX_API_KEY" \
-H "Content-Type: application/json" \
"https://api.telnyx.com/v2/credential_connections/550e8400-e29b-41d4-a716-446655440000/actions/check_registration_status"
Returns: ipaddress (string), lastregistration (string), port (integer), recordtype (string), sipusername (string), status (enum: Not Applicable, Not Registered, Failed, Expired, Registered, Unregistered), transport (string), user_agent (string)
List FQDN connections
Returns a list of your FQDN connections.
GET /fqdn_connections
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/fqdn_connections?sort=connection_name"
Returns: active (boolean), adjustdtmftimestamp (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostenabled (boolean), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), ignoredtmfduration (boolean), ignoremarkbit (boolean), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), microsoftteamssbc (boolean), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), password (string), recordtype (string), rtcpsettings (object), rtppasscodecsonstreamchange (boolean), sendnormalizedtimestamps (boolean), tags (array[string]), thirdpartycontrolenabled (boolean), transportprotocol (enum: UDP, TCP, TLS), txtname (string), txtttl (integer), txtvalue (string), updatedat (string), username (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)
Create an FQDN connection
Creates a FQDN connection.
POST /fqdnconnections — Required: connectionname
Optional: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), microsoftteamssbc (boolean), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), rtcpsettings (object), tags (array[string]), transportprotocol (enum: UDP, TCP, TLS), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)
curl \
-X POST \
-H "Authorization: Bearer $TELNYX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"connection_name": "office-connection"
}' \
"https://api.telnyx.com/v2/fqdn_connections"
Returns: active (boolean), adjustdtmftimestamp (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostenabled (boolean), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), ignoredtmfduration (boolean), ignoremarkbit (boolean), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), microsoftteamssbc (boolean), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), password (string), recordtype (string), rtcpsettings (object), rtppasscodecsonstreamchange (boolean), sendnormalizedtimestamps (boolean), tags (array[string]), thirdpartycontrolenabled (boolean), transportprotocol (enum: UDP, TCP, TLS), txtname (string), txtttl (integer), txtvalue (string), updatedat (string), username (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)
Retrieve an FQDN connection
Retrieves the details of an existing FQDN connection.
GET /fqdn_connections/{id}
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/fqdn_connections/1293384261075731499"
Returns: active (boolean), adjustdtmftimestamp (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostenabled (boolean), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), ignoredtmfduration (boolean), ignoremarkbit (boolean), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), microsoftteamssbc (boolean), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), password (string), recordtype (string), rtcpsettings (object), rtppasscodecsonstreamchange (boolean), sendnormalizedtimestamps (boolean), tags (array[string]), thirdpartycontrolenabled (boolean), transportprotocol (enum: UDP, TCP, TLS), txtname (string), txtttl (integer), txtvalue (string), updatedat (string), username (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)
Update an FQDN connection
Updates settings of an existing FQDN connection.
PATCH /fqdn_connections/{id}
Optional: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), rtcpsettings (object), tags (array[string]), transportprotocol (enum: UDP, TCP, TLS), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeout_secs (integer | null)
curl \
-X PATCH \
-H "Authorization: Bearer $TELNYX_API_KEY" \
-H "Content-Type: application/json" \
"https://api.telnyx.com/v2/fqdn_connections/1293384261075731499"
Returns: active (boolean), adjustdtmftimestamp (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostenabled (boolean), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), ignoredtmfduration (boolean), ignoremarkbit (boolean), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), microsoftteamssbc (boolean), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), password (string), recordtype (string), rtcpsettings (object), rtppasscodecsonstreamchange (boolean), sendnormalizedtimestamps (boolean), tags (array[string]), thirdpartycontrolenabled (boolean), transportprotocol (enum: UDP, TCP, TLS), txtname (string), txtttl (integer), txtvalue (string), updatedat (string), username (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)
Delete an FQDN connection
Deletes an FQDN connection.
DELETE /fqdn_connections/{id}
curl \
-X DELETE \
-H "Authorization: Bearer $TELNYX_API_KEY" \
"https://api.telnyx.com/v2/fqdn_connections/1293384261075731499"
Returns: active (boolean), adjustdtmftimestamp (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostenabled (boolean), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), ignoredtmfduration (boolean), ignoremarkbit (boolean), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), microsoftteamssbc (boolean), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), password (string), recordtype (string), rtcpsettings (object), rtppasscodecsonstreamchange (boolean), sendnormalizedtimestamps (boolean), tags (array[string]), thirdpartycontrolenabled (boolean), transportprotocol (enum: UDP, TCP, TLS), txtname (string), txtttl (integer), txtvalue (string), updatedat (string), username (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)
List FQDNs
Get all FQDNs belonging to the user that match the given filters.
GET /fqdns
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/fqdns"
Returns: connectionid (string), createdat (string), dnsrecordtype (string), fqdn (string), id (string), port (integer), recordtype (string), updatedat (string)
Create an FQDN
Create a new FQDN object.
POST /fqdns — Required: fqdn, dnsrecordtype, connection_id
Optional: port (integer | null)
curl \
-X POST \
-H "Authorization: Bearer $TELNYX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"connection_id": "550e8400-e29b-41d4-a716-446655440000",
"fqdn": "example.com",
"dns_record_type": "a"
}' \
"https://api.telnyx.com/v2/fqdns"
Returns: connectionid (string), createdat (string), dnsrecordtype (string), fqdn (string), id (string), port (integer), recordtype (string), updatedat (string)
Retrieve an FQDN
Return the details regarding a specific FQDN.
GET /fqdns/{id}
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/fqdns/1517907029795014409"
Returns: connectionid (string), createdat (string), dnsrecordtype (string), fqdn (string), id (string), port (integer), recordtype (string), updatedat (string)
Update an FQDN
Update the details of a specific FQDN.
PATCH /fqdns/{id}
Optional: connectionid (string), dnsrecord_type (string), fqdn (string), port (integer | null)
curl \
-X PATCH \
-H "Authorization: Bearer $TELNYX_API_KEY" \
-H "Content-Type: application/json" \
"https://api.telnyx.com/v2/fqdns/1517907029795014409"
Returns: connectionid (string), createdat (string), dnsrecordtype (string), fqdn (string), id (string), port (integer), recordtype (string), updatedat (string)
Delete an FQDN
Delete an FQDN.
DELETE /fqdns/{id}
curl \
-X DELETE \
-H "Authorization: Bearer $TELNYX_API_KEY" \
"https://api.telnyx.com/v2/fqdns/1517907029795014409"
Returns: connectionid (string), createdat (string), dnsrecordtype (string), fqdn (string), id (string), port (integer), recordtype (string), updatedat (string)
List Ip connections
Returns a list of your IP connections.
GET /ip_connections
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ip_connections?sort=connection_name"
Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), recordtype (string), rtcpsettings (object), tags (array[string]), transportprotocol (enum: UDP, TCP, TLS), updatedat (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)
Create an Ip connection
Creates an IP connection.
POST /ip_connections
Optional: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), rtcpsettings (object), tags (array[string]), transportprotocol (enum: UDP, TCP, TLS), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeout_secs (integer | null)
curl \
-X POST \
-H "Authorization: Bearer $TELNYX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"connection_name": "my-ip-connection"
}' \
"https://api.telnyx.com/v2/ip_connections"
Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), recordtype (string), rtcpsettings (object), tags (array[string]), transportprotocol (enum: UDP, TCP, TLS), updatedat (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)
Retrieve an Ip connection
Retrieves the details of an existing ip connection.
GET /ip_connections/{id}
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ip_connections/550e8400-e29b-41d4-a716-446655440000"
Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), recordtype (string), rtcpsettings (object), tags (array[string]), transportprotocol (enum: UDP, TCP, TLS), updatedat (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)
Update an Ip connection
Updates settings of an existing IP connection.
PATCH /ip_connections/{id}
Optional: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), rtcpsettings (object), tags (array[string]), transportprotocol (enum: UDP, TCP, TLS), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeout_secs (integer | null)
curl \
-X PATCH \
-H "Authorization: Bearer $TELNYX_API_KEY" \
-H "Content-Type: application/json" \
"https://api.telnyx.com/v2/ip_connections/550e8400-e29b-41d4-a716-446655440000"
Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), recordtype (string), rtcpsettings (object), tags (array[string]), transportprotocol (enum: UDP, TCP, TLS), updatedat (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)
Delete an Ip connection
Deletes an existing IP connection.
DELETE /ip_connections/{id}
curl \
-X DELETE \
-H "Authorization: Bearer $TELNYX_API_KEY" \
"https://api.telnyx.com/v2/ip_connections/550e8400-e29b-41d4-a716-446655440000"
Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), recordtype (string), rtcpsettings (object), tags (array[string]), transportprotocol (enum: UDP, TCP, TLS), updatedat (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)
List Ips
Get all IPs belonging to the user that match the given filters.
GET /ips
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ips"
Returns: connectionid (string), createdat (string), id (string), ipaddress (string), port (integer), recordtype (string), updated_at (string)
Create an Ip
Create a new IP object.
POST /ips — Required: ip_address
Optional: connection_id (string), port (integer)
curl \
-X POST \
-H "Authorization: Bearer $TELNYX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"ip_address": "192.168.0.0"
}' \
"https://api.telnyx.com/v2/ips"
Returns: connectionid (string), createdat (string), id (string), ipaddress (string), port (integer), recordtype (string), updated_at (string)
Retrieve an Ip
Return the details regarding a specific IP.
GET /ips/{id}
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ips/6a09cdc3-8948-47f0-aa62-74ac943d6c58"
Returns: connectionid (string), createdat (string), id (string), ipaddress (string), port (integer), recordtype (string), updated_at (string)
Update an Ip
Update the details of a specific IP.
PATCH /ips/{id} — Required: ip_address
Optional: connection_id (string), port (integer)
curl \
-X PATCH \
-H "Authorization: Bearer $TELNYX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"ip_address": "192.168.0.0"
}' \
"https://api.telnyx.com/v2/ips/6a09cdc3-8948-47f0-aa62-74ac943d6c58"
Returns: connectionid (string), createdat (string), id (string), ipaddress (string), port (integer), recordtype (string), updated_at (string)
Delete an Ip
Delete an IP.
DELETE /ips/{id}
curl \
-X DELETE \
-H "Authorization: Bearer $TELNYX_API_KEY" \
"https://api.telnyx.com/v2/ips/6a09cdc3-8948-47f0-aa62-74ac943d6c58"
Returns: connectionid (string), createdat (string), id (string), ipaddress (string), port (integer), recordtype (string), updated_at (string)
Get all outbound voice profiles
Get all outbound voice profiles belonging to the user that match the given filters.
GET /outboundvoiceprofiles
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/outbound_voice_profiles?sort=name"
Returns: billinggroupid (uuid), callrecording (object), callingwindow (object), concurrentcalllimit (integer | null), connectionscount (integer), createdat (string), dailyspendlimit (string), dailyspendlimitenabled (boolean), enabled (boolean), id (string), maxdestinationrate (number), name (string), recordtype (string), serviceplan (enum: global), tags (array[string]), traffictype (enum: conversational), updatedat (string), usagepaymentmethod (enum: rate-deck), whitelisteddestinations (array[string])
Create an outbound voice profile
Create an outbound voice profile.
POST /outboundvoiceprofiles — Required: name
Optional: billinggroupid (uuid), callrecording (object), callingwindow (object), concurrentcalllimit (integer | null), dailyspendlimit (string), dailyspendlimitenabled (boolean), enabled (boolean), maxdestinationrate (number), serviceplan (enum: global), tags (array[string]), traffictype (enum: conversational), usagepaymentmethod (enum: rate-deck), whitelisteddestinations (array[string])
curl \
-X POST \
-H "Authorization: Bearer $TELNYX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "office"
}' \
"https://api.telnyx.com/v2/outbound_voice_profiles"
Returns: billinggroupid (uuid), callrecording (object), callingwindow (object), concurrentcalllimit (integer | null), connectionscount (integer), createdat (string), dailyspendlimit (string), dailyspendlimitenabled (boolean), enabled (boolean), id (string), maxdestinationrate (number), name (string), recordtype (string), serviceplan (enum: global), tags (array[string]), traffictype (enum: conversational), updatedat (string), usagepaymentmethod (enum: rate-deck), whitelisteddestinations (array[string])
Retrieve an outbound voice profile
Retrieves the details of an existing outbound voice profile.
GET /outboundvoiceprofiles/{id}
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/outbound_voice_profiles/1293384261075731499"
Returns: billinggroupid (uuid), callrecording (object), callingwindow (object), concurrentcalllimit (integer | null), connectionscount (integer), createdat (string), dailyspendlimit (string), dailyspendlimitenabled (boolean), enabled (boolean), id (string), maxdestinationrate (number), name (string), recordtype (string), serviceplan (enum: global), tags (array[string]), traffictype (enum: conversational), updatedat (string), usagepaymentmethod (enum: rate-deck), whitelisteddestinations (array[string])
Updates an existing outbound voice profile.
PATCH /outboundvoiceprofiles/{id} — Required: name
Optional: billinggroupid (uuid), callrecording (object), callingwindow (object), concurrentcalllimit (integer | null), dailyspendlimit (string), dailyspendlimitenabled (boolean), enabled (boolean), maxdestinationrate (number), serviceplan (enum: global), tags (array[string]), traffictype (enum: conversational), usagepaymentmethod (enum: rate-deck), whitelisteddestinations (array[string])
curl \
-X PATCH \
-H "Authorization: Bearer $TELNYX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "office"
}' \
"https://api.telnyx.com/v2/outbound_voice_profiles/1293384261075731499"
Returns: billinggroupid (uuid), callrecording (object), callingwindow (object), concurrentcalllimit (integer | null), connectionscount (integer), createdat (string), dailyspendlimit (string), dailyspendlimitenabled (boolean), enabled (boolean), id (string), maxdestinationrate (number), name (string), recordtype (string), serviceplan (enum: global), tags (array[string]), traffictype (enum: conversational), updatedat (string), usagepaymentmethod (enum: rate-deck), whitelisteddestinations (array[string])
Delete an outbound voice profile
Deletes an existing outbound voice profile.
DELETE /outboundvoiceprofiles/{id}
curl \
-X DELETE \
-H "Authorization: Bearer $TELNYX_API_KEY" \
"https://api.telnyx.com/v2/outbound_voice_profiles/1293384261075731499"
Returns: billinggroupid (uuid), callrecording (object), callingwindow (object), concurrentcalllimit (integer | null), connectionscount (integer), createdat (string), dailyspendlimit (string), dailyspendlimitenabled (boolean), enabled (boolean), id (string), maxdestinationrate (number), name (string), recordtype (string), serviceplan (enum: global), tags (array[string]), traffictype (enum: conversational), updatedat (string), usagepaymentmethod (enum: rate-deck), whitelisteddestinations (array[string])