For AWS and GCE, you have the option of creating the primary connection first and the secondary connection later. You also have the option of disabling the primary and/or secondary connections at any time and later re-enabling them. With Azure, you do not have this option. Azure requires both the primary and secondary connections to be created at the same time and they can not be independantly disabled. # Delete a Virtual Cross Connect Source: https://developers.telnyx.com/api-reference/virtual-cross-connects/delete-a-virtual-cross-connect https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/networking/networking.yml delete /virtual_cross_connects/{id} Delete a Virtual Cross Connect. # List all Virtual Cross Connects Source: https://developers.telnyx.com/api-reference/virtual-cross-connects/list-all-virtual-cross-connects https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/networking/networking.yml get /virtual_cross_connects List all Virtual Cross Connects. # List Virtual Cross Connect Cloud Coverage Source: https://developers.telnyx.com/api-reference/virtual-cross-connects/list-virtual-cross-connect-cloud-coverage https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/networking/networking.yml get /virtual_cross_connects/coverage List Virtual Cross Connects Cloud Coverage.
This endpoint shows which cloud regions are available for the `location_code` your Virtual Cross Connect will be provisioned in. # Retrieve a Virtual Cross Connect Source: https://developers.telnyx.com/api-reference/virtual-cross-connects/retrieve-a-virtual-cross-connect https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/networking/networking.yml get /virtual_cross_connects/{id} Retrieve a Virtual Cross Connect. # Update the Virtual Cross Connect Source: https://developers.telnyx.com/api-reference/virtual-cross-connects/update-the-virtual-cross-connect https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/networking/networking.yml patch /virtual_cross_connects/{id} Update the Virtual Cross Connect.
Cloud IPs can only be patched during the `created` state, as GCE will only inform you of your generated IP once the pending connection requested has been accepted. Once the Virtual Cross Connect has moved to `provisioning`, the IPs can no longer be patched.
Once the Virtual Cross Connect has moved to `provisioned` and you are ready to enable routing, you can toggle the routing announcements to `true`. # List All Numbers using Channel Billing Source: https://developers.telnyx.com/api-reference/voice-channels/list-all-numbers-using-channel-billing https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/numbers-identity/voice-channels.yml get /list Retrieve a list of all phone numbers using Channel Billing, grouped by Zone. # List Numbers using Channel Billing for a specific Zone Source: https://developers.telnyx.com/api-reference/voice-channels/list-numbers-using-channel-billing-for-a-specific-zone https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/numbers-identity/voice-channels.yml get /list/{channel_zone_id} Retrieve a list of phone numbers using Channel Billing for a specific Zone. # List your voice channels for non-US zones Source: https://developers.telnyx.com/api-reference/voice-channels/list-your-voice-channels-for-non-us-zones https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/numbers-identity/voice-channels.yml get /channel_zones Returns the non-US voice channels for your account. voice channels allow you to use Channel Billing for calls to your Telnyx phone numbers. Please check the Telnyx Support Articles section for full information and examples of how to utilize Channel Billing. # List your voice channels for US Zone Source: https://developers.telnyx.com/api-reference/voice-channels/list-your-voice-channels-for-us-zone https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/numbers-identity/voice-channels.yml get /inbound_channels Returns the US Zone voice channels for your account. voice channels allows you to use Channel Billing for calls to your Telnyx phone numbers. Please check the Telnyx Support Articles section for full information and examples of how to utilize Channel Billing. # Update voice channels for non-US Zones Source: https://developers.telnyx.com/api-reference/voice-channels/update-voice-channels-for-non-us-zones https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/numbers-identity/voice-channels.yml put /channel_zones/{channel_zone_id} Update the number of Voice Channels for the Non-US Zones. This allows your account to handle multiple simultaneous inbound calls to Non-US numbers. Use this endpoint to increase or decrease your capacity based on expected call volume. # Update voice channels for US Zone Source: https://developers.telnyx.com/api-reference/voice-channels/update-voice-channels-for-us-zone https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/numbers-identity/voice-channels.yml patch /inbound_channels Update the number of Voice Channels for the US Zone. This allows your account to handle multiple simultaneous inbound calls to US numbers. Use this endpoint to increase or decrease your capacity based on expected call volume. # Create a voice clone from a voice design Source: https://developers.telnyx.com/api-reference/voice-clones/create-a-voice-clone-from-a-voice-design /openapi/voice-clones.yml post /voice_clones Creates a new voice clone by capturing the voice identity of an existing voice design. The clone can then be used for text-to-speech synthesis. # Create a voice clone from an audio file upload Source: https://developers.telnyx.com/api-reference/voice-clones/create-a-voice-clone-from-an-audio-file-upload /openapi/voice-clones.yml post /voice_clones/from_upload Creates a new voice clone by uploading an audio file directly. Supported formats: WAV, MP3, FLAC, OGG, M4A. For best results, provide 5–10 seconds of clear speech. Maximum file size: 2MB. # Delete a voice clone Source: https://developers.telnyx.com/api-reference/voice-clones/delete-a-voice-clone /openapi/voice-clones.yml delete /voice_clones/{id} Permanently deletes a voice clone. This action cannot be undone. # Download voice clone audio sample Source: https://developers.telnyx.com/api-reference/voice-clones/download-voice-clone-audio-sample /openapi/voice-clones.yml get /voice_clones/{id}/sample Downloads the WAV audio sample that was used to create the voice clone. # List voice clones Source: https://developers.telnyx.com/api-reference/voice-clones/list-voice-clones /openapi/voice-clones.yml get /voice_clones Returns a paginated list of voice clones belonging to the authenticated account. # Update a voice clone Source: https://developers.telnyx.com/api-reference/voice-clones/update-a-voice-clone /openapi/voice-clones.yml patch /voice_clones/{id} Updates the name, language, or gender of a voice clone. # Create or add a version to a voice design Source: https://developers.telnyx.com/api-reference/voice-designs/create-or-add-a-version-to-a-voice-design /openapi/voice-designs.yml post /voice_designs Creates a new voice design (version 1) when `voice_design_id` is omitted. When `voice_design_id` is provided, adds a new version to the existing design instead. A design can have at most 50 versions. # Delete a specific version of a voice design Source: https://developers.telnyx.com/api-reference/voice-designs/delete-a-specific-version-of-a-voice-design /openapi/voice-designs.yml delete /voice_designs/{id}/versions/{version} Permanently deletes a specific version of a voice design. The version number must be a positive integer. # Delete a voice design Source: https://developers.telnyx.com/api-reference/voice-designs/delete-a-voice-design /openapi/voice-designs.yml delete /voice_designs/{id} Permanently deletes a voice design and all of its versions. This action cannot be undone. # Download voice design audio sample Source: https://developers.telnyx.com/api-reference/voice-designs/download-voice-design-audio-sample /openapi/voice-designs.yml get /voice_designs/{id}/sample Downloads the WAV audio sample for the voice design. Returns the latest version's sample by default, or a specific version when `?version=N` is provided. The `id` parameter accepts either a UUID or the design name. # Get a voice design Source: https://developers.telnyx.com/api-reference/voice-designs/get-a-voice-design /openapi/voice-designs.yml get /voice_designs/{id} Returns the latest version of a voice design, or a specific version when `?version=N` is provided. The `id` parameter accepts either a UUID or the design name. # List voice designs Source: https://developers.telnyx.com/api-reference/voice-designs/list-voice-designs /openapi/voice-designs.yml get /voice_designs Returns a paginated list of voice designs belonging to the authenticated account. # Rename a voice design Source: https://developers.telnyx.com/api-reference/voice-designs/rename-a-voice-design /openapi/voice-designs.yml patch /voice_designs/{id} Updates the name of a voice design. All versions retain their other properties. # Create voicemail Source: https://developers.telnyx.com/api-reference/voicemail/create-voicemail https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/numbers-identity/voicemail.yml post /phone_numbers/{phone_number_id}/voicemail Create voicemail settings for a phone number # Get voicemail Source: https://developers.telnyx.com/api-reference/voicemail/get-voicemail https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/numbers-identity/voicemail.yml get /phone_numbers/{phone_number_id}/voicemail Returns the voicemail settings for a phone number # Update voicemail Source: https://developers.telnyx.com/api-reference/voicemail/update-voicemail https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/numbers-identity/voicemail.yml patch /phone_numbers/{phone_number_id}/voicemail Update voicemail settings for a phone number # Fetches all Wdr records Source: https://developers.telnyx.com/api-reference/wdr-detail-reports/fetches-all-wdr-records https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/account-billing/usage-reports.yml get /reports/wdrs Fetch all Wdr records # Find webhook_delivery details by ID Source: https://developers.telnyx.com/api-reference/webhooks/find-webhook_delivery-details-by-id https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/account-billing/webhooks.yml get /webhook_deliveries/{id} Provides webhook_delivery debug data, such as timestamps, delivery status and attempts. # List webhook deliveries Source: https://developers.telnyx.com/api-reference/webhooks/list-webhook-deliveries https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/account-billing/webhooks.yml get /webhook_deliveries Lists webhook_deliveries for the authenticated user # Stream call media over WebSocket Source: https://developers.telnyx.com/api-reference/websockets/stream-call-media-over-websocket AsyncAPI specification for the Telnyx Media Streaming WebSocket connection. Media Streaming forks call media and delivers it to a customer-provided WebSocket URL configured through Call Control using `stream_url`. Telnyx opens the WebSocket connection, sends lifecycle and media frames, and can receive bidirectional media playback commands from the connected application. ## Connection Flow 1. Start media streaming with a Call Control command and provide `stream_url`. 2. Telnyx opens a WebSocket connection to the configured `stream_url`. 3. Telnyx sends a `connected` frame, followed by a `start` frame that identifies the call and media format. 4. Telnyx sends `media` frames with base64-encoded RTP payloads for the requested track or tracks. 5. If bidirectional streaming is enabled, the connected application can send `media`, `mark`, and `clear` frames back to Telnyx. 6. Telnyx sends `dtmf`, `mark`, `error`, and `stop` frames as applicable. ## Bidirectional Media Bidirectional streaming is enabled through Call Control by setting `stream_bidirectional_mode` to `rtp` for RTP payloads, or by sending base64-encoded MP3 media frames for media-file playback. RTP media chunks sent back to Telnyx can contain 20 milliseconds to 30 seconds of audio. MP3 media frames are queued and played in submission order, with a one-message-per-second rate limit. ## Ordering Media frame order is not guaranteed. Use `media.chunk`, `media.timestamp`, and `sequence_number` to order frames when required. # Stream speech to text over WebSocket Source: https://developers.telnyx.com/api-reference/websockets/stream-speech-to-text-over-websocket AsyncAPI specification for the Telnyx Speech-to-Text WebSocket endpoint. Real-time speech transcription by streaming audio and receiving transcript frames. ## Supported Engines - `Azure` - Microsoft Azure Speech Services - `Deepgram` - Deepgram Nova models - `Google` - Google Cloud Speech-to-Text - `Telnyx` - Telnyx native transcription (OpenAI Whisper models) - `xAI` - xAI Grok STT - `AssemblyAI` - AssemblyAI Universal-Streaming ## Connection Flow 1. Open WebSocket connection to `wss://api.telnyx.com/v2/speech-to-text/transcription` with query parameters. 2. Send binary audio frames (mp3 or wav format). 3. Receive JSON transcript frames with `transcript`, `is_final`, and `confidence` fields. 4. Close connection when done. ## Authentication Requires authentication via a Bearer token (Telnyx API v2 key). # Stream text to speech over WebSocket Source: https://developers.telnyx.com/api-reference/websockets/stream-text-to-speech-over-websocket AsyncAPI specification for the Telnyx Text-to-Speech WebSocket endpoint. Real-time speech synthesis by streaming text and receiving audio chunks. ## Supported Providers - `telnyx` - Telnyx native voices (Natural, NaturalHD, Qwen3TTS) - `aws` - Amazon Polly - `azure` - Microsoft Azure TTS - `elevenlabs` - ElevenLabs voices - `minimax` - MiniMax voices - `rime` - Rime voices - `resemble` - Resemble AI voices - `xai` - xAI voices (Eve, Ara, Rex, Sal, Leo) - `inworld` - Inworld AI voices ## Connection Flow 1. Open WebSocket connection to `wss://api.telnyx.com/v2/text-to-speech/speech` with query parameters. 2. Send an initial handshake message `{"text": " "}` (single space) with optional `voice_settings`. 3. Send text messages as `{"text": "Hello world"}`. 4. Receive audio chunks as JSON frames with base64-encoded audio. 5. A final frame with `isFinal: true` indicates the end of audio for the current text. ## Authentication Requires authentication via a Bearer token (Telnyx API v2 key). # Delete a Whatsapp Business Account Source: https://developers.telnyx.com/api-reference/whatsapp-business-accounts/delete-a-whatsapp-business-account https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/whatsapp/management.yml delete /whatsapp/business_accounts/{id} # Get a single Whatsapp Business Account Source: https://developers.telnyx.com/api-reference/whatsapp-business-accounts/get-a-single-whatsapp-business-account https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/whatsapp/management.yml get /whatsapp/business_accounts/{id} # Get WABA settings Source: https://developers.telnyx.com/api-reference/whatsapp-business-accounts/get-waba-settings https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/whatsapp/management.yml get /whatsapp/business_accounts/{id}/settings # List phone numbers for a WABA Source: https://developers.telnyx.com/api-reference/whatsapp-business-accounts/list-phone-numbers-for-a-waba https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/whatsapp/management.yml get /whatsapp/business_accounts/{id}/phone_numbers # List Whatsapp Business Accounts Source: https://developers.telnyx.com/api-reference/whatsapp-business-accounts/list-whatsapp-business-accounts https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/whatsapp/management.yml get /whatsapp/business_accounts # Update WABA settings Source: https://developers.telnyx.com/api-reference/whatsapp-business-accounts/update-waba-settings https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/whatsapp/management.yml patch /whatsapp/business_accounts/{id}/settings # Create a Whatsapp message template Source: https://developers.telnyx.com/api-reference/whatsapp-message-templates/create-a-whatsapp-message-template https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/whatsapp/management.yml post /whatsapp/message_templates # Delete a Whatsapp message template Source: https://developers.telnyx.com/api-reference/whatsapp-message-templates/delete-a-whatsapp-message-template https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/whatsapp/management.yml delete /whatsapp/message_templates/{id} # Get a Whatsapp message template by ID Source: https://developers.telnyx.com/api-reference/whatsapp-message-templates/get-a-whatsapp-message-template-by-id https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/whatsapp/management.yml get /whatsapp/message_templates/{id} # List Whatsapp message templates Source: https://developers.telnyx.com/api-reference/whatsapp-message-templates/list-whatsapp-message-templates https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/whatsapp/management.yml get /whatsapp/message_templates # Update a Whatsapp message template Source: https://developers.telnyx.com/api-reference/whatsapp-message-templates/update-a-whatsapp-message-template https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/whatsapp/management.yml patch /whatsapp/message_templates/{id} # Send a Whatsapp message Source: https://developers.telnyx.com/api-reference/whatsapp-messaging/send-a-whatsapp-message https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/messaging/messages.yml post /messages/whatsapp # Delete a Whatsapp phone number Source: https://developers.telnyx.com/api-reference/whatsapp-phone-numbers/delete-a-whatsapp-phone-number https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/whatsapp/management.yml delete /whatsapp/phone_numbers/{phone_number} # Delete Whatsapp profile photo Source: https://developers.telnyx.com/api-reference/whatsapp-phone-numbers/delete-whatsapp-profile-photo https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/whatsapp/management.yml delete /whatsapp/phone_numbers/{phone_number}/profile/photo # Enable or disable Whatsapp calling for a phone number Source: https://developers.telnyx.com/api-reference/whatsapp-phone-numbers/enable-or-disable-whatsapp-calling-for-a-phone-number https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/whatsapp/management.yml patch /whatsapp/phone_numbers/{phone_number}/calling_settings # Get calling settings for a phone number Source: https://developers.telnyx.com/api-reference/whatsapp-phone-numbers/get-calling-settings-for-a-phone-number https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/whatsapp/management.yml get /whatsapp/phone_numbers/{phone_number}/calling_settings # Get phone number business profile Source: https://developers.telnyx.com/api-reference/whatsapp-phone-numbers/get-phone-number-business-profile https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/whatsapp/management.yml get /whatsapp/phone_numbers/{phone_number}/profile # Get Whatsapp profile photo Source: https://developers.telnyx.com/api-reference/whatsapp-phone-numbers/get-whatsapp-profile-photo https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/whatsapp/management.yml get /whatsapp/phone_numbers/{phone_number}/profile/photo # Initialize Whatsapp phone number verification Source: https://developers.telnyx.com/api-reference/whatsapp-phone-numbers/initialize-whatsapp-phone-number-verification https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/whatsapp/management.yml post /whatsapp/business_accounts/{id}/phone_numbers # List Whatsapp phone numbers Source: https://developers.telnyx.com/api-reference/whatsapp-phone-numbers/list-whatsapp-phone-numbers https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/whatsapp/management.yml get /whatsapp/phone_numbers # Resend verification code Source: https://developers.telnyx.com/api-reference/whatsapp-phone-numbers/resend-verification-code https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/whatsapp/management.yml post /whatsapp/phone_numbers/{phone_number}/resend_verification # Submit verification code for a phone number Source: https://developers.telnyx.com/api-reference/whatsapp-phone-numbers/submit-verification-code-for-a-phone-number https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/whatsapp/management.yml post /whatsapp/phone_numbers/{phone_number}/verify # Update phone number business profile Source: https://developers.telnyx.com/api-reference/whatsapp-phone-numbers/update-phone-number-business-profile https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/whatsapp/management.yml patch /whatsapp/phone_numbers/{phone_number}/profile # Upload Whatsapp profile photo Source: https://developers.telnyx.com/api-reference/whatsapp-phone-numbers/upload-whatsapp-profile-photo https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/whatsapp/management.yml post /whatsapp/phone_numbers/{phone_number}/profile/photo # Create a WireGuard Interface Source: https://developers.telnyx.com/api-reference/wireguard-interfaces/create-a-wireguard-interface https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/networking/networking.yml post /wireguard_interfaces Create a new WireGuard Interface. Current limitation of 10 interfaces per user can be created. # Create a WireGuard Peer Source: https://developers.telnyx.com/api-reference/wireguard-interfaces/create-a-wireguard-peer https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/networking/networking.yml post /wireguard_peers Create a new WireGuard Peer. Current limitation of 5 peers per interface can be created. # Delete a WireGuard Interface Source: https://developers.telnyx.com/api-reference/wireguard-interfaces/delete-a-wireguard-interface https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/networking/networking.yml delete /wireguard_interfaces/{id} Delete a WireGuard Interface. # Delete the WireGuard Peer Source: https://developers.telnyx.com/api-reference/wireguard-interfaces/delete-the-wireguard-peer https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/networking/networking.yml delete /wireguard_peers/{id} Delete the WireGuard peer. # List all WireGuard Interfaces Source: https://developers.telnyx.com/api-reference/wireguard-interfaces/list-all-wireguard-interfaces https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/networking/networking.yml get /wireguard_interfaces List all WireGuard Interfaces. # List all WireGuard Peers Source: https://developers.telnyx.com/api-reference/wireguard-interfaces/list-all-wireguard-peers https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/networking/networking.yml get /wireguard_peers List all WireGuard peers. # Retrieve a WireGuard Interfaces Source: https://developers.telnyx.com/api-reference/wireguard-interfaces/retrieve-a-wireguard-interfaces https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/networking/networking.yml get /wireguard_interfaces/{id} Retrieve a WireGuard Interfaces. # Retrieve the WireGuard Peer Source: https://developers.telnyx.com/api-reference/wireguard-interfaces/retrieve-the-wireguard-peer https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/networking/networking.yml get /wireguard_peers/{id} Retrieve the WireGuard peer. # Retrieve Wireguard config template for Peer Source: https://developers.telnyx.com/api-reference/wireguard-interfaces/retrieve-wireguard-config-template-for-peer https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/networking/networking.yml get /wireguard_peers/{id}/config Retrieve Wireguard config template for Peer # Update the WireGuard Peer Source: https://developers.telnyx.com/api-reference/wireguard-interfaces/update-the-wireguard-peer https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/networking/networking.yml patch /wireguard_peers/{id} Update the WireGuard peer. # Create a Wireless Blocklist Source: https://developers.telnyx.com/api-reference/wireless-blocklists/create-a-wireless-blocklist https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/wireless/sim-cards-configuration.yml post /wireless_blocklists Create a Wireless Blocklist to prevent SIMs from connecting to certain networks. # Delete a Wireless Blocklist Source: https://developers.telnyx.com/api-reference/wireless-blocklists/delete-a-wireless-blocklist https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/wireless/sim-cards-configuration.yml delete /wireless_blocklists/{id} Deletes the Wireless Blocklist. # Get a Wireless Blocklist Source: https://developers.telnyx.com/api-reference/wireless-blocklists/get-a-wireless-blocklist https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/wireless/sim-cards-configuration.yml get /wireless_blocklists/{id} Retrieve information about a Wireless Blocklist. # Get all possible wireless blocklist values Source: https://developers.telnyx.com/api-reference/wireless-blocklists/get-all-possible-wireless-blocklist-values https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/wireless/sim-cards-configuration.yml get /wireless_blocklist_values Retrieve all wireless blocklist values for a given blocklist type. # Get all Wireless Blocklists Source: https://developers.telnyx.com/api-reference/wireless-blocklists/get-all-wireless-blocklists https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/wireless/sim-cards-configuration.yml get /wireless_blocklists Get all Wireless Blocklists belonging to the user. # Update a Wireless Blocklist Source: https://developers.telnyx.com/api-reference/wireless-blocklists/update-a-wireless-blocklist https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/wireless/sim-cards-configuration.yml patch /wireless_blocklists/{id} Update a Wireless Blocklist. # Agent Skills Source: https://developers.telnyx.com/development/agent-skills/index Agent Skills enable Claude Code and other AI coding agents to build Telnyx integrations using natural language. They support all 36 Telnyx products including Messaging, Voice, Numbers, IoT, and AI. ## Installation Quickstart Choose your setup method:
| Field | Value |
| record\_type | Description of the record. |
| event\_type | The type of event detected by the Telnyx system |
| id | unique id for the webhook |
| occurred\_at | ISO-8601 datetime of when event occured |
| call\_control\_id | call id used to issue commands via Voice API |
| connection\_id | Voice API App ID (formerly Telnyx connection ID) used in the call. |
| call\_leg\_id | ID that is unique to the call and can be used to correlate webhook events |
| call\_session\_id | ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. |
| client\_state | State received from a command |
| from | Number or SIP URI placing the call |
| to | Destination number or SIP URI of the call |
| direction | Whether the call is 'incoming' or 'outgoing' |
| state | Whether the call is in 'bridging' or 'parked' state |
Dig into API fundamentals →
Browse SDKs →
Explore WebRTC →
Get the toolkit →
Start debugging →
Plan your migration →
\`json:"...,required"\`. These
fields are always serialized, even their zero values.
Optional primitive types are wrapped in a `param.Opt[T]`. These fields can be set with the provided constructors, `telnyx.String(string)`, `telnyx.Int(int64)`, etc.
Any `param.Opt[T]`, map, slice, struct or string enum uses the
tag \`json:"...,omitzero"\`. Its zero value is considered omitted.
The `param.IsOmitted(any)` function can confirm the presence of any `omitzero` field.
```go theme={null}
p := telnyx.ExampleParams{
ID: "id_xxx", // required property
Name: telnyx.String("..."), // optional property
Point: telnyx.Point{
X: 0, // required field will serialize as 0
Y: telnyx.Int(1), // optional field will serialize as 1
// ... omitted non-required fields will not be serialized
},
Origin: telnyx.Origin{}, // the zero value of [Origin] is considered omitted
}
```
To send `null` instead of a `param.Opt[T]`, use `param.Null[T]()`.
To send `null` instead of a struct `T`, use `param.NullStruct[T]()`.
```go theme={null}
p.Name = param.Null[string]() // 'null' instead of string
p.Point = param.NullStruct[Point]() // 'null' instead of struct
param.IsNull(p.Name) // true
param.IsNull(p.Point) // true
```
Request structs contain a `.SetExtraFields(map[string]any)` method which can send non-conforming
fields in the request body. Extra fields overwrite any struct fields with a matching
key. For security reasons, only use `SetExtraFields` with trusted data.
To send a custom value instead of a struct, use `param.Override[T](https://github.com/team-telnyx/telnyx-go/tree/master/value)`.
```go theme={null}
// In cases where the API specifies a given type,
// but you want to send something else, use [SetExtraFields]:
p.SetExtraFields(map[string]any{
"x": 0.01, // send "x" as a float instead of int
})
// Send a number instead of an object
custom := param.Override[telnyx.FooParams](https://github.com/team-telnyx/telnyx-go/tree/master/12)
```
### Request unions
Unions are represented as a struct with fields prefixed by "Of" for each of it's variants,
only one field can be non-zero. The non-zero field will be serialized.
Sub-properties of the union can be accessed via methods on the union struct.
These methods return a mutable pointer to the underlying data, if present.
```go theme={null}
// Only one field can be non-zero, use param.IsOmitted() to check if a field is set
type AnimalUnionParam struct {
OfCat *Cat `json:",omitzero,inline`
OfDog *Dog `json:",omitzero,inline`
}
animal := AnimalUnionParam{
OfCat: &Cat{
Name: "Whiskers",
Owner: PersonParam{
Address: AddressParam{Street: "3333 Coyote Hill Rd", Zip: 0},
},
},
}
// Mutating a field
if address := animal.GetOwner().GetAddress(); address != nil {
address.ZipCode = 94304
}
```
### Response objects
All fields in response structs are ordinary value types (not pointers or wrappers).
Response structs also include a special `JSON` field containing metadata about
each property.
```go theme={null}
type Animal struct {
Name string `json:"name,nullable"`
Owners int `json:"owners"`
Age int `json:"age"`
JSON struct {
Name respjson.Field
Owner respjson.Field
Age respjson.Field
ExtraFields map[string]respjson.Field
} `json:"-"`
}
```
To handle optional data, use the `.Valid()` method on the JSON field.
`.Valid()` returns true if a field is not `null`, not present, or couldn't be marshaled.
If `.Valid()` is false, the corresponding field will simply be its zero value.
```go theme={null}
raw := `{"owners": 1, "name": null}`
var res Animal
json.Unmarshal([]byte(raw), &res)
// Accessing regular fields
res.Owners // 1
res.Name // ""
res.Age // 0
// Optional field checks
res.JSON.Owners.Valid() // true
res.JSON.Name.Valid() // false
res.JSON.Age.Valid() // false
// Raw JSON values
res.JSON.Owners.Raw() // "1"
res.JSON.Name.Raw() == "null" // true
res.JSON.Name.Raw() == respjson.Null // true
res.JSON.Age.Raw() == "" // true
res.JSON.Age.Raw() == respjson.Omitted // true
```
These `.JSON` structs also include an `ExtraFields` map containing
any properties in the json response that were not specified
in the struct. This can be useful for API features not yet
present in the SDK.
```go theme={null}
body := res.JSON.ExtraFields["my_unexpected_field"].Raw()
```
### Response Unions
In responses, unions are represented by a flattened struct containing all possible fields from each of the
object variants.
To convert it to a variant use the `.AsFooVariant()` method or the `.AsAny()` method if present.
If a response value union contains primitive values, primitive fields will be alongside
the properties but prefixed with `Of` and feature the tag `json:"...,inline"`.
```go theme={null}
type AnimalUnion struct {
// From variants [Dog], [Cat]
Owner Person `json:"owner"`
// From variant [Dog]
DogBreed string `json:"dog_breed"`
// From variant [Cat]
CatBreed string `json:"cat_breed"`
// ...
JSON struct {
Owner respjson.Field
// ...
} `json:"-"`
}
// If animal variant
if animal.Owner.Address.ZipCode == "" {
panic("missing zip code")
}
// Switch on the variant
switch variant := animal.AsAny().(type) {
case Dog:
case Cat:
default:
panic("unexpected type")
}
```
### RequestOptions
This library uses the functional options pattern. Functions defined in the
`option` package return a `RequestOption`, which is a closure that mutates a
`RequestConfig`. These options can be supplied to the client or at individual
requests. For example:
```go theme={null}
client := telnyx.NewClient(
// Adds a header to every request made by the client
option.WithHeader("X-Some-Header", "custom_header_info"),
)
client.NumberOrders.New(context.TODO(), ...,
// Override the header
option.WithHeader("X-Some-Header", "some_other_custom_header_info"),
// Add an undocumented field to the request body, using sjson syntax
option.WithJSONSet("some.json.path", map[string]string{"my": "object"}),
)
```
The request option `option.WithDebugLog(nil)` may be helpful while debugging.
See the [full list of request options](https://pkg.go.dev/github.com/team-telnyx/telnyx-go/option).
### Pagination
This library provides some conveniences for working with paginated list endpoints.
You can use `.ListAutoPaging()` methods to iterate through items across all pages:
Or you can use simple `.List()` methods to fetch a single page and receive a standard response object
with additional helper methods like `.GetNextPage()`, e.g.:
### Errors
When the API returns a non-success status code, we return an error with type
`*telnyx.Error`. This contains the `StatusCode`, `*http.Request`, and
`*http.Response` values of the request, as well as the JSON of the error body
(much like other response objects in the SDK).
To handle errors, we recommend that you use the `errors.As` pattern:
```go theme={null}
_, err := client.NumberOrders.New(context.TODO(), telnyx.NumberOrderNewParams{
PhoneNumbers: []telnyx.NumberOrderNewParamsPhoneNumber{{
PhoneNumber: "+15558675309",
}},
})
if err != nil {
var apierr *telnyx.Error
if errors.As(err, &apierr) {
println(string(apierr.DumpRequest(true))) // Prints the serialized HTTP request
println(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response
}
panic(err.Error()) // GET "/number_orders": 400 Bad Request { ... }
}
```
When other errors occur, they are returned unwrapped; for example,
if HTTP transport fails, you might receive `*url.Error` wrapping `*net.OpError`.
### Timeouts
Requests do not time out by default; use context to configure a timeout for a request lifecycle.
Note that if a request is [retried](#retries), the context timeout does not start over.
To set a per-retry timeout, use `option.WithRequestTimeout()`.
```go theme={null}
// This sets the timeout for the request, including all the retries.
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
defer cancel()
client.NumberOrders.New(
ctx,
telnyx.NumberOrderNewParams{
PhoneNumbers: []telnyx.NumberOrderNewParamsPhoneNumber{{
PhoneNumber: "+15558675309",
}},
},
// This sets the per-retry timeout
option.WithRequestTimeout(20*time.Second),
)
```
### File uploads
Request parameters that correspond to file uploads in multipart requests are typed as
`io.Reader`. The contents of the `io.Reader` will by default be sent as a multipart form
part with the file name of "anonymous\_file" and content-type of "application/octet-stream".
The file name and content-type can be customized by implementing `Name() string` or `ContentType()
string` on the run-time type of `io.Reader`. Note that `os.File` implements `Name() string`, so a
file returned by `os.Open` will be sent with the file name on disk.
We also provide a helper `telnyx.File(reader io.Reader, filename string, contentType string)`
which can be used to wrap any `io.Reader` with the appropriate file name and content type.
```go theme={null}
// A file from the file system
file, err := os.Open("/path/to/file")
telnyx.AIAudioTranscribeParams{
Model: telnyx.AIAudioTranscribeParamsModelDistilWhisperDistilLargeV2,
File: file,
}
// A file from a string
telnyx.AIAudioTranscribeParams{
Model: telnyx.AIAudioTranscribeParamsModelDistilWhisperDistilLargeV2,
File: strings.NewReader("my file contents"),
}
// With a custom filename and contentType
telnyx.AIAudioTranscribeParams{
Model: telnyx.AIAudioTranscribeParamsModelDistilWhisperDistilLargeV2,
File: telnyx.File(strings.NewReader(`{"hello": "foo"}`), "file.go", "application/json"),
}
```
### Retries
Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
We retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit,
and >=500 Internal errors.
You can use the `WithMaxRetries` option to configure or disable this:
```go theme={null}
// Configure the default for all requests:
client := telnyx.NewClient(
option.WithMaxRetries(0), // default is 2
)
// Override per-request:
client.NumberOrders.New(
context.TODO(),
telnyx.NumberOrderNewParams{
PhoneNumbers: []telnyx.NumberOrderNewParamsPhoneNumber{{
PhoneNumber: "+15558675309",
}},
},
option.WithMaxRetries(5),
)
```
### Accessing raw response data (e.g. response headers)
You can access the raw HTTP response data by using the `option.WithResponseInto()` request option. This is useful when
you need to examine response headers, status codes, or other details.
```go theme={null}
// Create a variable to store the HTTP response
var response *http.Response
numberOrder, err := client.NumberOrders.New(
context.TODO(),
telnyx.NumberOrderNewParams{
PhoneNumbers: []telnyx.NumberOrderNewParamsPhoneNumber{{
PhoneNumber: "+15558675309",
}},
},
option.WithResponseInto(&response),
)
if err != nil {
// handle error
}
fmt.Printf("%+v\n", numberOrder)
fmt.Printf("Status Code: %d\n", response.StatusCode)
fmt.Printf("Headers: %+#v\n", response.Header)
```
### Making custom/undocumented requests
This library is typed for convenient access to the documented API. If you need to access undocumented
endpoints, params, or response properties, the library can still be used.
#### Undocumented endpoints
To make requests to undocumented endpoints, you can use `client.Get`, `client.Post`, and other HTTP verbs.
`RequestOptions` on the client, such as retries, will be respected when making these requests.
```go theme={null}
var (
// params can be an io.Reader, a []byte, an encoding/json serializable object,
// or a "…Params" struct defined in this library.
params map[string]any
// result can be an []byte, *http.Response, a encoding/json deserializable object,
// or a model defined in this library.
result *http.Response
)
err := client.Post(context.Background(), "/unspecified", params, &result)
if err != nil {
…
}
```
#### Undocumented request params
To make requests using undocumented parameters, you may use either the `option.WithQuerySet()`
or the `option.WithJSONSet()` methods.
```go theme={null}
params := FooNewParams{
ID: "id_xxxx",
Data: FooNewParamsData{
FirstName: telnyx.String("John"),
},
}
client.Foo.New(context.Background(), params, option.WithJSONSet("data.last_name", "Doe"))
```
#### Undocumented response properties
To access undocumented response properties, you may either access the raw JSON of the response as a string
with `result.JSON.RawJSON()`, or get the raw JSON of a particular field on the result with
`result.JSON.Foo.Raw()`.
Any fields that are not present on the response struct will be saved and can be accessed by `result.JSON.ExtraFields()` which returns the extra fields as a `map[string]Field`.
### Middleware
We provide `option.WithMiddleware` which applies the given
middleware to requests.
```go theme={null}
func Logger(req *http.Request, next option.MiddlewareNext) (res *http.Response, err error) {
// Before the request
start := time.Now()
LogReq(req)
// Forward the request to the next handler
res, err = next(req)
// Handle stuff after the request
end := time.Now()
LogRes(res, err, start - end)
return res, err
}
client := telnyx.NewClient(
option.WithMiddleware(Logger),
)
```
When multiple middlewares are provided as variadic arguments, the middlewares
are applied left to right. If `option.WithMiddleware` is given
multiple times, for example first in the client then the method, the
middleware in the client will run first and the middleware given in the method
will run next.
You may also replace the default `http.Client` with
`option.WithHTTPClient(client)`. Only one http client is
accepted (this overwrites any previous client) and receives requests after any
middleware has been applied.
## Semantic versioning
This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
1. Changes to library internals which are technically public but not intended or documented for external use. *(Please open a GitHub issue to let us know if you are relying on such internals.)*
2. Changes that we do not expect to impact the vast majority of users in practice.
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
We are keen for your feedback; please open an [issue](https://www.github.com/team-telnyx/telnyx-go/issues) with questions, bugs, or suggestions.
## Contributing
See [the contributing documentation](https://github.com/team-telnyx/telnyx-go/tree/master/./CONTRIBUTING.md).
# Java SDK
Source: https://developers.telnyx.com/development/sdk/java/index
The official Telnyx Java library for server-side applications.
# Telnyx Java API Library