Skip to main content
Telnyx logo
  • Category: phone & sms
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 30
  • Triggers: 0
  • Slug: TELNYX
  • Version: 20261101_00

Tools

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

Input Parameters

string
required
A user-specified name for the network. Must be unique within your Telnyx account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_CREATE_NOTIFICATION_CHANNELTool 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

string ("sms" | "voice" | "email" | "webhook")
required
Type of channel. Must be one of ‘sms’, ‘voice’, ‘email’, or ‘webhook’.
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_CREATE_NOTIFICATION_PROFILETool 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

string
required
A human-readable name for the notification profile.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_CREATE_NOTIFICATION_SETTINGTool 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

array
Optional list of key/value parameters for this notification setting.
string
required
UUID reference to the associated Notification Channel.
string
required
UUID reference to the associated Notification Profile.
string
required
UUID reference to the associated Notification Event Condition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_DELETE_NETWORKTool to delete a network by ID. Use when you have obtained the network’s identifier and need to remove it permanently.

Input Parameters

string
required
Unique identifier for the network to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_DELETE_NOTIFICATION_CHANNELTool to delete a notification channel by ID. Use when you have the channel’s identifier and need to remove it permanently.

Input Parameters

string
required
Unique identifier for the notification channel to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_DELETE_NOTIFICATION_PROFILETool to delete a notification profile by ID. Use when you have the profile’s identifier and need to remove it permanently.

Input Parameters

string
required
Unique identifier for the notification profile to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_DELETE_NOTIFICATION_SETTINGTool to delete a notification setting by ID. Use when you need to permanently remove an existing notification setting before reconfiguration.

Input Parameters

string
required
Unique identifier for the notification setting to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_GET_BLACK_BOX_TEST_RESULTSTool 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

object
Filter parameters for black box test results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_GET_USER_BALANCETool to retrieve the current user account balance and credit details. Use after authenticating your account to check available balance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_LIST_AUDIT_LOGSTool 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

string ("asc" | "desc")
Sort order of results by creation date: ‘asc’ or ‘desc’.
integer
Number of items per page.
integer
Page number to load (must be ≥ 1).
string
Filter for audit events created after this ISO 8601 timestamp.
string
Filter for audit events created before this ISO 8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_LIST_CONNECTIONSTool to retrieve all connections in your account. Use when you need to list connections with pagination, filtering, and sorting.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_LIST_DYNAMIC_EMERGENCY_ENDPOINTSTool 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

string ("pending" | "activated" | "rejected")
Filter by endpoint status. Possible values: ‘pending’, ‘activated’, ‘rejected’.
integer
Number of items per page (1–250).
integer
Page number to load (must be >= 1).
string
Filter by ISO 3166-1 alpha-2 country code (e.g., ‘US’, ‘CA’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_LIST_GLOBAL_IP_HEALTH_CHECK_TYPESTool to list all available global IP health check types. Use when you need to retrieve supported health check types for global IP configurations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_LIST_MESSAGING_PROFILESTool to list messaging profiles. Use when you need to retrieve messaging profiles with optional pagination.

Input Parameters

integer
Number of results per page (1–250).
integer
Page number for pagination (starts at 1).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_LIST_MESSAGING_URL_DOMAINSTool to list configured messaging URL domains. Use when you need to retrieve messaging URL domains for a profile.

Input Parameters

integer
Number of results per page. Defaults to 20; max is 100.
integer
Page number for pagination. Defaults to 1.
string
Filter by messaging profile ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_LIST_MOBILE_NETWORK_OPERATORSTool 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

integer
Number of results per page (maximum 100).
integer
Page number for pagination (starting at 1).
string
Filter operators by country code (ISO 3166-1 alpha-2).
string
Filter operators by operator name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_LIST_NETWORK_INTERFACESList network interfaces for a specified network by ID, with pagination and optional name, type, and status filters. Each request retrieves one page.

Input Parameters

integer
Number of results per page. Default is 20. Must be between 1 and 250.
string
required
Unique identifier (UUID) of the network to list interfaces for.
string
Filter results by interface name.
string
Filter results by interface type.
integer
Page number to load. Default is 1. Must be ≥ 1.
string ("created" | "provisioning" | "provisioned" | "deleting")
Filter results by interface status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_LIST_NETWORKSTool to list all networks in your account. Use when you need to retrieve networks with optional pagination and filtering.

Input Parameters

integer
Size of the page. Default is 20. Must be ≥ 1.
string
Filter results by network name.
integer
Page number to load. Default is 1. Must be ≥ 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_LIST_NOTIFICATION_CHANNELSTool to list all notification channels. Use when you need to retrieve and paginate existing notification channels, optionally filtering by channel type.

Input Parameters

integer
Number of results per page. Defaults to 20; max is 100.
integer
Page number for pagination. Defaults to 1.
string
Filter by the ID of the channel type. Possible values: ‘webhook’, ‘sms’, ‘email’, ‘voice’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_LIST_NOTIFICATION_EVENT_CONDITIONSTool 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

integer
Number of results per page. Defaults to 20; max is 250.
integer
Page number for pagination. Defaults to 1.
string ("account" | "phone_number")
Filter by associated record type. Allowed values: ‘account’, ‘phone_number’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_LIST_NOTIFICATION_EVENTSList 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

integer
Number of results per page (1–250). Defaults to 20.
integer
Page number to load (must be ≥ 1). Defaults to 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_LIST_NOTIFICATION_PROFILESTool to list all notification profiles. Use when you need to retrieve and paginate your notification profiles with optional pagination.

Input Parameters

integer
Number of results per page. Defaults to 20.
integer
Page number for pagination. Defaults to 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_LIST_PHONE_NUMBERSTool 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

string
Comma-separated list of fields to sort by (e.g., ‘phone_number’).
integer
Results per page; maximum 1000.
integer
Page number for results pagination (starts at 1).
string
Filter numbers by status (e.g., ‘ported_in’, ‘ported_away’, ‘provisioned’).
string
Return numbers matching this E.164 phone number format.
string
Filter numbers by associated connection ID.
string
Return numbers with this National Destination Code (NDC).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_LIST_SSO_AUTHENTICATION_PROVIDERSTool to retrieve all configured SSO authentication providers. Use after authenticating to enumerate your organization’s SSO providers.

Input Parameters

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.
integer
Size of the page. Must be between 1 and 250.
integer
The page number to load. Must be ≥ 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_RETRIEVE_NETWORKTool 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

string
required
Unique identifier (UUID) of the network to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_RETRIEVE_NOTIFICATION_CHANNELRetrieve a notification channel by ID, including its type, destination, and associated profile.

Input Parameters

string
required
Unique identifier of the notification channel to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_RETRIEVE_NOTIFICATION_PROFILETool 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

string
required
Unique identifier of the notification profile to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_RETRIEVE_NOTIFICATION_SETTINGTool 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

string
required
Unique identifier of the notification setting to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TELNYX_UPDATE_NETWORKTool 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

string
New name for the network.
array
List of tags to assign to the network.
string
required
Unique identifier for the network to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not