NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Telnyx

telnyx

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

Phone & SMSCommunicationWeb del proveedor
Acciones
28
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (28)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create NetworkTELNYX_CREATE_NETWORKAcción

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

Parámetros de entrada

  • namestringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Details of the newly created network.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Notification ChannelTELNYX_CREATE_NOTIFICATION_CHANNELAcción

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.

Parámetros de entrada

  • channel_type_idstringObligatorioenum

    Type of channel. Must be one of 'sms', 'voice', 'email', or 'webhook'.

    smsvoiceemailwebhook
  • channel_destinationstringObligatorio

    Destination for the channel (e.g., phone number, email address, or webhook URL).

  • notification_profile_idstringObligatorio

    A UUID reference to the associated Notification Profile.

Parámetros de salida

  • dataobjectObligatorio

    Response data containing the created notification channel.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Notification ProfileTELNYX_CREATE_NOTIFICATION_PROFILEAcción

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

Parámetros de entrada

  • namestringObligatorio

    A human-readable name for the notification profile.

Parámetros de salida

  • dataobjectObligatorio

    Response data containing the created notification profile.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Notification SettingTELNYX_CREATE_NOTIFICATION_SETTINGAcción

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

Parámetros de entrada

  • parametersobject[]

    Optional list of key/value parameters for this notification setting.

  • notification_channel_idstringObligatorio

    UUID reference to the associated Notification Channel.

  • notification_profile_idstringObligatorio

    UUID reference to the associated Notification Profile.

  • notification_event_condition_idstringObligatorio

    UUID reference to the associated Notification Event Condition.

Parámetros de salida

  • dataobjectObligatorio

    Response data containing the created notification setting.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete NetworkTELNYX_DELETE_NETWORKAcción

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

Parámetros de entrada

  • network_idstringObligatorio

    Unique identifier for the network to delete.

Parámetros de salida

  • dataobjectObligatorio

    Response data for the delete network action.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Notification ChannelTELNYX_DELETE_NOTIFICATION_CHANNELAcción

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

Parámetros de entrada

  • notification_channel_idstringObligatorio

    Unique identifier for the notification channel to delete.

Parámetros de salida

  • dataobjectObligatorio

    Response data for the deleted notification channel.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Notification ProfileTELNYX_DELETE_NOTIFICATION_PROFILEAcción

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

Parámetros de entrada

  • notification_profile_idstringObligatorio

    Unique identifier for the notification profile to delete.

Parámetros de salida

  • dataobjectObligatorio

    Response data for the deleted notification profile.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Notification SettingTELNYX_DELETE_NOTIFICATION_SETTINGAcción

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

Parámetros de entrada

  • notification_setting_idstringObligatorio

    Unique identifier for the notification setting to delete.

Parámetros de salida

  • dataobjectObligatorio

    Response data for the deleted notification setting.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get User BalanceTELNYX_GET_USER_BALANCEAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Response data containing account balance details.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Audit LogsTELNYX_LIST_AUDIT_LOGSAcción

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.

Parámetros de entrada

  • sortstringenum

    Sort order of results by creation date: 'asc' or 'desc'.

    ascdesc
  • 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.

Parámetros de salida

  • dataobject[]Obligatorio

    List of audit log entries.

  • metaobjectObligatorio

    Pagination metadata.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List ConnectionsTELNYX_LIST_CONNECTIONSAcción

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

Parámetros de entrada

  • sortstring

    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.

  • filter[connection_name][contains]string

    If present, returns connections with `connection_name` containing the given value. Case-insensitive; requires at least three characters.

  • filter[outbound_voice_profile_id]integer

    Identifies the associated outbound voice profile.

Parámetros de salida

  • dataobject[]Obligatorio

    List of connection objects.

  • metaobjectObligatorio

    Pagination metadata.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Dynamic Emergency EndpointsTELNYX_LIST_DYNAMIC_EMERGENCY_ENDPOINTSAcción

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

Parámetros de entrada

  • page[size]integer

    Number of items per page (1–250).

  • page[number]integer

    Page number to load (must be >= 1).

  • filter[status]stringenum

    Filter by endpoint status. Possible values: 'pending', 'activated', 'rejected'.

    pendingactivatedrejected
  • filter[country_code]string

    Filter by ISO 3166-1 alpha-2 country code (e.g., 'US', 'CA').

Parámetros de salida

  • dataobject[]Obligatorio

    List of dynamic emergency endpoint records.

  • metaobjectObligatorio

    Pagination metadata for the response.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Messaging ProfilesTELNYX_LIST_MESSAGING_PROFILESAcción

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

Parámetros de entrada

  • page[size]integer

    Number of results per page (1–250).

  • page[number]integer

    Page number for pagination (starts at 1).

Parámetros de salida

  • dataobject[]Obligatorio

    List of messaging profile records.

  • metaobjectObligatorio

    Pagination metadata.

  • errorstring

    Error if any occurred during the execution of the action

  • linksobject

    Pagination links for navigating list results.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Messaging URL DomainsTELNYX_LIST_MESSAGING_URL_DOMAINSAcción

Tool to list configured messaging url domains. use when you need to retrieve messaging url domains for a profile.

Parámetros de entrada

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

Parámetros de salida

  • dataobject[]Obligatorio

    List of messaging URL domain objects.

  • metaobjectObligatorio

    Pagination metadata.

  • errorstring

    Error if any occurred during the execution of the action

  • linksobject

    Pagination links for navigating results.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Mobile Network OperatorsTELNYX_LIST_MOBILE_NETWORK_OPERATORSAcción

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

Parámetros de entrada

  • page[size]integer

    Number of results per page (maximum 100).

  • page[number]integer

    Page number for pagination (starting at 1).

  • filter[country_code]string

    Filter operators by country code (ISO 3166-1 alpha-2).

  • filter[operator_name]string

    Filter operators by operator name.

Parámetros de salida

  • dataobject[]Obligatorio

    List of mobile network operators.

  • metaobjectObligatorio

    Pagination metadata.

  • errorstring

    Error if any occurred during the execution of the action

  • linksobjectObligatorio

    Pagination links.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Network InterfacesTELNYX_LIST_NETWORK_INTERFACESAcción

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

Parámetros de entrada

  • network_idstringObligatorio

    Unique identifier (UUID) of the network to list interfaces for.

  • page[size]integer

    Number of results per page. Default is 20. Must be between 1 and 250.

  • 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]stringenum

    Filter results by interface status.

    createdprovisioningprovisioneddeleting

Parámetros de salida

  • dataobject[]Obligatorio

    List of network interface objects.

  • metaobjectObligatorio

    Pagination metadata.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List NetworksTELNYX_LIST_NETWORKSAcción

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

Parámetros de entrada

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

Parámetros de salida

  • dataobject[]Obligatorio

    List of network objects.

  • metaobjectObligatorio

    Pagination metadata.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Notification ChannelsTELNYX_LIST_NOTIFICATION_CHANNELSAcción

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

Parámetros de entrada

  • 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][eq]string

    Filter by the ID of the channel type. Possible values: 'webhook', 'sms', 'email', 'voice'.

Parámetros de salida

  • dataobject[]Obligatorio

    List of notification channel objects.

  • metaobjectObligatorio

    Pagination metadata.

  • errorstring

    Error if any occurred during the execution of the action

  • linksobjectObligatorio

    Pagination links.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Notification Event ConditionsTELNYX_LIST_NOTIFICATION_EVENT_CONDITIONSAcción

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

Parámetros de entrada

  • 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]stringenum

    Filter by associated record type. Allowed values: 'account', 'phone_number'.

    accountphone_number

Parámetros de salida

  • dataobject[]Obligatorio

    List of notification event condition objects.

  • metaobjectObligatorio

    Pagination metadata.

  • errorstring

    Error if any occurred during the execution of the action

  • linksobject

    Pagination links for navigating list results.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Notification EventsTELNYX_LIST_NOTIFICATION_EVENTSAcción

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

Parámetros de entrada

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Notification ProfilesTELNYX_LIST_NOTIFICATION_PROFILESAcción

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

Parámetros de entrada

  • page[size]integer

    Number of results per page. Defaults to 20.

  • page[number]integer

    Page number for pagination. Defaults to 1.

Parámetros de salida

  • dataobject[]Obligatorio

    List of notification profiles.

  • metaobjectObligatorio

    Pagination metadata.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Phone NumbersTELNYX_LIST_PHONE_NUMBERSAcción

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.

Parámetros de entrada

  • sortstring

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

Parámetros de salida

  • dataobject[]Obligatorio

    List of phone number records.

  • metaobjectObligatorio

    Pagination metadata.

  • errorstring

    Error if any occurred during the execution of the action

  • linksobject

    Pagination links for navigating list results.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List SSO Authentication ProvidersTELNYX_LIST_SSO_AUTHENTICATION_PROVIDERSAcción

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

Parámetros de entrada

  • sortstringenum

    Sort order for results. Prefix field with '-' for descending order.

    name-nameshort_name-short_nameactive-activecreated_at-created_atupdated_at-updated_at
  • page[size]integer

    Size of the page. Must be between 1 and 250.

  • page[number]integer

    The page number to load. Must be ≥ 1.

Parámetros de salida

  • dataobject[]Obligatorio

    List of authentication provider records.

  • metaobjectObligatorio

    Pagination metadata.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve NetworkTELNYX_RETRIEVE_NETWORKAcción

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.

Parámetros de entrada

  • network_idstringObligatorio

    Unique identifier (UUID) of the network to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Response data containing the network details.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve Notification ChannelTELNYX_RETRIEVE_NOTIFICATION_CHANNELAcción

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.

Parámetros de entrada

  • idstringObligatorio

    Unique identifier of the notification channel to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Notification channel resource wrapper.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve Notification ProfileTELNYX_RETRIEVE_NOTIFICATION_PROFILEAcción

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.

Parámetros de entrada

  • idstringObligatorio

    Unique identifier of the notification profile to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Notification profile resource wrapper.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve Notification SettingTELNYX_RETRIEVE_NOTIFICATION_SETTINGAcción

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.

Parámetros de entrada

  • idstringObligatorio

    Unique identifier of the notification setting to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    The retrieved notification setting object.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update NetworkTELNYX_UPDATE_NETWORKAcción

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

Parámetros de entrada

  • namestring

    New name for the network.

  • tagsstring[]

    List of tags to assign to the network.

  • network_idstringObligatorio

    Unique identifier for the network to update.

Parámetros de salida

  • dataobjectObligatorio

    Response data containing the updated network details.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not