# Telnyx

Telnyx is a communications platform offering voice, messaging, and data services through a global private network.

- **Category:** phone & sms
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 30
- **Triggers:** 0
- **Slug:** `TELNYX`
- **Version:** 20260316_00

## Tools

### Create Network

**Slug:** `TELNYX_CREATE_NETWORK`

Tool to create a new network. Use when you need to provision a fresh network resource before connecting devices.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | A user-specified name for the network. Must be unique within your Telnyx account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Notification Channel

**Slug:** `TELNYX_CREATE_NOTIFICATION_CHANNEL`

Tool to create a notification channel. Use when you need to register a channel (SMS, voice, email, or webhook) to receive notifications. E.g., create a webhook channel for event callbacks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_type_id` | string ("sms" | "voice" | "email" | "webhook") | Yes | Type of channel. Must be one of 'sms', 'voice', 'email', or 'webhook'. |
| `channel_destination` | string | Yes | Destination for the channel (e.g., phone number, email address, or webhook URL). For 'webhook' channels, the URL must be publicly reachable by Telnyx. |
| `notification_profile_id` | string | Yes | A UUID reference to the associated Notification Profile. The profile must already exist; call TELNYX_CREATE_NOTIFICATION_PROFILE first to obtain this UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Notification Profile

**Slug:** `TELNYX_CREATE_NOTIFICATION_PROFILE`

Tool to create a notification profile. Use when you need to register a new profile to group notification channels (SMS and voice) and define notification settings. Must be called before TELNYX_CREATE_NOTIFICATION_CHANNEL, as channel creation requires the notification_profile_id returned by this tool.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | A human-readable name for the notification profile. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Notification Setting

**Slug:** `TELNYX_CREATE_NOTIFICATION_SETTING`

Tool to add a notification setting. Use after creating the event condition, profile, and channel. All three UUID parameters must be fetched dynamically from their respective list/create endpoints; hardcoded IDs are not portable across accounts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `parameters` | array | No | Optional list of key/value parameters for this notification setting. |
| `notification_channel_id` | string | Yes | UUID reference to the associated Notification Channel. |
| `notification_profile_id` | string | Yes | UUID reference to the associated Notification Profile. |
| `notification_event_condition_id` | string | Yes | UUID reference to the associated Notification Event Condition. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Network

**Slug:** `TELNYX_DELETE_NETWORK`

Tool to delete a network by ID. Use when you have obtained the network's identifier and need to remove it permanently.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `network_id` | string | Yes | Unique identifier for the network to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Notification Channel

**Slug:** `TELNYX_DELETE_NOTIFICATION_CHANNEL`

Tool to delete a notification channel by ID. Use when you have the channel's identifier and need to remove it permanently.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notification_channel_id` | string | Yes | Unique identifier for the notification channel to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Notification Profile

**Slug:** `TELNYX_DELETE_NOTIFICATION_PROFILE`

Tool to delete a notification profile by ID. Use when you have the profile's identifier and need to remove it permanently.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notification_profile_id` | string | Yes | Unique identifier for the notification profile to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Notification Setting

**Slug:** `TELNYX_DELETE_NOTIFICATION_SETTING`

Tool to delete a notification setting by ID. Use when you need to permanently remove an existing notification setting before reconfiguration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notification_setting_id` | string | Yes | Unique identifier for the notification setting to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Black Box Test Results

**Slug:** `TELNYX_GET_BLACK_BOX_TEST_RESULTS`

Tool to retrieve black box test results from Telnyx SETI Observability. Use when you need to check service health and test results, optionally filtering by product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | object | No | Filter parameters for black box test results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Balance

**Slug:** `TELNYX_GET_USER_BALANCE`

Tool to retrieve the current user account balance and credit details. Use after authenticating your account to check available balance.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Audit Logs

**Slug:** `TELNYX_LIST_AUDIT_LOGS`

Tool to retrieve a list of audit log entries for your account. Use when you need to review recent resource changes with optional pagination and date filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("asc" | "desc") | No | Sort order of results by creation date: 'asc' or 'desc'. |
| `page_size` | integer | No | Number of items per page. |
| `page_number` | integer | No | Page number to load (must be ≥ 1). |
| `filter_created_after` | string | No | Filter for audit events created after this ISO 8601 timestamp. |
| `filter_created_before` | string | No | Filter for audit events created before this ISO 8601 timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Connections

**Slug:** `TELNYX_LIST_CONNECTIONS`

Tool to retrieve all connections in your account. Use when you need to list connections with pagination, filtering, and sorting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Specifies sort order: `created_at`, `connection_name`, or `active`. Prefix with '-' for descending, e.g., '-connection_name'. |
| `page_size` | integer | No | Size of the page. Default is 250. Must be between 1 and 250. |
| `page_number` | integer | No | Page number to load. Default is 1. Must be ≥ 1. |
| `connection_name_contains` | string | No | If present, returns connections with `connection_name` containing the given value. Case-insensitive; requires at least three characters. |
| `outbound_voice_profile_id` | integer | No | Identifies the associated outbound voice profile. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Dynamic Emergency Endpoints

**Slug:** `TELNYX_LIST_DYNAMIC_EMERGENCY_ENDPOINTS`

Tool to list dynamic emergency endpoints. Use when you need to retrieve dynamic emergency endpoint records, optionally filtered by status or country. Example: "List all activated endpoints in US".

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("pending" | "activated" | "rejected") | No | Filter by endpoint status. Possible values: 'pending', 'activated', 'rejected'. |
| `page_size` | integer | No | Number of items per page (1–250). |
| `page_number` | integer | No | Page number to load (must be >= 1). |
| `country_code` | string | No | Filter by ISO 3166-1 alpha-2 country code (e.g., 'US', 'CA'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Global IP Health Check Types

**Slug:** `TELNYX_LIST_GLOBAL_IP_HEALTH_CHECK_TYPES`

Tool to list all available global IP health check types. Use when you need to retrieve supported health check types for global IP configurations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Messaging Profiles

**Slug:** `TELNYX_LIST_MESSAGING_PROFILES`

Tool to list messaging profiles. Use when you need to retrieve messaging profiles with optional pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of results per page (1–250). |
| `page_number` | integer | No | Page number for pagination (starts at 1). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Messaging URL Domains

**Slug:** `TELNYX_LIST_MESSAGING_URL_DOMAINS`

Tool to list configured messaging URL domains. Use when you need to retrieve messaging URL domains for a profile.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of results per page. Defaults to 20; max is 100. |
| `page_number` | integer | No | Page number for pagination. Defaults to 1. |
| `filter_profile_id` | string | No | Filter by messaging profile ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Mobile Network Operators

**Slug:** `TELNYX_LIST_MOBILE_NETWORK_OPERATORS`

Tool to list available mobile network operators. Use when you need to discover operators optionally filtered by country code, operator name, or with pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of results per page (maximum 100). |
| `page_number` | integer | No | Page number for pagination (starting at 1). |
| `country_code` | string | No | Filter operators by country code (ISO 3166-1 alpha-2). |
| `operator_name` | string | No | Filter operators by operator name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Network Interfaces

**Slug:** `TELNYX_LIST_NETWORK_INTERFACES`

Tool to list all network interfaces for a specified network. Use after retrieving a network's ID to enumerate its interfaces.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of results per page. Default is 20. Must be between 1 and 250. |
| `network_id` | string | Yes | Unique identifier (UUID) of the network to list interfaces for. |
| `filter_name` | string | No | Filter results by interface name. |
| `filter_type` | string | No | Filter results by interface type. |
| `page_number` | integer | No | Page number to load. Default is 1. Must be ≥ 1. |
| `filter_status` | string ("created" | "provisioning" | "provisioned" | "deleting") | No | Filter results by interface status. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Networks

**Slug:** `TELNYX_LIST_NETWORKS`

Tool to list all networks in your account. Use when you need to retrieve networks with optional pagination and filtering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Size of the page. Default is 20. Must be ≥ 1. |
| `filter_name` | string | No | Filter results by network name. |
| `page_number` | integer | No | Page number to load. Default is 1. Must be ≥ 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Notification Channels

**Slug:** `TELNYX_LIST_NOTIFICATION_CHANNELS`

Tool to list all notification channels. Use when you need to retrieve and paginate existing notification channels, optionally filtering by channel type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of results per page. Defaults to 20; max is 100. |
| `page_number` | integer | No | Page number for pagination. Defaults to 1. |
| `filter_channel_type_id` | string | No | Filter by the ID of the channel type. Possible values: 'webhook', 'sms', 'email', 'voice'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Notification Event Conditions

**Slug:** `TELNYX_LIST_NOTIFICATION_EVENT_CONDITIONS`

Tool to list all notification event conditions. Use when you need to retrieve and paginate notification event conditions, optionally filtering by associated record type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of results per page. Defaults to 20; max is 250. |
| `page_number` | integer | No | Page number for pagination. Defaults to 1. |
| `filter_associated_record_type_eq` | string ("account" | "phone_number") | No | Filter by associated record type. Allowed values: 'account', 'phone_number'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Notification Events

**Slug:** `TELNYX_LIST_NOTIFICATION_EVENTS`

Tool to list all notification events with their IDs. Use to dynamically retrieve notification_event_condition_id values before configuring webhook subscriptions — IDs are account-specific and must not be hardcoded, as stale IDs silently prevent events (e.g., call routing, recording) from reaching the webhook.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of results per page (1–250). Defaults to 20. |
| `page_number` | integer | No | Page number to load (must be ≥ 1). Defaults to 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Notification Profiles

**Slug:** `TELNYX_LIST_NOTIFICATION_PROFILES`

Tool to list all notification profiles. Use when you need to retrieve and paginate your notification profiles with optional pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of results per page. Defaults to 20. |
| `page_number` | integer | No | Page number for pagination. Defaults to 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Phone Numbers

**Slug:** `TELNYX_LIST_PHONE_NUMBERS`

Tool to list phone numbers associated with your account. Use when you need to retrieve and filter your phone numbers with optional pagination and sorting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Comma-separated list of fields to sort by (e.g., 'phone_number'). |
| `page_size` | integer | No | Results per page; maximum 1000. |
| `page_number` | integer | No | Page number for results pagination (starts at 1). |
| `filter_status` | string | No | Filter numbers by status (e.g., 'ported_in', 'ported_away', 'provisioned'). |
| `filter_phone_number` | string | No | Return numbers matching this E.164 phone number format. |
| `filter_connection_id` | string | No | Filter numbers by associated connection ID. |
| `filter_national_destination_code` | string | No | Return numbers with this National Destination Code (NDC). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List SSO Authentication Providers

**Slug:** `TELNYX_LIST_SSO_AUTHENTICATION_PROVIDERS`

Tool to retrieve all configured SSO authentication providers. Use after authenticating to enumerate your organization's SSO providers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("name" | "-name" | "short_name" | "-short_name" | "active" | "-active" | "created_at" | "-created_at" | "updated_at" | "-updated_at") | No | Sort order for results. Prefix field with '-' for descending order. |
| `page_size` | integer | No | Size of the page. Must be between 1 and 250. |
| `page_number` | integer | No | The page number to load. Must be ≥ 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Network

**Slug:** `TELNYX_RETRIEVE_NETWORK`

Tool to retrieve details of a specific network by ID. Use after obtaining the network's identifier to fetch its current attributes before update or delete operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `network_id` | string | Yes | Unique identifier (UUID) of the network to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Notification Channel

**Slug:** `TELNYX_RETRIEVE_NOTIFICATION_CHANNEL`

Tool to retrieve a notification channel by ID. Use after you have a channel ID and need its details, such as name, type, and status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the notification channel to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Notification Profile

**Slug:** `TELNYX_RETRIEVE_NOTIFICATION_PROFILE`

Tool to retrieve a notification profile by ID. Use after obtaining the profile ID when you need details about its webhook endpoints and subscribed events.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the notification profile to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Notification Setting

**Slug:** `TELNYX_RETRIEVE_NOTIFICATION_SETTING`

Tool to retrieve a notification setting by ID. Use after obtaining the notification setting ID to fetch its details, such as status, parameters, and associated channel.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the notification setting to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Network

**Slug:** `TELNYX_UPDATE_NETWORK`

Tool to update details of an existing network. Use when you have a network's identifier and need to modify its name or tags.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New name for the network. |
| `tags` | array | No | List of tags to assign to the network. |
| `network_id` | string | Yes | Unique identifier for the network to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |