Telnyx

Learn how to use Telnyx with Composio

Overview

SLUG

TELNYX

Description

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

Authentication Details

generic_api_key
stringRequired

Tools

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.

Action Parameters

channel_destination
stringRequired
channel_type_id
stringRequired
notification_profile_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: TELNYX_CREATE_NETWORK

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

Action Parameters

name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: TELNYX_CREATE_NOTIFICATION_PROFILE

Tool to create a notification profile. use when you need to register a new profile to group notification channels and define notification settings.

Action Parameters

name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: TELNYX_CREATE_NOTIFICATION_SETTING

Tool to add a notification setting. use after creating the event condition, profile, and channel.

Action Parameters

notification_channel_id
stringRequired
notification_event_condition_id
stringRequired
notification_profile_id
stringRequired
parameters
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

network_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

notification_channel_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

notification_profile_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

notification_setting_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

filter[created_after]
string
filter[created_before]
string
page[number]
integer
page[size]
integer
sort
string

Action Response

data
arrayRequired
error
string
meta
objectRequired
successful
booleanRequired

SLUG: TELNYX_LIST_CONNECTIONS

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

Action Parameters

filter[connection_name][contains]
string
filter[outbound_voice_profile_id]
integer
page[number]
integerDefaults to 1
page[size]
integerDefaults to 250
sort
string

Action Response

data
arrayRequired
error
string
meta
objectRequired
successful
booleanRequired

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".

Action Parameters

filter[country_code]
string
filter[status]
string
page[number]
integerDefaults to 1
page[size]
integerDefaults to 20

Action Response

data
arrayRequired
error
string
meta
objectRequired
successful
booleanRequired

SLUG: TELNYX_LIST_MESSAGING_PROFILES

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

Action Parameters

page[number]
integerDefaults to 1
page[size]
integerDefaults to 20

Action Response

data
arrayRequired
error
string
links
object
meta
objectRequired
successful
booleanRequired

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.

Action Parameters

filter[profile_id]
string
page[number]
integerDefaults to 1
page[size]
integerDefaults to 20

Action Response

data
arrayRequired
error
string
links
object
meta
objectRequired
successful
booleanRequired

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.

Action Parameters

filter[country_code]
string
filter[operator_name]
string
page[number]
integer
page[size]
integer

Action Response

data
arrayRequired
error
string
links
objectRequired
meta
objectRequired
successful
booleanRequired

SLUG: TELNYX_LIST_NETWORKS

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

Action Parameters

filter[name]
string
page[number]
integerDefaults to 1
page[size]
integerDefaults to 20

Action Response

data
arrayRequired
error
string
meta
objectRequired
successful
booleanRequired

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.

Action Parameters

filter[name]
string
filter[status]
string
filter[type]
string
network_id
stringRequired
page[number]
integerDefaults to 1
page[size]
integerDefaults to 20

Action Response

data
arrayRequired
error
string
meta
objectRequired
successful
booleanRequired

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.

Action Parameters

filter[channel_type_id][eq]
string
page[number]
integerDefaults to 1
page[size]
integerDefaults to 20

Action Response

data
arrayRequired
error
string
links
objectRequired
meta
objectRequired
successful
booleanRequired

SLUG: TELNYX_LIST_NOTIFICATION_EVENTS

Tool to list all notification events. use when you need to retrieve and paginate available notification events.

Action Parameters

page[number]
integerDefaults to 1
page[size]
integerDefaults to 20

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

filter[associated_record_type][eq]
string
page[number]
integerDefaults to 1
page[size]
integerDefaults to 20

Action Response

data
arrayRequired
error
string
links
object
meta
objectRequired
successful
booleanRequired

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.

Action Parameters

page[number]
integerDefaults to 1
page[size]
integerDefaults to 20

Action Response

data
arrayRequired
error
string
meta
objectRequired
successful
booleanRequired

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.

Action Parameters

filter[connection_id]
string
filter[national_destination_code]
string
filter[phone_number]
string
filter[status]
string
page[number]
integer
page[size]
integer
sort
string

Action Response

data
arrayRequired
error
string
links
object
meta
objectRequired
successful
booleanRequired

SLUG: TELNYX_LIST_SSO_AUTHENTICATION_PROVIDERS

Tool to retrieve all configured sso authentication providers. use after authenticating to enumerate your organization's sso providers.

Action Parameters

page[number]
integerDefaults to 1
page[size]
integerDefaults to 20
sort
stringDefaults to -created_at

Action Response

data
arrayRequired
error
string
meta
objectRequired
successful
booleanRequired

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.

Action Parameters

network_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

name
string
network_id
stringRequired
tags
array

Action Response

data
objectRequired
error
string
successful
booleanRequired