# Telnyx API API

> Telnyx API API on Apizie: 361 endpoints (Creates several credentials, Update several credentials, Delete several credentials, Bulk Network Preferences for SIM cards, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/communication:telnyx/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `communication:telnyx`
- Category: Communication
- Status: byok
- Source: https://telnyx.com
- Page: https://zieapi.vercel.app/api/communication/telnyx
- OpenAPI: https://zieapi.vercel.app/api/communication/telnyx/openapi.json

SIP trunking, SMS, MMS, Call Control and Telephony Data Services.

## Endpoints

### Creates several credentials
`POST https://zieapi.vercel.app/v1/communication:telnyx/create-bulk-telephony-credential` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Update several credentials
`POST https://zieapi.vercel.app/v1/communication:telnyx/update-bulk-telephony-credential` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter[tag] | string | yes | Filter by tag, required by bulk operations. |
| body | object | yes | JSON request body |

### Delete several credentials
`POST https://zieapi.vercel.app/v1/communication:telnyx/delete-bulk-telephony-credential` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter[tag] | string | yes | Filter by tag, required by bulk operations. |

### Bulk Network Preferences for SIM cards
`POST https://zieapi.vercel.app/v1/communication:telnyx/bulk-simcard-network-preferences` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Register SIM cards
`POST https://zieapi.vercel.app/v1/communication:telnyx/sim-card-register` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Perform activate or deactivate action on all credentials filtered by the provided tag.
`POST https://zieapi.vercel.app/v1/communication:telnyx/bulk-credential-action` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| action | string | yes | Identifies the action to be taken. Activate will change the status to active. Deactivate will change the status to inactive. |
| filter[tag] | string | yes | Filter by tag, required by bulk operations. |

### List all addresses
`GET https://zieapi.vercel.app/v1/communication:telnyx/find-addresss` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page[number] | integer | no | The page number to load. |
| page[size] | integer | no | The size of the page. |
| filter[customer_reference][eq] | string | no | Filter addresses via the customer reference set. Matching is not case-sensitive. |
| filter[customer_reference][contains] | string | no | If present, addresses with customer_reference containing the given value will be returned. Matching is not case-sensitive. |
| filter[used_as_emergency] | string | no | If set as 'true', only addresses used as the emergency address for at least one active phone-number will be returned. When set to 'false',… |
| filter[street_address][contains] | string | no | If present, addresses with street_address containing the given value will be returned. Matching is not case-sensitive. Requires at least… |
| filter[address_book][eq] | string | no | If present, only returns results with the address_book flag set to the given value. |
| sort | string | no | Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -… |

### Creates an address
`POST https://zieapi.vercel.app/v1/communication:telnyx/create-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Validate an address
`POST https://zieapi.vercel.app/v1/communication:telnyx/validate-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve an address
`GET https://zieapi.vercel.app/v1/communication:telnyx/get-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | address ID |

### Deletes an address
`POST https://zieapi.vercel.app/v1/communication:telnyx/delete-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | address ID |

### List all SSO authentication providers
`GET https://zieapi.vercel.app/v1/communication:telnyx/find-authentication-providers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page[number] | integer | no | The page number to load. |
| page[size] | integer | no | The size of the page. |
| sort | string | no | Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -… |

### Creates an authentication provider
`POST https://zieapi.vercel.app/v1/communication:telnyx/create-authentication-provider` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve an authentication provider
`GET https://zieapi.vercel.app/v1/communication:telnyx/get-authentication-provider` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | authentication provider ID |

### Update a authentication provider
`POST https://zieapi.vercel.app/v1/communication:telnyx/update-authentication-provider` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifies the resource. |
| body | object | yes | JSON request body |

### Deletes an authentication provider
`POST https://zieapi.vercel.app/v1/communication:telnyx/delete-authentication-provider` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | authentication provider ID |

### List available phone number blocks
`GET https://zieapi.vercel.app/v1/communication:telnyx/list-available-phone-number-blocks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter[phone_number][starts_with] | string | no | Filter number blocks that start with a pattern (meant to be used after `national_destination_code` filter has been set). |
| filter[phone_number][ends_with] | string | no | Filter numbers ending with a pattern. |
| filter[phone_number][contains] | string | no | Filter numbers containing a pattern. |
| filter[locality] | string | no | Filter phone numbers by city. |
| filter[administrative_area] | string | no | Filter phone numbers by US state/CA province. |
| filter[country_code] | string | no | Filter phone numbers by ISO alpha-2 country code. |
| filter[national_destination_code] | string | no | Filter by the national destination code of the number. This filter is only applicable to North American numbers. |
| filter[rate_center] | string | no | Filter phone numbers by NANP rate center. This filter is only applicable to North American numbers. |
| filter[number_type] | string | no | Filter phone numbers by number type. |
| filter[features] | array | no | Filter if the phone number should be used for voice, fax, mms, sms, emergency. |
| filter[minimum_block_size] | integer | no | Filter number blocks by minimum blocks size |
| filter[limit] | integer | no | Limits the number of results. |

### List available phone numbers
`GET https://zieapi.vercel.app/v1/communication:telnyx/list-available-phone-numbers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter[phone_number][starts_with] | string | no | Filter numbers starting with a pattern (meant to be used after `national_destination_code` filter has been set). |
| filter[phone_number][ends_with] | string | no | Filter numbers ending with a pattern. |
| filter[phone_number][contains] | string | no | Filter numbers containing a pattern. |
| filter[locality] | string | no | Filter phone numbers by city. |
| filter[administrative_area] | string | no | Filter phone numbers by US state/CA province. |
| filter[country_code] | string | no | Filter phone numbers by ISO alpha-2 country code. |
| filter[national_destination_code] | string | no | Filter by the national destination code of the number. This filter is only applicable to North American numbers. |
| filter[rate_center] | string | no | Filter phone numbers by NANP rate center. This filter is only applicable to North American numbers. |
| filter[number_type] | string | no | Filter phone numbers by number type. |
| filter[features] | array | no | Filter if the phone number should be used for voice, fax, mms, sms, emergency. |
| filter[limit] | integer | no | Limits the number of results. |
| filter[best_effort] | boolean | no | Filter to determine if best effort results should be included. |
| filter[quickship] | boolean | no | Filter to exclude phone numbers that need additional time after to purchase to receive phone calls. |
| filter[reservable] | boolean | no | Filter to exclude phone numbers that cannot be reserved before purchase. |
| filter[exclude_held_numbers] | boolean | no | Filter to exclude phone numbers that are currently on hold for your account. |

### Retrieve user balance details
`GET https://zieapi.vercel.app/v1/communication:telnyx/get-user-balance` (byok)

### List all billing groups
`GET https://zieapi.vercel.app/v1/communication:telnyx/list-billing-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page[number] | integer | no | The page number to load. |
| page[size] | integer | no | The size of the page. |

### Create a billing group
`POST https://zieapi.vercel.app/v1/communication:telnyx/create-billing-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a billing group
`GET https://zieapi.vercel.app/v1/communication:telnyx/retrieve-billing-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The id of the billing group |

### Update a billing group
`POST https://zieapi.vercel.app/v1/communication:telnyx/update-billing-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The id of the billing group |
| body | object | yes | JSON request body |

### Delete a billing group
`POST https://zieapi.vercel.app/v1/communication:telnyx/delete-billing-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The id of the billing group |

### List call control applications
`GET https://zieapi.vercel.app/v1/communication:telnyx/list-call-control-applications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page[number] | integer | no | The page number to load. |
| page[size] | integer | no | The size of the page. |
| filter[application_name][contains] | string | no | If present, applications with application_name containing the given value will be returned. Matching is not case-sensitive. Requires at… |
| filter[outbound_voice_profile_id] | string | no | Identifies the associated outbound voice profile. |
| sort | string | no | Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -… |

### Create a call control application
`POST https://zieapi.vercel.app/v1/communication:telnyx/create-call-control-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a call control application
`GET https://zieapi.vercel.app/v1/communication:telnyx/retrieve-call-control-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifies the resource. |

### Update a call control application
`POST https://zieapi.vercel.app/v1/communication:telnyx/update-call-control-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifies the resource. |
| body | object | yes | JSON request body |

### Delete a call control application
`POST https://zieapi.vercel.app/v1/communication:telnyx/delete-call-control-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifies the resource. |

### List call events
`GET https://zieapi.vercel.app/v1/communication:telnyx/list-call-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter[call_leg_id] | string | no | The unique identifier of an individual call leg. |
| filter[call_session_id] | string | no | The unique identifier of the call control session. A session may include multiple call leg events. |
| filter[status] | string | no | Event status |
| filter[type] | string | no | Event type |
| filter[event_timestamp][gt] | string | no | Event timestamp: greater than |
| filter[event_timestamp][gte] | string | no | Event timestamp: greater than or equal |
| filter[event_timestamp][lt] | string | no | Event timestamp: lower than |
| filter[event_timestamp][lte] | string | no | Event timestamp: lower than or equal |
| filter[event_timestamp][eq] | string | no | Event timestamp: equal |
| page[number] | integer | no | The page number to load. |
| page[size] | integer | no | The size of the page. |

### Dial
`POST https://zieapi.vercel.app/v1/communication:telnyx/call-dial` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a call status
`GET https://zieapi.vercel.app/v1/communication:telnyx/retrieve-call-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |

### Answer call
`POST https://zieapi.vercel.app/v1/communication:telnyx/call-answer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |
| body | object | yes | JSON request body |

### Bridge calls
`POST https://zieapi.vercel.app/v1/communication:telnyx/call-bridge` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |
| body | object | yes | JSON request body |

### Enqueue call
`POST https://zieapi.vercel.app/v1/communication:telnyx/call-enqueue` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |
| body | object | yes | JSON request body |

### Forking start
`POST https://zieapi.vercel.app/v1/communication:telnyx/call-fork-start` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |
| body | object | yes | JSON request body |

### Forking stop
`POST https://zieapi.vercel.app/v1/communication:telnyx/call-fork-stop` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |
| body | object | yes | JSON request body |

### Gather stop
`POST https://zieapi.vercel.app/v1/communication:telnyx/call-gather-stop` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |
| body | object | yes | JSON request body |

### Gather using audio
`POST https://zieapi.vercel.app/v1/communication:telnyx/call-gather-using-audio` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |
| body | object | yes | JSON request body |

### Gather using speak
`POST https://zieapi.vercel.app/v1/communication:telnyx/call-gather-using-speak` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |
| body | object | yes | JSON request body |

### Hangup call
`POST https://zieapi.vercel.app/v1/communication:telnyx/call-hangup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |
| body | object | yes | JSON request body |

### Remove call from a queue
`POST https://zieapi.vercel.app/v1/communication:telnyx/leave-queue` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |
| body | object | yes | JSON request body |

### Play audio URL
`POST https://zieapi.vercel.app/v1/communication:telnyx/call-playback-start` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |
| body | object | yes | JSON request body |

### Stop audio playback
`POST https://zieapi.vercel.app/v1/communication:telnyx/call-playback-stop` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |
| body | object | yes | JSON request body |

### Record pause
`POST https://zieapi.vercel.app/v1/communication:telnyx/call-record-pause` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |
| body | object | yes | JSON request body |

### Record resume
`POST https://zieapi.vercel.app/v1/communication:telnyx/call-record-resume` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |
| body | object | yes | JSON request body |

### Recording start
`POST https://zieapi.vercel.app/v1/communication:telnyx/call-record-start` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |
| body | object | yes | JSON request body |

### Recording stop
`POST https://zieapi.vercel.app/v1/communication:telnyx/call-record-stop` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |
| body | object | yes | JSON request body |

### SIP Refer a call
`POST https://zieapi.vercel.app/v1/communication:telnyx/call-refer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |
| body | object | yes | JSON request body |

### Reject a call
`POST https://zieapi.vercel.app/v1/communication:telnyx/call-reject` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |
| body | object | yes | JSON request body |

### Send DTMF
`POST https://zieapi.vercel.app/v1/communication:telnyx/call-send-dtmf` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |
| body | object | yes | JSON request body |

### Speak text
`POST https://zieapi.vercel.app/v1/communication:telnyx/call-speak` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |
| body | object | yes | JSON request body |

### Transcription start
`POST https://zieapi.vercel.app/v1/communication:telnyx/call-transcription-start` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |
| body | object | yes | JSON request body |

### Transcription stop
`POST https://zieapi.vercel.app/v1/communication:telnyx/call-transcription-stop` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |
| body | object | yes | JSON request body |

### Transfer call
`POST https://zieapi.vercel.app/v1/communication:telnyx/call-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| call_control_id | string | yes | Unique identifier and token for controlling the call |
| body | object | yes | JSON request body |

### Retrieve all comments
`GET https://zieapi.vercel.app/v1/communication:telnyx/list-comments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter[comment_record_type] | string | yes | Record type that the comment relates to i.e number_order, sub_number_order or number_order_phone_number |
| filter[comment_record_id] | string | yes | ID of the record the comments relate to |

### Create a comment
`POST https://zieapi.vercel.app/v1/communication:telnyx/create-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a comment
`GET https://zieapi.vercel.app/v1/communication:telnyx/retrieve-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The comment ID. |

### Mark a comment as read
`POST https://zieapi.vercel.app/v1/communication:telnyx/mark-comment-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The comment ID. |

### List conferences
`GET https://zieapi.vercel.app/v1/communication:telnyx/list-conferences` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter[name] | string | no | If present, conferences will be filtered to those with a matching `name` attribute. Matching is case-sensitive |
| page[number] | integer | no | The page number to load. |
| page[size] | integer | no | The size of the page. |

### Create conference
`POST https://zieapi.vercel.app/v1/communication:telnyx/create-conference` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List conference participants
`GET https://zieapi.vercel.app/v1/communication:telnyx/list-conference-participants` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conference_id | string | yes | Uniquely identifies the conference by id |
| filter[muted] | boolean | no | If present, participants will be filtered to those who are/are not muted |
| filter[on_hold] | boolean | no | If present, participants will be filtered to those who are/are not put on hold |
| filter[whispering] | boolean | no | If present, participants will be filtered to those who are whispering or are not |
| page[number] | integer | no | The page number to load. |
| page[size] | integer | no | The size of the page. |

### Retrieve a conference
`GET https://zieapi.vercel.app/v1/communication:telnyx/retrieve-conference` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Uniquely identifies the conference by id |

### Dial a new participant into a conference
`POST https://zieapi.vercel.app/v1/communication:telnyx/conference-dial-participant-in` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Uniquely identifies the conference by id or name |
| body | object | yes | JSON request body |

### Hold conference participants
`POST https://zieapi.vercel.app/v1/communication:telnyx/conference-hold-participants` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Uniquely identifies the conference by id or name |
| body | object | yes | JSON request body |

### Join a conference
`POST https://zieapi.vercel.app/v1/communication:telnyx/conference-join` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Uniquely identifies the conference by id or name |
| body | object | yes | JSON request body |

### Leave a conference
`POST https://zieapi.vercel.app/v1/communication:telnyx/conference-leave` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Uniquely identifies the conference by id or name |
| body | object | yes | JSON request body |

### Mute conference participants
`POST https://zieapi.vercel.app/v1/communication:telnyx/conference-mute-participants` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Uniquely identifies the conference by id or name |
| body | object | yes | JSON request body |

### Play audio to conference participants
`POST https://zieapi.vercel.app/v1/communication:telnyx/conference-play-audio` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Uniquely identifies the conference by id or name |
| body | object | yes | JSON request body |

### Conference recording start
`POST https://zieapi.vercel.app/v1/communication:telnyx/conference-start-recording` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Specifies the conference to record by id or name |
| body | object | yes | JSON request body |

### Conference recording stop
`POST https://zieapi.vercel.app/v1/communication:telnyx/conference-stop-recording` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Specifies the conference to stop the recording for by id or name |
| body | object | yes | JSON request body |

### Speak text to conference participants
`POST https://zieapi.vercel.app/v1/communication:telnyx/conference-speak-text` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Specifies the conference by id or name |
| body | object | yes | JSON request body |

### Stop audio being played on the conference
`POST https://zieapi.vercel.app/v1/communication:telnyx/conference-stop-audio` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Uniquely identifies the conference by id or name |
| body | object | yes | JSON request body |

### Unhold conference participants
`POST https://zieapi.vercel.app/v1/communication:telnyx/conference-unhold-participants` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Uniquely identifies the conference by id or name |
| body | object | yes | JSON request body |

### Unmute conference participants
`POST https://zieapi.vercel.app/v1/communication:telnyx/conference-unmute-participants` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Uniquely identifies the conference by id or name |
| body | object | yes | JSON request body |

### Update conference participant
`POST https://zieapi.vercel.app/v1/communication:telnyx/conference-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Uniquely identifies the conference by id or name |
| body | object | yes | JSON request body |

### List connections
`GET https://zieapi.vercel.app/v1/communication:telnyx/list-connections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page[number] | integer | no | The page number to load. |
| page[size] | integer | no | The size of the page. |
| filter[connection_name][contains] | string | no | If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at… |
| filter[outbound_voice_profile_id] | string | no | Identifies the associated outbound voice profile. |
| sort | string | no | Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -… |

### Retrieve a connection
`GET https://zieapi.vercel.app/v1/communication:telnyx/retrieve-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | IP Connection ID |

### List credential connections
`GET https://zieapi.vercel.app/v1/communication:telnyx/list-credential-connections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page[number] | integer | no | The page number to load. |
| page[size] | integer | no | The size of the page. |
| filter[connection_name][contains] | string | no | If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at… |
| filter[outbound.outbound_voice_profile_id] | string | no | Identifies the associated outbound voice profile. |
| sort | string | no | Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -… |

### Create a credential connection
`POST https://zieapi.vercel.app/v1/communication:telnyx/create-credential-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a credential connection
`GET https://zieapi.vercel.app/v1/communication:telnyx/retrieve-credential-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifies the resource. |

### Update a credential connection
`POST https://zieapi.vercel.app/v1/communication:telnyx/update-credential-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifies the resource. |
| body | object | yes | JSON request body |

### Delete a credential connection
`POST https://zieapi.vercel.app/v1/communication:telnyx/delete-credential-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifies the resource. |

### Search detail records
`GET https://zieapi.vercel.app/v1/communication:telnyx/detail-records-search` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter[record_type] | string | yes | Filter by the given record type |
| filter[date_range] | string | no | Filter by the given user-friendly date range |
| filter | object | no | Filter records |
| page[number] | integer | no | Page number |
| page[size] | integer | no | Page size |
| sort | array | no | Specifies the sort order for results |

### List all document links
`GET https://zieapi.vercel.app/v1/communication:telnyx/list-document-links` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page[number] | integer | no | The page number to load. |
| page[size] | integer | no | The size of the page. |
| filter[document_id] | string | no | Identifies the associated document to filter on. |
| filter[linked_record_type] | string | no | The `linked_record_type` of the document to filter on. |
| filter[linked_resource_id] | string | no | The `linked_resource_id` of the document to filter on. |

### List all documents
`GET https://zieapi.vercel.app/v1/communication:telnyx/list-documents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page[number] | integer | no | The page number to load. |
| page[size] | integer | no | The size of the page. |

### Upload a document
`POST https://zieapi.vercel.app/v1/communication:telnyx/create-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a document
`GET https://zieapi.vercel.app/v1/communication:telnyx/retrieve-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The id of the resource. |

### Update a document
`POST https://zieapi.vercel.app/v1/communication:telnyx/update-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The id of the resource. |
| body | object | yes | JSON request body |

### Delete a document
`POST https://zieapi.vercel.app/v1/communication:telnyx/delete-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The id of the resource. |

### Download a document
`GET https://zieapi.vercel.app/v1/communication:telnyx/download-doc-service-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The id of the resource. |

### List all Fax Applications
`GET https://zieapi.vercel.app/v1/communication:telnyx/list-fax-applications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page[number] | integer | no | The page number to load. |
| page[size] | integer | no | The size of the page. |
| filter[application_name][contains] | string | no | If present, applications with application_name containing the given value will be returned. Matching is not case-sensitive. Requires at… |
| filter[outbound_voice_profile_id] | string | no | Identifies the associated outbound voice profile. |
| sort | string | no | Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -… |

### Creates a Fax Application
`POST https://zieapi.vercel.app/v1/communication:telnyx/create-fax-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a Fax Application
`GET https://zieapi.vercel.app/v1/communication:telnyx/get-fax-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifies the resource. |

### Update a Fax Application
`POST https://zieapi.vercel.app/v1/communication:telnyx/update-fax-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifies the resource. |
| body | object | yes | JSON request body |

### Deletes a Fax Application
`POST https://zieapi.vercel.app/v1/communication:telnyx/delete-fax-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifies the resource. |

### View a list of faxes
`GET https://zieapi.vercel.app/v1/communication:telnyx/list-faxes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter[created_at][gte] | string | no | ISO 8601 date time for filtering faxes created after or on that date |
| filter[created_at][gt] | string | no | ISO 8601 date time for filtering faxes created after that date |
| filter[created_at][lte] | string | no | ISO 8601 formatted date time for filtering faxes created on or before that date |
| filter[created_at][lt] | string | no | ISO 8601 formatted date time for filtering faxes created before that date |
| filter[direction][eq] | string | no | The direction, inbound or outbound, for filtering faxes sent from this account |
| filter[from][eq] | string | no | The phone number, in E.164 format for filtering faxes sent from this number |
| page[size] | integer | no | Number of fax resourcxes for the single page returned |
| page[number] | integer | no | Number of the page to be retrieved |

### Send a fax
`POST https://zieapi.vercel.app/v1/communication:telnyx/send-fax` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### View a fax
`GET https://zieapi.vercel.app/v1/communication:telnyx/view-fax` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The unique identifier of a fax. |

### Delete a fax
`POST https://zieapi.vercel.app/v1/communication:telnyx/delete-fax` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The unique identifier of a fax. |

### Refresh a fax
`POST https://zieapi.vercel.app/v1/communication:telnyx/refresh-fax` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The unique identifier of a fax. |

### List FQDN connections
`GET https://zieapi.vercel.app/v1/communication:telnyx/list-fqdn-connections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page[number] | integer | no | The page number to load. |
| page[size] | integer | no | The size of the page. |
| filter[connection_name][contains] | string | no | If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at… |
| sort | string | no | Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -… |

### Create an FQDN connection
`POST https://zieapi.vercel.app/v1/communication:telnyx/create-fqdn-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve an FQDN connection
`GET https://zieapi.vercel.app/v1/communication:telnyx/retrieve-fqdn-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | FQDN Connection ID |

### Update an FQDN connection
`POST https://zieapi.vercel.app/v1/communication:telnyx/update-fqdn-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | FQDN Connection ID |
| body | object | yes | JSON request body |

### Delete an FQDN connection
`POST https://zieapi.vercel.app/v1/communication:telnyx/delete-fqdn-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | FQDN Connection ID |

### List FQDNs
`GET https://zieapi.vercel.app/v1/communication:telnyx/list-fqdns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page[number] | integer | no | The page number to load. |
| page[size] | integer | no | The size of the page. |
| filter[connection_id] | string | no | ID of the FQDN connection to which the FQDN belongs. |
| filter[fqdn] | string | no | FQDN represented by the resource. |
| filter[port] | integer | no | Port to use when connecting to the FQDN. |
| filter[dns_record_type] | string | no | DNS record type used by the FQDN. |

### Create an FQDN
`POST https://zieapi.vercel.app/v1/communication:telnyx/create-fqdn` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve an FQDN
`GET https://zieapi.vercel.app/v1/communication:telnyx/retrieve-fqdn` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifies the resource. |

### Update an FQDN
`POST https://zieapi.vercel.app/v1/communication:telnyx/update-fqdn` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifies the resource. |
| body | object | no | JSON request body |

### Delete an FQDN
`POST https://zieapi.vercel.app/v1/communication:telnyx/delete-fqdn` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifies the resource. |

### Create an inventory coverage request
`GET https://zieapi.vercel.app/v1/communication:telnyx/create-inventory-coverage-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter[npa] | integer | no | Filter by npa |
| filter[nxx] | integer | no | Filter by nxx |
| filter[administrative_area] | string | no | Filter by administrative area |
| filter[number_type] | string | no | Filter by number type |
| filter[phone_number_type] | string | no | Filter by phone number type |
| filter[country_code] | string | no | Filter by country. Defaults to US |
| filter[count] | boolean | no | Include count in the result |
| filter[groupBy] | string | yes | Filter to group results |

### List Ip connections
`GET https://zieapi.vercel.app/v1/communication:telnyx/list-ip-connections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page[number] | integer | no | The page number to load. |
| page[size] | integer | no | The size of the page. |
| filter[connection_name][contains] | string | no | If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at… |
| filter[outbound.outbound_voice_profile_id] | string | no | Identifies the associated outbound voice profile. |
| sort | string | no | Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -… |

### Create an Ip connection
`POST https://zieapi.vercel.app/v1/communication:telnyx/create-ip-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve an Ip connection
`GET https://zieapi.vercel.app/v1/communication:telnyx/retrieve-ip-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | IP Connection ID |

### Update an Ip connection
`POST https://zieapi.vercel.app/v1/communication:telnyx/update-ip-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifies the type of resource. |
| body | object | yes | JSON request body |

### Delete an Ip connection
`POST https://zieapi.vercel.app/v1/communication:telnyx/delete-ip-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifies the type of resource. |

### List Ips
`GET https://zieapi.vercel.app/v1/communication:telnyx/list-ips` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page[number] | integer | no | The page number to load. |
| page[size] | integer | no | The size of the page. |
| filter[connection_id] | string | no | ID of the IP Connection to which this IP should be attached. |
| filter[ip_address] | string | no | IP adddress represented by this resource. |
| filter[port] | integer | no | Port to use when connecting to this IP. |

### Create an Ip
`POST https://zieapi.vercel.app/v1/communication:telnyx/create-ip` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve an Ip
`GET https://zieapi.vercel.app/v1/communication:telnyx/retrieve-ip` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifies the type of resource. |

…and 241 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/communication:telnyx/create-bulk-telephony-credential" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Telnyx API API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/communication:telnyx/create-bulk-telephony-credential with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Telnyx API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Telnyx API itself also needs your own key from telnyx.com.

### Can AI agents use the Telnyx API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key communication:telnyx.

### What is the status of the Telnyx API API?
Needs your own provider key (bring your own key)