> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Telnyx

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

![Telnyx logo](https://mintcdn.com/composio-preview/IA0_SoMcsWt17HEC/images/toolkits/telnyx.svg?fit=max\&auto=format\&n=IA0_SoMcsWt17HEC\&q=85\&s=66ab6a23d6a0fb8b9828f954ab2d92b5)

* **Category:** phone & sms
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 30
* **Triggers:** 0
* **Slug:** `TELNYX`
* **Version:** 20261101\_00

## Tools

> [accordion] 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
>
> **name** `string` *required*
>
> A user-specified name for the network. Must be unique within your Telnyx account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **channel\_type\_id** `string ("sms" | "voice" | "email" | "webhook")` *required*
>
> Type of channel. Must be one of 'sms', 'voice', 'email', or 'webhook'.
>
> **channel\_destination** `string` *required*
>
> 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` *required*
>
> A UUID reference to the associated Notification Profile. The profile must already exist; call TELNYX\_CREATE\_NOTIFICATION\_PROFILE first to obtain this UUID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string` *required*
>
> A human-readable name for the notification profile.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **parameters** `array`
>
> Optional list of key/value parameters for this notification setting.
>
> **notification\_channel\_id** `string` *required*
>
> UUID reference to the associated Notification Channel.
>
> **notification\_profile\_id** `string` *required*
>
> UUID reference to the associated Notification Profile.
>
> **notification\_event\_condition\_id** `string` *required*
>
> UUID reference to the associated Notification Event Condition.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **network\_id** `string` *required*
>
> Unique identifier for the network to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **notification\_channel\_id** `string` *required*
>
> Unique identifier for the notification channel to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **notification\_profile\_id** `string` *required*
>
> Unique identifier for the notification profile to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **notification\_setting\_id** `string` *required*
>
> Unique identifier for the notification setting to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **filter** `object`
>
> Filter parameters for black box test results.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sort** `string ("asc" | "desc")`
>
> Sort order of results by creation date: 'asc' or 'desc'.
>
> **page\_size** `integer`
>
> Number of items per page.
>
> **page\_number** `integer`
>
> Page number to load (must be ≥ 1).
>
> **filter\_created\_after** `string`
>
> Filter for audit events created after this ISO 8601 timestamp.
>
> **filter\_created\_before** `string`
>
> Filter for audit events created before this ISO 8601 timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sort** `string`
>
> Specifies sort order: `created_at`, `connection_name`, or `active`. Prefix with '-' for descending, e.g., '-connection\_name'.
>
> **page\_size** `integer`
>
> Size of the page. Default is 250. Must be between 1 and 250.
>
> **page\_number** `integer`
>
> Page number to load. Default is 1. Must be ≥ 1.
>
> **connection\_name\_contains** `string`
>
> If present, returns connections with `connection_name` containing the given value. Case-insensitive; requires at least three characters.
>
> **outbound\_voice\_profile\_id** `integer`
>
> Identifies the associated outbound voice profile.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **status** `string ("pending" | "activated" | "rejected")`
>
> Filter by endpoint status. Possible values: 'pending', 'activated', 'rejected'.
>
> **page\_size** `integer`
>
> Number of items per page (1–250).
>
> **page\_number** `integer`
>
> Page number to load (must be >= 1).
>
> **country\_code** `string`
>
> Filter by ISO 3166-1 alpha-2 country code (e.g., 'US', 'CA').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **page\_size** `integer`
>
> Number of results per page (1–250).
>
> **page\_number** `integer`
>
> Page number for pagination (starts at 1).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **page\_size** `integer`
>
> Number of results per page. Defaults to 20; max is 100.
>
> **page\_number** `integer`
>
> Page number for pagination. Defaults to 1.
>
> **filter\_profile\_id** `string`
>
> Filter by messaging profile ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **page\_size** `integer`
>
> Number of results per page (maximum 100).
>
> **page\_number** `integer`
>
> Page number for pagination (starting at 1).
>
> **country\_code** `string`
>
> Filter operators by country code (ISO 3166-1 alpha-2).
>
> **operator\_name** `string`
>
> Filter operators by operator name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Network Interfaces
>
> **Slug:** `TELNYX_LIST_NETWORK_INTERFACES`
>
> List network interfaces for a specified network by ID, with pagination and optional name, type, and status filters. Each request retrieves one page.
>
> #### Input Parameters
>
> **page\_size** `integer`
>
> Number of results per page. Default is 20. Must be between 1 and 250.
>
> **network\_id** `string` *required*
>
> Unique identifier (UUID) of the network to list interfaces for.
>
> **filter\_name** `string`
>
> Filter results by interface name.
>
> **filter\_type** `string`
>
> Filter results by interface type.
>
> **page\_number** `integer`
>
> Page number to load. Default is 1. Must be ≥ 1.
>
> **filter\_status** `string ("created" | "provisioning" | "provisioned" | "deleting")`
>
> Filter results by interface status.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **page\_size** `integer`
>
> Size of the page. Default is 20. Must be ≥ 1.
>
> **filter\_name** `string`
>
> Filter results by network name.
>
> **page\_number** `integer`
>
> Page number to load. Default is 1. Must be ≥ 1.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **page\_size** `integer`
>
> Number of results per page. Defaults to 20; max is 100.
>
> **page\_number** `integer`
>
> Page number for pagination. Defaults to 1.
>
> **filter\_channel\_type\_id** `string`
>
> Filter by the ID of the channel type. Possible values: 'webhook', 'sms', 'email', 'voice'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **page\_size** `integer`
>
> Number of results per page. Defaults to 20; max is 250.
>
> **page\_number** `integer`
>
> Page number for pagination. Defaults to 1.
>
> **filter\_associated\_record\_type\_eq** `string ("account" | "phone_number")`
>
> Filter by associated record type. Allowed values: 'account', 'phone\_number'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Notification Events
>
> **Slug:** `TELNYX_LIST_NOTIFICATION_EVENTS`
>
> List a page of Telnyx notification events and their IDs. Choose the page number and page size to browse the available events; page size defaults to 20 and can be set from 1 to 250.
>
> #### Input Parameters
>
> **page\_size** `integer`
>
> Number of results per page (1–250). Defaults to 20.
>
> **page\_number** `integer`
>
> Page number to load (must be ≥ 1). Defaults to 1.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **page\_size** `integer`
>
> Number of results per page. Defaults to 20.
>
> **page\_number** `integer`
>
> Page number for pagination. Defaults to 1.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sort** `string`
>
> Comma-separated list of fields to sort by (e.g., 'phone\_number').
>
> **page\_size** `integer`
>
> Results per page; maximum 1000.
>
> **page\_number** `integer`
>
> Page number for results pagination (starts at 1).
>
> **filter\_status** `string`
>
> Filter numbers by status (e.g., 'ported\_in', 'ported\_away', 'provisioned').
>
> **filter\_phone\_number** `string`
>
> Return numbers matching this E.164 phone number format.
>
> **filter\_connection\_id** `string`
>
> Filter numbers by associated connection ID.
>
> **filter\_national\_destination\_code** `string`
>
> Return numbers with this National Destination Code (NDC).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **sort** `string ("name" | "-name" | "short_name" | "-short_name" | "active" | "-active" | "created_at" | "-created_at" | "updated_at" | "-updated_at")`
>
> Sort order for results. Prefix field with '-' for descending order.
>
> **page\_size** `integer`
>
> Size of the page. Must be between 1 and 250.
>
> **page\_number** `integer`
>
> The page number to load. Must be ≥ 1.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **network\_id** `string` *required*
>
> Unique identifier (UUID) of the network to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve Notification Channel
>
> **Slug:** `TELNYX_RETRIEVE_NOTIFICATION_CHANNEL`
>
> Retrieve a notification channel by ID, including its type, destination, and associated profile.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the notification channel to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **id** `string` *required*
>
> Unique identifier of the notification profile to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **id** `string` *required*
>
> Unique identifier of the notification setting to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string`
>
> New name for the network.
>
> **tags** `array`
>
> List of tags to assign to the network.
>
> **network\_id** `string` *required*
>
> Unique identifier for the network to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
