# Telnyx API API

> Telnyx API API on Apizie: 400 endpoints (Authorization server metadata, Protected resource metadata, List Brands, Create Brand, …) 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://apizie.tech/v1/communication:telnyx-2/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `communication:telnyx-2`
- Category: Communication
- Status: byok
- Source: https://telnyx
- Page: https://apizie.tech/api/communication/telnyx-2
- OpenAPI: https://apizie.tech/api/communication/telnyx-2/openapi.json

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

## Endpoints

### Authorization server metadata
`GET https://apizie.tech/v1/communication:telnyx-2/get-oauth-authorization-server-metadata` (byok)

### Protected resource metadata
`GET https://apizie.tech/v1/communication:telnyx-2/get-oauth-protected-resource-metadata` (byok)

### List Brands
`GET https://apizie.tech/v1/communication:telnyx-2/get-brands` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number to retrieve (1-based). |
| recordsPerPage | integer | no | number of records per page. maximum of 500 |
| sort | string | no | Specifies the sort order for results. If not given, results are sorted by createdAt in descending order. |
| displayName | string | no | Filter results by display name. |
| entityType | string | no | Filter results by entity type. |
| state | string | no | Filter results by state. |
| country | string | no | Filter results by country. |
| brandId | string | no | Filter results by the Telnyx Brand id |
| tcrBrandId | string | no | Filter results by the TCR Brand id |

### Create Brand
`POST https://apizie.tech/v1/communication:telnyx-2/create-brand-post` (byok)

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

### Get Brand Feedback By Id
`GET https://apizie.tech/v1/communication:telnyx-2/get-brand-feedback-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| brandId | string | yes | Unique identifier of the brand. |

### Get Brand SMS OTP Status
`GET https://apizie.tech/v1/communication:telnyx-2/get-brand-sms-otp-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| referenceId | string | yes | The reference ID returned when the OTP was initially triggered |
| brandId | string | no | Filter by Brand ID for easier lookup in portal applications |

### Get Brand
`GET https://apizie.tech/v1/communication:telnyx-2/get-brand` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| brandId | string | yes | Unique identifier of the brand. |

### Update Brand
`POST https://apizie.tech/v1/communication:telnyx-2/update-brand` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| brandId | string | yes | Unique identifier of the brand. |
| body | object | yes | JSON request body |

### Delete Brand
`POST https://apizie.tech/v1/communication:telnyx-2/delete-brand` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| brandId | string | yes | Unique identifier of the brand. |

### Resend brand 2FA email
`POST https://apizie.tech/v1/communication:telnyx-2/resend-brand2fa-email` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| brandId | string | yes | Unique identifier of the brand. |

### List External Vettings
`GET https://apizie.tech/v1/communication:telnyx-2/list-external-vettings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| brandId | string | yes | Unique identifier of the brand. |

### Order Brand External Vetting
`POST https://apizie.tech/v1/communication:telnyx-2/post-order-external-vetting` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| brandId | string | yes | Unique identifier of the brand. |
| body | object | yes | JSON request body |

### Import External Vetting Record
`POST https://apizie.tech/v1/communication:telnyx-2/put-external-vetting-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| brandId | string | yes | Unique identifier of the brand. |
| body | object | yes | JSON request body |

### Revet Brand
`POST https://apizie.tech/v1/communication:telnyx-2/revet-brand` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| brandId | string | yes | Unique identifier of the brand. |

### Get Brand SMS OTP Status by Brand ID
`GET https://apizie.tech/v1/communication:telnyx-2/get-brand-sms-otp-status-by-brand-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| brandId | string | yes | The Brand ID for which to query OTP status |

### Trigger Brand SMS OTP
`POST https://apizie.tech/v1/communication:telnyx-2/trigger-brand-sms-otp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| brandId | string | yes | The Brand ID for which to trigger the OTP |
| body | object | yes | JSON request body |

### Verify Brand SMS OTP
`POST https://apizie.tech/v1/communication:telnyx-2/verify-brand-sms-otp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| brandId | string | yes | The Brand ID for which to verify the OTP |
| body | object | yes | JSON request body |

### Get Brand Feedback By Id
`GET https://apizie.tech/v1/communication:telnyx-2/get-brand-feedback-by-id-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| brandId | string | yes | Unique identifier of the brand. |

### List Campaigns
`GET https://apizie.tech/v1/communication:telnyx-2/get-campaigns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| brandId | string | yes | Filter results by brand id. |
| page | integer | no | The 1-indexed page number to get. The default value is `1`. |
| recordsPerPage | integer | no | The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`. |
| sort | string | no | Specifies the sort order for results. If not given, results are sorted by createdAt in descending order. |

### Accept Shared Campaign
`POST https://apizie.tech/v1/communication:telnyx-2/accept-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| campaignId | string | yes | TCR's ID for the campaign to import |

### Get Campaign Cost
`GET https://apizie.tech/v1/communication:telnyx-2/get-campaign-cost` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| usecase | string | yes | Filter results by usecase. |

### Get Campaign Cost
`GET https://apizie.tech/v1/communication:telnyx-2/get-campaign-cost-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| usecase | string | yes | Filter results by usecase. |

### Get campaign
`GET https://apizie.tech/v1/communication:telnyx-2/get-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| campaignId | string | yes | Unique identifier of the campaign. |

### Update campaign
`POST https://apizie.tech/v1/communication:telnyx-2/update-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| campaignId | string | yes | Unique identifier of the campaign. |
| body | object | yes | JSON request body |

### Deactivate campaign
`POST https://apizie.tech/v1/communication:telnyx-2/deactivate-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| campaignId | string | yes | Unique identifier of the campaign. |

### Submit campaign appeal for manual review
`POST https://apizie.tech/v1/communication:telnyx-2/appeal-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| campaignId | string | yes | The Telnyx campaign identifier |
| body | object | yes | JSON request body |

### Get Campaign Mno Metadata
`GET https://apizie.tech/v1/communication:telnyx-2/get-campaign-mno-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| campaignId | string | yes | ID of the campaign in question |

### Get campaign operation status
`GET https://apizie.tech/v1/communication:telnyx-2/get-campaign-operation-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| campaignId | string | yes | Unique identifier of the campaign. |

### Get OSR campaign attributes
`GET https://apizie.tech/v1/communication:telnyx-2/get-campaign-osr-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| campaignId | string | yes | Unique identifier of the campaign. |

### Get OSR campaign attributes
`GET https://apizie.tech/v1/communication:telnyx-2/get-campaign-osr-attributes-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| campaignId | string | yes | Unique identifier of the campaign. |

### Get Sharing Status
`GET https://apizie.tech/v1/communication:telnyx-2/get-campaign-sharing-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| campaignId | string | yes | ID of the campaign in question |

### Submit Campaign
`POST https://apizie.tech/v1/communication:telnyx-2/post-campaign` (byok)

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

### Qualify By Usecase
`GET https://apizie.tech/v1/communication:telnyx-2/get-usecase-qualification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| usecase | string | yes | Unique identifier of the usecase. |
| brandId | string | yes | Unique identifier of the brand. |

### Get Enum
`GET https://apizie.tech/v1/communication:telnyx-2/get-enum-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Unique identifier of the endpoint. |

### List shared partner campaigns
`GET https://apizie.tech/v1/communication:telnyx-2/get-partner-campaigns-shared-by-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | The 1-indexed page number to get. The default value is `1`. |
| recordsPerPage | integer | no | The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`. |

### Get Sharing Status
`GET https://apizie.tech/v1/communication:telnyx-2/get-partner-campaign-sharing-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| campaignId | string | yes | ID of the campaign in question |

### List Shared Campaigns
`GET https://apizie.tech/v1/communication:telnyx-2/get-shared-campaigns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | The 1-indexed page number to get. The default value is `1`. |
| recordsPerPage | integer | no | The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`. |
| sort | string | no | Specifies the sort order for results. If not given, results are sorted by createdAt in descending order. |

### Get Single Shared Campaign
`GET https://apizie.tech/v1/communication:telnyx-2/get-shared-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| campaignId | string | yes | Unique identifier of the campaign. |

### Update Single Shared Campaign
`POST https://apizie.tech/v1/communication:telnyx-2/update-shared-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| campaignId | string | yes | Unique identifier of the campaign. |
| body | object | yes | JSON request body |

### Assign Messaging Profile To Campaign
`POST https://apizie.tech/v1/communication:telnyx-2/post-assign-messaging-profile-to-campaign` (byok)

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

### Get Assignment Task Status
`GET https://apizie.tech/v1/communication:telnyx-2/get-assignment-task-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| taskId | string | yes | Unique identifier of the task. |

### Get Phone Number Status
`GET https://apizie.tech/v1/communication:telnyx-2/get-phone-number-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| taskId | string | yes | Unique identifier of the task. |
| recordsPerPage | integer | no | Number of records to return per page. |
| page | integer | no | Page number to retrieve (1-based). |

### List phone number campaigns
`GET https://apizie.tech/v1/communication:telnyx-2/get-all-phone-number-campaigns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| recordsPerPage | integer | no | Number of records to return per page. |
| page | integer | no | Page number to retrieve (1-based). |
| filter | object | no | Consolidated filter parameter (deepObject style). Originally: filter[telnyx_campaign_id], filter[telnyx_brand_id],… |
| sort | string | no | Specifies the sort order for results. If not given, results are sorted by createdAt in descending order. |

### Create New Phone Number Campaign
`POST https://apizie.tech/v1/communication:telnyx-2/create-phone-number-campaign` (byok)

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

### Get Single Phone Number Campaign
`GET https://apizie.tech/v1/communication:telnyx-2/get-single-phone-number-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| phoneNumber | string | yes | Unique identifier of the phone number. |

### Update Phone Number Campaign
`POST https://apizie.tech/v1/communication:telnyx-2/put-phone-number-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| phoneNumber | string | yes | Unique identifier of the phone number. |
| body | object | yes | JSON request body |

### Delete Phone Number Campaign
`POST https://apizie.tech/v1/communication:telnyx-2/delete-phone-number-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| phoneNumber | string | yes | Unique identifier of the phone number. |

### List all Access IP Addresses
`GET https://apizie.tech/v1/communication:telnyx-2/list-access-ip-addresses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | object | no | Consolidated filter parameter (deepObject style). Originally: filter[ip_source], filter[ip_address], filter[created_at]. Supports complex… |
| page | object | no | Consolidated page parameter (deepObject style). Originally: page[number], page[size] |

### Create new Access IP Address
`POST https://apizie.tech/v1/communication:telnyx-2/create-access-ip-address` (byok)

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

### Retrieve an access IP address
`GET https://apizie.tech/v1/communication:telnyx-2/get-access-ip-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| access_ip_address_id | string | yes | Unique identifier of the access ip address. |

### Delete access IP address
`POST https://apizie.tech/v1/communication:telnyx-2/delete-access-ip-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| access_ip_address_id | string | yes | Unique identifier of the access ip address. |

### List all Access IP Ranges
`GET https://apizie.tech/v1/communication:telnyx-2/list-access-ip-ranges` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | object | no | Consolidated filter parameter (deepObject style). Originally: filter[cidr_block], filter[cidr_block][startswith],… |
| page | object | no | Consolidated page parameter (deepObject style). Originally: page[number], page[size] |

### Create new Access IP Range
`POST https://apizie.tech/v1/communication:telnyx-2/create-access-iprange` (byok)

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

### Delete access IP ranges
`POST https://apizie.tech/v1/communication:telnyx-2/delete-access-ip-range` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| access_ip_range_id | string | yes | Unique identifier of the access ip range. |

### Purchase eSIMs
`POST https://apizie.tech/v1/communication:telnyx-2/purchase-esim` (byok)

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

### Register SIM cards
`POST https://apizie.tech/v1/communication:telnyx-2/register-sim-cards` (byok)

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

### List all addresses
`GET https://apizie.tech/v1/communication:telnyx-2/find-addresses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | object | no | Consolidated page parameter (deepObject style). Originally: page[number], page[size] |
| filter | object | no | Consolidated filter parameter (deepObject style). Originally: filter[customer_reference][eq], filter[customer_reference][contains],… |
| 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://apizie.tech/v1/communication:telnyx-2/create-address` (byok)

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

### Validate an address
`POST https://apizie.tech/v1/communication:telnyx-2/validate-address` (byok)

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

### Retrieve an address
`GET https://apizie.tech/v1/communication:telnyx-2/get-address` (byok)

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

### Deletes an address
`POST https://apizie.tech/v1/communication:telnyx-2/delete-address` (byok)

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

### Accepts this address suggestion as a new emergency address for Operator Connect and finishes the uploads of…
`POST https://apizie.tech/v1/communication:telnyx-2/accept-address-suggestions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The UUID of the address that should be accepted. |
| body | object | no | JSON request body |

### List Advanced Orders
`GET https://apizie.tech/v1/communication:telnyx-2/list-advanced-orders-v2` (byok)

### Create Advanced Order
`POST https://apizie.tech/v1/communication:telnyx-2/create-advanced-order-v2` (byok)

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

### Update Advanced Order
`POST https://apizie.tech/v1/communication:telnyx-2/update-advanced-order-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| advanced-order-id | string | yes | Unique identifier of the advanced order. |
| body | object | yes | JSON request body |

### Get Advanced Order
`GET https://apizie.tech/v1/communication:telnyx-2/get-advanced-order-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| order_id | string | yes | Unique identifier of the order. |

### Create a message (Anthropic-compatible)
`POST https://apizie.tech/v1/communication:telnyx-2/create-anthropic-message` (byok)

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

### List assistants
`GET https://apizie.tech/v1/communication:telnyx-2/get-assistants-public-assistants-get` (byok)

### Create an assistant
`POST https://apizie.tech/v1/communication:telnyx-2/create-new-assistant-public-assistants-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Idempotency-Key | string | no | Optional opaque, unquoted key for safely retrying the same logical request. Keys must contain 1 to 255 letters, numbers, hyphens, or… |
| body | object | yes | JSON request body |

### List deleted assistants
`GET https://apizie.tech/v1/communication:telnyx-2/get-deleted-assistants-public-assistants-deleted-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page[number] | integer | no | Page number to retrieve (1-based). |
| page[size] | integer | no | Number of items to return per page. |

### Import assistants from external provider
`POST https://apizie.tech/v1/communication:telnyx-2/import-assistants-public-assistants-import-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Idempotency-Key | string | no | Optional opaque, unquoted key for safely retrying the same logical request. Keys must contain 1 to 255 letters, numbers, hyphens, or… |
| body | object | yes | JSON request body |

### Get All Tags
`GET https://apizie.tech/v1/communication:telnyx-2/get-all-assistant-tags` (byok)

### List assistant tests with pagination
`GET https://apizie.tech/v1/communication:telnyx-2/get-assistant-tests-public-assistants-tests-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| test_suite | string | no | Filter tests by test suite name |
| telnyx_conversation_channel | string | no | Filter tests by communication channel (e.g., 'web_chat', 'sms') |
| destination | string | no | Filter tests by destination (phone number, webhook URL, etc.) |
| page | object | no | Consolidated page parameter (deepObject style). Originally: page[size], page[number] |

### Create a new assistant test
`POST https://apizie.tech/v1/communication:telnyx-2/create-assistant-test-public-assistants-tests-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Idempotency-Key | string | no | Optional opaque, unquoted key for safely retrying the same logical request. Keys must contain 1 to 255 letters, numbers, hyphens, or… |
| body | object | yes | JSON request body |

### Get all test suite names
`GET https://apizie.tech/v1/communication:telnyx-2/fetch-test-suites-public-assistants-tests-test-suites-get` (byok)

### Get test suite run history
`GET https://apizie.tech/v1/communication:telnyx-2/get-test-suite-runs-for-test-public-assistants-tests-test-su` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| suite_name | string | yes | Name of the suite. |
| status | string | no | Filter runs by execution status (pending, running, completed, failed, timeout) |
| test_suite_run_id | string | no | Filter runs by specific suite execution batch ID |
| page | object | no | Consolidated page parameter (deepObject style). Originally: page[size], page[number] |

### Trigger test suite execution
`POST https://apizie.tech/v1/communication:telnyx-2/trigger-test-suite-runs-public-assistants-tests-test-suites` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| suite_name | string | yes | Name of the suite. |
| Idempotency-Key | string | no | Optional opaque, unquoted key for safely retrying the same logical request. Keys must contain 1 to 255 letters, numbers, hyphens, or… |
| body | object | no | JSON request body |

### Get assistant test by ID
`GET https://apizie.tech/v1/communication:telnyx-2/get-assistant-test-public-assistants-tests-test-id-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| test_id | string | yes | Unique identifier of the test. |

### Update an assistant test
`POST https://apizie.tech/v1/communication:telnyx-2/update-assistant-test-public-assistants-tests-test-id-put` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| test_id | string | yes | Unique identifier of the test. |
| body | object | yes | JSON request body |

### Delete an assistant test
`POST https://apizie.tech/v1/communication:telnyx-2/delete-assistant-test-public-assistants-tests-test-id-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| test_id | string | yes | Unique identifier of the test. |

### Get test run history for a specific test
`GET https://apizie.tech/v1/communication:telnyx-2/get-test-runs-for-test-public-assistants-tests-test-id-runs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| test_id | string | yes | Unique identifier of the test. |
| status | string | no | Filter runs by execution status (pending, running, completed, failed, timeout) |
| page | object | no | Consolidated page parameter (deepObject style). Originally: page[size], page[number] |

### Trigger a manual test run
`POST https://apizie.tech/v1/communication:telnyx-2/trigger-test-run-public-assistants-tests-test-id-runs-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| test_id | string | yes | Unique identifier of the test. |
| Idempotency-Key | string | no | Optional opaque, unquoted key for safely retrying the same logical request. Keys must contain 1 to 255 letters, numbers, hyphens, or… |
| body | object | no | JSON request body |

### Get specific test run details
`GET https://apizie.tech/v1/communication:telnyx-2/get-test-run-public-assistants-tests-test-id-runs-run-id-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| test_id | string | yes | Unique identifier of the test. |
| run_id | string | yes | Unique identifier of the run. |

### Get an assistant
`GET https://apizie.tech/v1/communication:telnyx-2/get-assistant-public-assistants-assistant-id-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |
| fetch_dynamic_variables_from_webhook | boolean | no | Whether to fetch dynamic variables from the configured webhook. |
| from | string | no | Start of the filter range. |
| to | string | no | End of the filter range. |
| call_control_id | string | no | Filter results by call control id. |

### Update an assistant
`POST https://apizie.tech/v1/communication:telnyx-2/update-assistant-public-assistants-assistant-id-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |
| body | object | yes | JSON request body |

### Delete an assistant
`POST https://apizie.tech/v1/communication:telnyx-2/delete-assistant-public-assistants-assistant-id-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |
| hard_delete | boolean | no | Permanently delete the assistant immediately instead of soft-deleting it to the Recently Deleted list, where it stays restorable for 30… |

### Get Canary Deploy
`GET https://apizie.tech/v1/communication:telnyx-2/get-canary-deploy-assistants-assistant-id-canary-deploys-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |

### Create Canary Deploy
`POST https://apizie.tech/v1/communication:telnyx-2/create-canary-deploy-assistants-assistant-id-canary-deploys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |
| Idempotency-Key | string | no | Optional opaque, unquoted key for safely retrying the same logical request. Keys must contain 1 to 255 letters, numbers, hyphens, or… |
| body | object | yes | JSON request body |

### Update Canary Deploy
`POST https://apizie.tech/v1/communication:telnyx-2/update-canary-deploy-assistants-assistant-id-canary-deploys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |
| body | object | yes | JSON request body |

### Delete Canary Deploy
`POST https://apizie.tech/v1/communication:telnyx-2/delete-canary-deploy-assistants-assistant-id-canary-deploys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |

### Assistant Chat
`POST https://apizie.tech/v1/communication:telnyx-2/assistant-chat-public-assistants-assistant-id-chat-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |
| body | object | yes | JSON request body |

### Assistant Sms Chat
`POST https://apizie.tech/v1/communication:telnyx-2/assistant-sms-chat-assistants-assistant-id-chat-sms-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |
| Idempotency-Key | string | no | Optional opaque, unquoted key for safely retrying the same logical request. Keys must contain 1 to 255 letters, numbers, hyphens, or… |
| body | object | yes | JSON request body |

### Assistant WhatsApp Chat
`POST https://apizie.tech/v1/communication:telnyx-2/assistant-whatsapp-chat-assistants-assistant-id-chat-whatsap` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. Must be the assistant configured on the messaging profile of the `from` number. |
| Idempotency-Key | string | no | Optional opaque, unquoted key for safely retrying the same logical request. Keys must contain 1 to 255 letters, numbers, hyphens, or… |
| body | object | yes | JSON request body |

### Clone Assistant
`POST https://apizie.tech/v1/communication:telnyx-2/clone-assistant-public-assistants-assistant-id-clone-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |
| Idempotency-Key | string | no | Optional opaque, unquoted key for safely retrying the same logical request. Keys must contain 1 to 255 letters, numbers, hyphens, or… |

### Get a deleted assistant
`GET https://apizie.tech/v1/communication:telnyx-2/get-deleted-assistant-public-assistants-assistant-id-deleted` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |

### Enhance Assistant Instructions
`POST https://apizie.tech/v1/communication:telnyx-2/enhance-assistant-instructions-public-assistants-assistant-i` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |
| body | object | no | JSON request body |

### Restore an assistant
`POST https://apizie.tech/v1/communication:telnyx-2/restore-assistant-public-assistants-assistant-id-restore-pos` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |

### List scheduled events
`GET https://apizie.tech/v1/communication:telnyx-2/get-scheduled-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |
| from_date | string | no | Start of the date range filter (inclusive, ISO 8601). |
| to_date | string | no | End of the date range filter (inclusive, ISO 8601). |
| conversation_channel | string | no | Filter results by conversation channel. |
| page | object | no | Consolidated page parameter (deepObject style). Originally: page[size], page[number] |

### Create a scheduled event
`POST https://apizie.tech/v1/communication:telnyx-2/create-scheduled-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |
| Idempotency-Key | string | no | Optional opaque, unquoted key for safely retrying the same logical request. Keys must contain 1 to 255 letters, numbers, hyphens, or… |
| body | object | yes | JSON request body |

### Get a scheduled event
`GET https://apizie.tech/v1/communication:telnyx-2/get-scheduled-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |
| event_id | string | yes | Unique identifier of the event. |

### Delete a scheduled event
`POST https://apizie.tech/v1/communication:telnyx-2/delete-scheduled-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |
| event_id | string | yes | Unique identifier of the event. |

### Add Assistant Tag
`POST https://apizie.tech/v1/communication:telnyx-2/add-assistant-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |
| body | object | yes | JSON request body |

### Remove Assistant Tag
`POST https://apizie.tech/v1/communication:telnyx-2/remove-assistant-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |
| tag | string | yes | Unique identifier of the tag. |

### Get assistant texml
`GET https://apizie.tech/v1/communication:telnyx-2/get-assistant-texml-public-assistants-assistant-id-texml-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |

### Add Assistant Tool
`POST https://apizie.tech/v1/communication:telnyx-2/add-assistant-tool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |
| tool_id | string | yes | Unique identifier of the tool. |

### Remove Assistant Tool
`POST https://apizie.tech/v1/communication:telnyx-2/remove-assistant-tool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |
| tool_id | string | yes | Unique identifier of the tool. |

### Test Assistant Tool
`POST https://apizie.tech/v1/communication:telnyx-2/test-assistant-tool-public-assistants-assistant-id-tools-too` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |
| tool_id | string | yes | Unique identifier of the tool. |
| body | object | no | JSON request body |

### Get all versions of an assistant
`GET https://apizie.tech/v1/communication:telnyx-2/get-assistant-versions-public-assistants-assistant-id-versio` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |

### Get a specific assistant version
`GET https://apizie.tech/v1/communication:telnyx-2/get-assistant-version-public-assistants-assistant-id-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |
| version_id | string | yes | Unique identifier of the version. |
| include_mcp_servers | boolean | no | Whether to include MCP servers in the response. |

### Update a specific assistant version
`POST https://apizie.tech/v1/communication:telnyx-2/update-assistant-version-public-assistants-assistant-id-vers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |
| version_id | string | yes | Unique identifier of the version. |
| body | object | yes | JSON request body |

### Delete a specific assistant version
`POST https://apizie.tech/v1/communication:telnyx-2/delete-assistant-version-public-assistants-assistant-id-vers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |
| version_id | string | yes | Unique identifier of the version. |

### Promote an assistant version to main
`POST https://apizie.tech/v1/communication:telnyx-2/promote-assistant-version-public-assistants-assistant-id-ver` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assistant_id | string | yes | Unique identifier of the assistant. |
| version_id | string | yes | Unique identifier of the version. |

### Transcribe speech to text
`POST https://apizie.tech/v1/communication:telnyx-2/audio-public-audio-transcriptions-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | Form fields as a JSON object |

### List avatars
`GET https://apizie.tech/v1/communication:telnyx-2/list-avatars-public-avatars-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page[size] | integer | no | Number of avatars to return per page. |
| page[number] | integer | no | Page number to retrieve, starting at 1. |
| filter[name] | string | no | Return avatars whose names contain this value, using case-insensitive matching. |
| filter[id] | string | no | Return the avatar with this exact ID. |
| filter[avatar_type] | string | no | Return only stock or custom avatars. |

### Create a custom avatar
`POST https://apizie.tech/v1/communication:telnyx-2/create-avatar-public-avatars-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | Form fields as a JSON object |

### Get an avatar
`GET https://apizie.tech/v1/communication:telnyx-2/get-avatar-public-avatars-avatar-id-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| avatar_id | string | yes | Stable identifier of a Telnyx stock avatar or an organization-owned custom avatar. |

### Update a custom avatar
`POST https://apizie.tech/v1/communication:telnyx-2/update-avatar-public-avatars-avatar-id-patch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| avatar_id | string | yes | Stable identifier of a Telnyx stock avatar or an organization-owned custom avatar. |
| body | object | yes | JSON request body |

### List all clusters
`GET https://apizie.tech/v1/communication:telnyx-2/list-all-requested-clusters-public-text-clusters-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | object | no | Consolidated page parameter (deepObject style). Originally: page[number], page[size] |

### Compute new clusters
`POST https://apizie.tech/v1/communication:telnyx-2/compute-new-cluster-public-text-clusters-post` (byok)

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

### Fetch a cluster
`GET https://apizie.tech/v1/communication:telnyx-2/fetch-cluster-by-task-id-public-text-clusters-task-id-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| task_id | string | yes | Unique identifier of the task. |
| top_n_nodes | integer | no | The number of nodes in the cluster to return in the response. Nodes will be sorted by their centrality within the cluster. |
| show_subclusters | boolean | no | Whether or not to include subclusters and their nodes in the response. |

…and 280 more. See the OpenAPI spec.

## Example
```
curl "https://apizie.tech/v1/communication:telnyx-2/get-oauth-authorization-server-metadata" \
  -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 GET https://apizie.tech/v1/communication:telnyx-2/get-oauth-authorization-server-metadata 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.

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

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