Skip to main content
Twilio logo
  • Category: communication
  • Auth: API_KEY, BASIC, S2S_OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 454
  • Triggers: 45
  • Slug: TWILIO
  • Version: 00000000_00

Tools

Slug: TWILIO_CONVERSATIONS_CREATE_CONFIGURATION_ADDRESSCreate a new address configuration

Input Parameters

string ("sms" | "whatsapp" | "messenger" | "gbm" | "email" | "rcs" | "apple" | "chat")
required
Type of Address, value can be whatsapp or sms.
string
required
The unique address to be configured. The address can be a whatsapp address or phone number
string
The human-readable name of this configuration, limited to 256 characters. Optional.
string
An ISO 3166-1 alpha-2n country code which the address belongs to. This is currently only applicable to short code addresses.
string ("webhook" | "studio" | "default")
Twilio AutoCreation.Type request value.
boolean
Enable/Disable auto-creating conversations for messages to this address
string
For type webhook, the url for the webhook request.
string ("get" | "post")
Twilio AutoCreation.WebhookMethod request value.
string
For type studio, the studio flow SID where the webhook should be sent to.
array
The list of events, firing webhook event for this Conversation. Values can be any of the following: onMessageAdded, onMessageUpdated, onMessageRemoved, onConversationUpdated, onConversationStateUpdated, onConversationRemoved, onParticipantAdded, onParticipantUpdated, onParticipantRemoved, onDeliveryUpdated
integer
For type studio, number of times to retry the webhook request
string
Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.

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: TWILIO_CONVERSATIONS_CREATE_CONVERSATIONCreate a new conversation in your account’s default service

Input Parameters

string ("initializing" | "inactive" | "active" | "closed")
Current state of this conversation. Can be either initializing, active, inactive or closed and defaults to active
string
An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set ”{}” will be returned.
string
An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource’s sid in the URL.
string
The date that this resource was created.
string
The date that this resource was last updated.
string
The human-readable name of this conversation, limited to 256 characters. Optional.
string
ISO8601 duration when conversation will be switched to closed state. Minimum value for this timer is 10 minutes.
string
ISO8601 duration when conversation will be switched to inactive state. Minimum value for this timer is 1 minute.
string
The default name that will be used when sending outbound emails in this conversation.
string
The unique ID of the Messaging Service this conversation belongs to.
string
The default email address that will be used when sending outbound emails in this conversation.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header

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: TWILIO_CONVERSATIONS_CREATE_CONVERSATION_MESSAGEAdd a new message to the conversation

Input Parameters

string
The content of the message, can be up to 1,600 characters long.
string
The channel specific identifier of the message’s author. Defaults to system.
string
The subject of the message, can be up to 256 characters long.
string
The Media SID to be attached to the new Message.
string
A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set ”{}” will be returned.
string
The unique ID of the multi-channel Rich Content template, required for template-generated messages. Note that if this field is set, Body and MediaSid parameters are ignored.
string
The date that this resource was created. If you set this parameter, Twilio ignores any milliseconds in the timestamp.
string
The date that this resource was last updated. null if the message has not been edited. If you set this parameter, Twilio ignores any milliseconds in the timestamp.
string
required
The unique ID of the Conversation for this message.
string
A structurally valid JSON string that contains values to resolve Rich Content template variables.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header

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: TWILIO_CONVERSATIONS_CREATE_CONVERSATION_PARTICIPANTAdd a new participant to the conversation

Input Parameters

string
A unique string identifier for the conversation participant as Conversation User. This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters.
string
The SID of a conversation-level Role to assign to the participant.
string
An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set ”{}” will be returned.
string
The date that this resource was created.
string
The date that this resource was last updated.
string
required
The unique ID of the Conversation for this participant.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header
string
The address of the participant’s device, e.g. a phone or WhatsApp number. Together with the Proxy address, this determines a participant uniquely. This field (with proxy_address) is only null when the participant is interacting from an SDK endpoint (see the ‘identity’ field).
string
The address of the Twilio phone number (or WhatsApp number) that the participant is in contact with. This field, together with participant address, is only null when the participant is interacting from an SDK endpoint (see the ‘identity’ field).
string
The address of the Twilio phone number that is used in Group MMS. Communication mask for the Conversation participant with Identity.

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: TWILIO_CONVERSATIONS_CREATE_CONVERSATION_SCOPED_WEBHOOKCreate a new webhook scoped to the conversation

Input Parameters

string ("webhook" | "trigger" | "studio")
required
The target of this webhook: webhook, studio, trigger
string
required
The unique ID of the Conversation for this webhook.
string
The absolute url the webhook request should be sent to.
string ("get" | "post")
Twilio Configuration.Method request value.
array
The list of events, firing webhook event for this Conversation.
string
The studio flow SID, where the webhook should be sent to.
array
The list of keywords, firing webhook event for this Conversation.
integer
The message index for which and it’s successors the webhook will be replayed. Not set by default

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: TWILIO_CONVERSATIONS_CREATE_CONVERSATION_WITH_PARTICIPANTSCreate a new conversation with the list of participants in your account’s default service

Input Parameters

string ("initializing" | "inactive" | "active" | "closed")
Current state of this conversation. Can be either initializing, active, inactive or closed and defaults to active
string
An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set ”{}” will be returned.
array
The participant to be added to the conversation in JSON format. The JSON object attributes are as parameters in Participant Resource. The maximum number of participants that can be added in a single request is 10.
string
An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource’s sid in the URL.
string
The date that this resource was created.
string
The date that this resource was last updated.
string
The human-readable name of this conversation, limited to 256 characters. Optional.
string
ISO8601 duration when conversation will be switched to closed state. Minimum value for this timer is 10 minutes.
string
ISO8601 duration when conversation will be switched to inactive state. Minimum value for this timer is 1 minute.
string
The default name that will be used when sending outbound emails in this conversation.
string
The unique ID of the Messaging Service this conversation belongs to.
string
The default email address that will be used when sending outbound emails in this conversation.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header

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: TWILIO_CONVERSATIONS_CREATE_CREDENTIALAdd a new push notification credential to your account

Input Parameters

string ("apn" | "gcm" | "fcm")
required
The type of push-notification service the credential is for. Can be: fcm, gcm, or apn.
string
[FCM only] The Server key of your project from the Firebase console, found under Settings / Cloud messaging.
string
[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.
boolean
[APN only] Whether to send the credential to sandbox APNs. Can be true to send to sandbox APNs or false to send to production.
string
[APN only] The URL encoded representation of the certificate.
string
[APN only] The URL encoded representation of the private key.
string
A descriptive string that you create to describe the new resource. It can be up to 64 characters long.

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: TWILIO_CONVERSATIONS_CREATE_ROLECreate a new user role in your account’s default service

Input Parameters

string ("conversation" | "service")
required
The type of role. Can be: conversation for Conversation roles or service for Conversation Service roles.
array
required
A permission that you grant to the new role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role’s type.
string
required
A descriptive string that you create to describe the new resource. It can be up to 64 characters long.

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: TWILIO_CONVERSATIONS_CREATE_SERVICECreate a new conversation service on your account

Input Parameters

string
required
The human-readable name of this service, limited to 256 characters. Optional.

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: TWILIO_CONVERSATIONS_CREATE_SERVICE_CONVERSATIONCreate a new conversation in your service

Input Parameters

string ("initializing" | "inactive" | "active" | "closed")
Current state of this conversation. Can be either initializing, active, inactive or closed and defaults to active
string
An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set ”{}” will be returned.
string
An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource’s sid in the URL.
string
The date that this resource was created.
string
The date that this resource was last updated.
string
The human-readable name of this conversation, limited to 256 characters. Optional.
string
ISO8601 duration when conversation will be switched to closed state. Minimum value for this timer is 10 minutes.
string
ISO8601 duration when conversation will be switched to inactive state. Minimum value for this timer is 1 minute.
string
required
The SID of the Conversation Service the Conversation resource is associated with.
string
The default name that will be used when sending outbound emails in this conversation.
string
The unique ID of the Messaging Service this conversation belongs to.
string
The default email address that will be used when sending outbound emails in this conversation.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header

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: TWILIO_CONVERSATIONS_CREATE_SERVICE_CONVERSATION_MESSAGEAdd a new message to the conversation in a specific service

Input Parameters

string
The content of the message, can be up to 1,600 characters long.
string
The channel specific identifier of the message’s author. Defaults to system.
string
The subject of the message, can be up to 256 characters long.
string
The Media SID to be attached to the new Message.
string
A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set ”{}” will be returned.
string
The unique ID of the multi-channel Rich Content template, required for template-generated messages. Note that if this field is set, Body and MediaSid parameters are ignored.
string
The date that this resource was created. If you set this parameter, Twilio ignores any milliseconds in the timestamp.
string
The date that this resource was last updated. null if the message has not been edited. If you set this parameter, Twilio ignores any milliseconds in the timestamp.
string
required
The SID of the Conversation Service the Participant resource is associated with.
string
required
The unique ID of the Conversation for this message.
string
A structurally valid JSON string that contains values to resolve Rich Content template variables.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header

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: TWILIO_CONVERSATIONS_CREATE_SERVICE_CONVERSATION_PARTICIPANTAdd a new participant to the conversation in a specific service

Input Parameters

string
A unique string identifier for the conversation participant as Conversation User. This parameter is non-null if (and only if) the participant is using the Conversation SDK to communicate. Limited to 256 characters.
string
The SID of a conversation-level Role to assign to the participant.
string
An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set {} will be returned.
string
The date on which this resource was created.
string
The date on which this resource was last updated.
string
required
The SID of the Conversation Service the Participant resource is associated with.
string
required
The unique ID of the Conversation for this participant.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header
string
The address of the participant’s device, e.g. a phone or WhatsApp number. Together with the Proxy address, this determines a participant uniquely. This field (with proxy_address) is only null when the participant is interacting from an SDK endpoint (see the identity field).
string
The address of the Twilio phone number (or WhatsApp number) that the participant is in contact with. This field, together with participant address, is only null when the participant is interacting from an SDK endpoint (see the identity field).
string
The address of the Twilio phone number that is used in Group MMS.

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: TWILIO_CONVERSATIONS_CREATE_SERVICE_CONVERSATION_SCOPED_WEBHOOKCreate a new webhook scoped to the conversation in a specific service

Input Parameters

string ("webhook" | "trigger" | "studio")
required
The target of this webhook: webhook, studio, trigger
string
required
The SID of the Conversation Service the Participant resource is associated with.
string
required
The unique ID of the Conversation for this webhook.
string
The absolute url the webhook request should be sent to.
string ("get" | "post")
Twilio Configuration.Method request value.
array
The list of events, firing webhook event for this Conversation.
string
The studio flow SID, where the webhook should be sent to.
array
The list of keywords, firing webhook event for this Conversation.
integer
The message index for which and it’s successors the webhook will be replayed. Not set by default

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: TWILIO_CONVERSATIONS_CREATE_SERVICE_CONVERSATION_WITH_PARTICIPANTSCreate a new conversation with the list of participants in your account’s default service

Input Parameters

string ("initializing" | "inactive" | "active" | "closed")
Current state of this conversation. Can be either initializing, active, inactive or closed and defaults to active
string
An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set ”{}” will be returned.
array
The participant to be added to the conversation in JSON format. The JSON object attributes are as parameters in Participant Resource. The maximum number of participants that can be added in a single request is 10.
string
An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource’s sid in the URL.
string
The date that this resource was created.
string
The date that this resource was last updated.
string
The human-readable name of this conversation, limited to 256 characters. Optional.
string
ISO8601 duration when conversation will be switched to closed state. Minimum value for this timer is 10 minutes.
string
ISO8601 duration when conversation will be switched to inactive state. Minimum value for this timer is 1 minute.
string
required
The SID of the Conversation Service the Conversation resource is associated with.
string
The default name that will be used when sending outbound emails in this conversation.
string
The unique ID of the Messaging Service this conversation belongs to.
string
The default email address that will be used when sending outbound emails in this conversation.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header

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: TWILIO_CONVERSATIONS_CREATE_SERVICE_ROLECreate a new user role in your service

Input Parameters

string ("conversation" | "service")
required
The type of role. Can be: conversation for Conversation roles or service for Conversation Service roles.
array
required
A permission that you grant to the new role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role’s type.
string
required
A descriptive string that you create to describe the new resource. It can be up to 64 characters long.
string
required
The SID of the Conversation Service to create the Role resource under.

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: TWILIO_CONVERSATIONS_CREATE_SERVICE_USERAdd a new conversation user to your service

Input Parameters

string
required
The application-defined string that uniquely identifies the resource’s User within the Conversation Service. This value is often a username or an email address, and is case-sensitive.
string
The SID of a service-level Role to assign to the user.
string
The JSON Object string that stores application-specific data. If attributes have not been set, {} is returned.
string
The string that you assigned to describe the resource.
string
required
The SID of the Conversation Service the User resource is associated with.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header

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: TWILIO_CONVERSATIONS_CREATE_USERAdd a new conversation user to your account’s default service

Input Parameters

string
required
The application-defined string that uniquely identifies the resource’s User within the Conversation Service. This value is often a username or an email address, and is case-sensitive.
string
The SID of a service-level Role to assign to the user.
string
The JSON Object string that stores application-specific data. If attributes have not been set, {} is returned.
string
The string that you assigned to describe the resource.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header

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: TWILIO_CONVERSATIONS_DELETE_CONFIGURATION_ADDRESSRemove an existing address configuration

Input Parameters

string
required
The SID of the Address Configuration resource. This value can be either the sid or the address of the configuration

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: TWILIO_CONVERSATIONS_DELETE_CONVERSATIONRemove a conversation from your account’s default service

Input Parameters

string
required
A 34 character string that uniquely identifies this resource. Can also be the unique_name of the Conversation.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header

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: TWILIO_CONVERSATIONS_DELETE_CONVERSATION_MESSAGERemove a message from the conversation

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.
string
required
The unique ID of the Conversation for this message.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header

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: TWILIO_CONVERSATIONS_DELETE_CONVERSATION_PARTICIPANTRemove a participant from the conversation

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.
string
required
The unique ID of the Conversation for this participant.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header

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: TWILIO_CONVERSATIONS_DELETE_CONVERSATION_SCOPED_WEBHOOKRemove an existing webhook scoped to the conversation

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.
string
required
The unique ID of the Conversation for this webhook.

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: TWILIO_CONVERSATIONS_DELETE_CREDENTIALRemove a push notification credential from your account

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.

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: TWILIO_CONVERSATIONS_DELETE_ROLERemove a user role from your account’s default service

Input Parameters

string
required
The SID of the Role resource 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: TWILIO_CONVERSATIONS_DELETE_SERVICERemove a conversation service with all its nested resources from your account

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.

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: TWILIO_CONVERSATIONS_DELETE_SERVICE_BINDINGRemove a push notification binding from the conversation service

Input Parameters

string
required
The SID of the Binding resource to delete.
string
required
The SID of the Conversation Service to delete the Binding resource from.

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: TWILIO_CONVERSATIONS_DELETE_SERVICE_CONVERSATIONRemove a conversation from your service

Input Parameters

string
required
A 34 character string that uniquely identifies this resource. Can also be the unique_name of the Conversation.
string
required
The SID of the Conversation Service the Conversation resource is associated with.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header

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: TWILIO_CONVERSATIONS_DELETE_SERVICE_CONVERSATION_MESSAGERemove a message from the conversation

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.
string
required
The SID of the Conversation Service the Participant resource is associated with.
string
required
The unique ID of the Conversation for this message.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header

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: TWILIO_CONVERSATIONS_DELETE_SERVICE_CONVERSATION_PARTICIPANTRemove a participant from the conversation

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.
string
required
The SID of the Conversation Service the Participant resource is associated with.
string
required
The unique ID of the Conversation for this participant.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header

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: TWILIO_CONVERSATIONS_DELETE_SERVICE_CONVERSATION_SCOPED_WEBHOOKRemove an existing webhook scoped to the conversation

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.
string
required
The SID of the Conversation Service the Participant resource is associated with.
string
required
The unique ID of the Conversation for this webhook.

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: TWILIO_CONVERSATIONS_DELETE_SERVICE_ROLERemove a user role from your service

Input Parameters

string
required
The SID of the Role resource to delete.
string
required
The SID of the Conversation Service to delete the Role resource from.

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: TWILIO_CONVERSATIONS_DELETE_SERVICE_USERRemove a conversation user from your service

Input Parameters

string
required
The SID of the User resource to delete. This value can be either the sid or the identity of the User resource to delete.
string
required
The SID of the Conversation Service to delete the User resource from.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header

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: TWILIO_CONVERSATIONS_DELETE_SERVICE_USER_CONVERSATIONDelete a specific User Conversation.

Input Parameters

string
required
The unique SID identifier of the User resource. This value can be either the sid or the identity of the User resource.
string
required
The SID of the Conversation Service the Conversation resource is associated with.
string
required
The unique SID identifier of the Conversation. This value can be either the sid or the unique_name of the Conversation resource.

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: TWILIO_CONVERSATIONS_DELETE_USERRemove a conversation user from your account’s default service

Input Parameters

string
required
The SID of the User resource to delete. This value can be either the sid or the identity of the User resource to delete.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header

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: TWILIO_CONVERSATIONS_DELETE_USER_CONVERSATIONDelete a specific User Conversation.

Input Parameters

string
required
The unique SID identifier of the User resource. This value can be either the sid or the identity of the User resource.
string
required
The unique SID identifier of the Conversation. This value can be either the sid or the unique_name of the Conversation resource.

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: TWILIO_CONVERSATIONS_FETCH_CONFIGURATIONFetch the global configuration of conversations on your 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: TWILIO_CONVERSATIONS_FETCH_CONFIGURATION_ADDRESSFetch an address configuration

Input Parameters

string
required
The SID of the Address Configuration resource. This value can be either the sid or the address of the configuration

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: TWILIO_CONVERSATIONS_FETCH_CONFIGURATION_WEBHOOKFetch Configuration Webhook using the Twilio conversations_v1 REST API.

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: TWILIO_CONVERSATIONS_FETCH_CONVERSATIONFetch a conversation from your account’s default service

Input Parameters

string
required
A 34 character string that uniquely identifies this resource. Can also be the unique_name of the Conversation.

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: TWILIO_CONVERSATIONS_FETCH_CONVERSATION_MESSAGEFetch a message from the conversation

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.
string
required
The unique ID of the Conversation for this message.

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: TWILIO_CONVERSATIONS_FETCH_CONVERSATION_MESSAGE_RECEIPTFetch the delivery and read receipts of the conversation message

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.
string
required
The SID of the message within a Conversation the delivery receipt belongs to.
string
required
The unique ID of the Conversation for this message.

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: TWILIO_CONVERSATIONS_FETCH_CONVERSATION_PARTICIPANTFetch a participant of the conversation

Input Parameters

string
required
A 34 character string that uniquely identifies this resource. Alternatively, you can pass a Participant’s identity rather than the SID.
string
required
The unique ID of the Conversation for this participant.

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: TWILIO_CONVERSATIONS_FETCH_CONVERSATION_SCOPED_WEBHOOKFetch the configuration of a conversation-scoped webhook

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.
string
required
The unique ID of the Conversation for this webhook.

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: TWILIO_CONVERSATIONS_FETCH_CREDENTIALFetch a push notification credential from your account

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.

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: TWILIO_CONVERSATIONS_FETCH_ROLEFetch a user role from your account’s default service

Input Parameters

string
required
The SID of the Role resource to fetch.

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: TWILIO_CONVERSATIONS_FETCH_SERVICEFetch a conversation service from your account

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.

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: TWILIO_CONVERSATIONS_FETCH_SERVICE_BINDINGFetch a push notification binding from the conversation service

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.
string
required
The SID of the Conversation Service the Binding resource is associated with.

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: TWILIO_CONVERSATIONS_FETCH_SERVICE_CONFIGURATIONFetch the configuration of a conversation service

Input Parameters

string
required
The SID of the Service configuration resource to fetch.

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: TWILIO_CONVERSATIONS_FETCH_SERVICE_CONVERSATIONFetch a conversation from your service

Input Parameters

string
required
A 34 character string that uniquely identifies this resource. Can also be the unique_name of the Conversation.
string
required
The SID of the Conversation Service the Conversation resource is associated with.

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: TWILIO_CONVERSATIONS_FETCH_SERVICE_CONVERSATION_MESSAGEFetch a message from the conversation

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.
string
required
The SID of the Conversation Service the Participant resource is associated with.
string
required
The unique ID of the Conversation for this message.

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: TWILIO_CONVERSATIONS_FETCH_SERVICE_CONVERSATION_MESSAGE_RECEIPTFetch the delivery and read receipts of the conversation message

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.
string
required
The SID of the message within a Conversation the delivery receipt belongs to.
string
required
The SID of the Conversation Service the Message resource is associated with.
string
required
The unique ID of the Conversation for this message.

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: TWILIO_CONVERSATIONS_FETCH_SERVICE_CONVERSATION_PARTICIPANTFetch a participant of the conversation

Input Parameters

string
required
A 34 character string that uniquely identifies this resource. Alternatively, you can pass a Participant’s identity rather than the SID.
string
required
The SID of the Conversation Service the Participant resource is associated with.
string
required
The unique ID of the Conversation for this participant.

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: TWILIO_CONVERSATIONS_FETCH_SERVICE_CONVERSATION_SCOPED_WEBHOOKFetch the configuration of a conversation-scoped webhook

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.
string
required
The SID of the Conversation Service the Participant resource is associated with.
string
required
The unique ID of the Conversation for this webhook.

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: TWILIO_CONVERSATIONS_FETCH_SERVICE_NOTIFICATIONFetch push notification service settings

Input Parameters

string
required
The SID of the Conversation Service the Configuration applies to.

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: TWILIO_CONVERSATIONS_FETCH_SERVICE_ROLEFetch a user role from your service

Input Parameters

string
required
The SID of the Role resource to fetch.
string
required
The SID of the Conversation Service to fetch the Role resource from.

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: TWILIO_CONVERSATIONS_FETCH_SERVICE_USERFetch a conversation user from your service

Input Parameters

string
required
The SID of the User resource to fetch. This value can be either the sid or the identity of the User resource to fetch.
string
required
The SID of the Conversation Service to fetch the User resource from.

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: TWILIO_CONVERSATIONS_FETCH_SERVICE_USER_CONVERSATIONFetch a specific User Conversation.

Input Parameters

string
required
The unique SID identifier of the User resource. This value can be either the sid or the identity of the User resource.
string
required
The SID of the Conversation Service the Conversation resource is associated with.
string
required
The unique SID identifier of the Conversation. This value can be either the sid or the unique_name of the Conversation resource.

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: TWILIO_CONVERSATIONS_FETCH_SERVICE_WEBHOOK_CONFIGURATIONFetch a specific service webhook configuration.

Input Parameters

string
required
The unique ID of the Conversation Service this conversation belongs to.

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: TWILIO_CONVERSATIONS_FETCH_USERFetch a conversation user from your account’s default service

Input Parameters

string
required
The SID of the User resource to fetch. This value can be either the sid or the identity of the User resource to fetch.

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: TWILIO_CONVERSATIONS_FETCH_USER_CONVERSATIONFetch a specific User Conversation.

Input Parameters

string
required
The unique SID identifier of the User resource. This value can be either the sid or the identity of the User resource.
string
required
The unique SID identifier of the Conversation. This value can be either the sid or the unique_name of the Conversation resource.

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: TWILIO_CONVERSATIONS_LIST_CONFIGURATION_ADDRESSRetrieve a list of address configurations for an account

Input Parameters

integer
The page index. This value is simply for client state.
string
Filter the address configurations by its type. This value can be one of: whatsapp, sms.
integer
How many resources to return in each list page. The default is 50, and the maximum is 50.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_CONVERSATIONS_LIST_CONVERSATIONRetrieve a list of conversations in your account’s default service

Input Parameters

integer
The page index. This value is simply for client state.
string ("initializing" | "inactive" | "active" | "closed")
State for sorting and filtering list of Conversations. Can be active, inactive or closed
string
Defines the end of the date range for filtering conversations by their creation date. Only conversations that were created on or before this date will appear in the results. The date must be in ISO8601 format, specifically capturing up to the end of the specified date (YYYY-MM-DDT23:59:59Z), to ensure that conversations from the entire end day are included. This parameter can be combined with other filters. If this filter is used, the returned list is sorted by latest conversation creation date in descending order.
integer
How many resources to return in each list page. The default is 50, and the maximum is 100.
string
The page token. This is provided by the API.
string
Specifies the beginning of the date range for filtering Conversations based on their creation date. Conversations that were created on or after this date will be included in the results. The date must be in ISO8601 format, specifically starting at the beginning of the specified date (YYYY-MM-DDT00:00:00Z), for precise filtering. This parameter can be combined with other filters. If this filter is used, the returned list is sorted by latest conversation creation date in descending order.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_CONVERSATIONS_LIST_CONVERSATION_MESSAGERetrieve a list of all messages in the conversation

Input Parameters

integer
The page index. This value is simply for client state.
string ("asc" | "desc")
The sort order of the returned messages. Can be: asc (ascending) or desc (descending), with asc as the default.
integer
How many resources to return in each list page. The default is 50, and the maximum is 100.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The unique ID of the Conversation for messages.

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: TWILIO_CONVERSATIONS_LIST_CONVERSATION_MESSAGE_RECEIPTRetrieve a list of all delivery and read receipts of the conversation message

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 50.
string
The page token. This is provided by the API.
string
required
The SID of the message within a Conversation the delivery receipt belongs to.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The unique ID of the Conversation for this message.

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: TWILIO_CONVERSATIONS_LIST_CONVERSATION_PARTICIPANTRetrieve a list of all participants of the conversation

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 100.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The unique ID of the Conversation for participants.

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: TWILIO_CONVERSATIONS_LIST_CONVERSATION_SCOPED_WEBHOOKRetrieve a list of all webhooks scoped to the conversation

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 5, and the maximum is 5.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The unique ID of the Conversation for this webhook.

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: TWILIO_CONVERSATIONS_LIST_CREDENTIALRetrieve a list of all push notification credentials on your account

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 100.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_CONVERSATIONS_LIST_PARTICIPANT_CONVERSATIONRetrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified.

Input Parameters

integer
The page index. This value is simply for client state.
string
A unique string identifier for the conversation participant who’s not a Conversation User. This parameter could be found in messaging_binding.address field of Participant resource. It should be url-encoded.
string
A unique string identifier for the conversation participant as Conversation User. This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters.
integer
How many resources to return in each list page. The default is 50, and the maximum is 50.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_CONVERSATIONS_LIST_ROLERetrieve a list of all user roles in your account’s default service

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 50.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_CONVERSATIONS_LIST_SERVICERetrieve a list of all conversation services on your account

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 100.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_CONVERSATIONS_LIST_SERVICE_BINDINGRetrieve a list of all push notification bindings in the conversation service

Input Parameters

integer
The page index. This value is simply for client state.
array
The identity of a Conversation User this binding belongs to. See access tokens for more details.
integer
How many resources to return in each list page. The default is 50, and the maximum is 100.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
array
The push technology used by the Binding resources to read. Can be: apn, gcm, fcm, or twilsock. See push notification configuration for more info.
string
required
The SID of the Conversation Service the Binding resource is associated with.

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: TWILIO_CONVERSATIONS_LIST_SERVICE_CONVERSATIONRetrieve a list of conversations in your service

Input Parameters

integer
The page index. This value is simply for client state.
string ("initializing" | "inactive" | "active" | "closed")
State for sorting and filtering list of Conversations. Can be active, inactive or closed
string
Defines the end of the date range for filtering conversations by their creation date. Only conversations that were created on or before this date will appear in the results. The date must be in ISO8601 format, specifically capturing up to the end of the specified date (YYYY-MM-DDT23:59:59Z), to ensure that conversations from the entire end day are included. This parameter can be combined with other filters. If this filter is used, the returned list is sorted by latest conversation creation date in descending order.
integer
How many resources to return in each list page. The default is 50, and the maximum is 100.
string
The page token. This is provided by the API.
string
Specifies the beginning of the date range for filtering Conversations based on their creation date. Conversations that were created on or after this date will be included in the results. The date must be in ISO8601 format, specifically starting at the beginning of the specified date (YYYY-MM-DDT00:00:00Z), for precise filtering. This parameter can be combined with other filters. If this filter is used, the returned list is sorted by latest conversation creation date in descending order.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the Conversation Service the Conversation resource is associated with.

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: TWILIO_CONVERSATIONS_LIST_SERVICE_CONVERSATION_MESSAGERetrieve a list of all messages in the conversation

Input Parameters

integer
The page index. This value is simply for client state.
string ("asc" | "desc")
The sort order of the returned messages. Can be: asc (ascending) or desc (descending), with asc as the default.
integer
How many resources to return in each list page. The default is 50, and the maximum is 100.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the Conversation Service the Participant resource is associated with.
string
required
The unique ID of the Conversation for messages.

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: TWILIO_CONVERSATIONS_LIST_SERVICE_CONVERSATION_MESSAGE_RECEIPTRetrieve a list of all delivery and read receipts of the conversation message

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 50.
string
The page token. This is provided by the API.
string
required
The SID of the message within a Conversation the delivery receipt belongs to.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the Conversation Service the Message resource is associated with.
string
required
The unique ID of the Conversation for this message.

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: TWILIO_CONVERSATIONS_LIST_SERVICE_CONVERSATION_PARTICIPANTRetrieve a list of all participants of the conversation

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 100.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the Conversation Service the Participant resource is associated with.
string
required
The unique ID of the Conversation for participants.

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: TWILIO_CONVERSATIONS_LIST_SERVICE_CONVERSATION_SCOPED_WEBHOOKRetrieve a list of all webhooks scoped to the conversation

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 5, and the maximum is 5.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the Conversation Service the Participant resource is associated with.
string
required
The unique ID of the Conversation for this webhook.

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: TWILIO_CONVERSATIONS_LIST_SERVICE_PARTICIPANT_CONVERSATIONRetrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified.

Input Parameters

integer
The page index. This value is simply for client state.
string
A unique string identifier for the conversation participant who’s not a Conversation User. This parameter could be found in messaging_binding.address field of Participant resource. It should be url-encoded.
string
A unique string identifier for the conversation participant as Conversation User. This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters.
integer
How many resources to return in each list page. The default is 50, and the maximum is 50.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the Conversation Service the Participant Conversations resource is associated with.

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: TWILIO_CONVERSATIONS_LIST_SERVICE_ROLERetrieve a list of all user roles in your service

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 50.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the Conversation Service to read the Role resources from.

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: TWILIO_CONVERSATIONS_LIST_SERVICE_USERRetrieve a list of all conversation users in your service

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 50.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the Conversation Service to read the User resources from.

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: TWILIO_CONVERSATIONS_LIST_SERVICE_USER_CONVERSATIONRetrieve a list of all User Conversations for the User.

Input Parameters

integer
The page index. This value is simply for client state.
string
required
The unique SID identifier of the User resource. This value can be either the sid or the identity of the User resource.
integer
How many resources to return in each list page. The default is 50, and the maximum is 50.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the Conversation Service the Conversation resource is associated with.

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: TWILIO_CONVERSATIONS_LIST_USERRetrieve a list of all conversation users in your account’s default service

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 50.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_CONVERSATIONS_LIST_USER_CONVERSATIONRetrieve a list of all User Conversations for the User.

Input Parameters

integer
The page index. This value is simply for client state.
string
required
The unique SID identifier of the User resource. This value can be either the sid or the identity of the User resource.
integer
How many resources to return in each list page. The default is 50, and the maximum is 50.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_CONVERSATIONS_UPDATE_CONFIGURATIONUpdate the global configuration of conversations on your account

Input Parameters

string
Default ISO8601 duration when conversation will be switched to closed state. Minimum value for this timer is 10 minutes.
string
Default ISO8601 duration when conversation will be switched to inactive state. Minimum value for this timer is 1 minute.
string
The SID of the default Conversation Service to use when creating a conversation.
string
The SID of the default Messaging Service to use when creating a conversation.

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: TWILIO_CONVERSATIONS_UPDATE_CONFIGURATION_ADDRESSUpdate an existing address configuration

Input Parameters

string
required
The SID of the Address Configuration resource. This value can be either the sid or the address of the configuration
string
The human-readable name of this configuration, limited to 256 characters. Optional.
string ("webhook" | "studio" | "default")
Twilio AutoCreation.Type request value.
boolean
Enable/Disable auto-creating conversations for messages to this address
string
For type webhook, the url for the webhook request.
string ("get" | "post")
Twilio AutoCreation.WebhookMethod request value.
string
For type studio, the studio flow SID where the webhook should be sent to.
array
The list of events, firing webhook event for this Conversation. Values can be any of the following: onMessageAdded, onMessageUpdated, onMessageRemoved, onConversationUpdated, onConversationStateUpdated, onConversationRemoved, onParticipantAdded, onParticipantUpdated, onParticipantRemoved, onDeliveryUpdated
integer
For type studio, number of times to retry the webhook request
string
Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.

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: TWILIO_CONVERSATIONS_UPDATE_CONFIGURATION_WEBHOOKUpdate Configuration Webhook using the Twilio conversations_v1 REST API.

Input Parameters

string
The HTTP method to be used when sending a webhook request.
string ("webhook" | "flex")
The routing target of the webhook. Can be ordinary or route internally to Flex
array
The list of webhook event triggers that are enabled for this Service: onMessageAdded, onMessageUpdated, onMessageRemoved, onMessageAdd, onMessageUpdate, onMessageRemove, onConversationUpdated, onConversationRemoved, onConversationAdd, onConversationAdded, onConversationRemove, onConversationUpdate, onConversationStateUpdated, onParticipantAdded, onParticipantUpdated, onParticipantRemoved, onParticipantAdd, onParticipantRemove, onParticipantUpdate, onDeliveryUpdated, onUserAdded, onUserUpdate, onUserUpdated
string
The absolute url the pre-event webhook request should be sent to.
string
The absolute url the post-event webhook request should be sent to.

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: TWILIO_CONVERSATIONS_UPDATE_CONVERSATIONUpdate an existing conversation in your account’s default service

Input Parameters

string
required
A 34 character string that uniquely identifies this resource. Can also be the unique_name of the Conversation.
string ("initializing" | "inactive" | "active" | "closed")
Current state of this conversation. Can be either initializing, active, inactive or closed and defaults to active
string
An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set ”{}” will be returned.
string
An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource’s sid in the URL.
string
The date that this resource was created.
string
The date that this resource was last updated.
string
The human-readable name of this conversation, limited to 256 characters. Optional.
string
ISO8601 duration when conversation will be switched to closed state. Minimum value for this timer is 10 minutes.
string
ISO8601 duration when conversation will be switched to inactive state. Minimum value for this timer is 1 minute.
string
The default name that will be used when sending outbound emails in this conversation.
string
The unique ID of the Messaging Service this conversation belongs to.
string
The default email address that will be used when sending outbound emails in this conversation.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header

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: TWILIO_CONVERSATIONS_UPDATE_CONVERSATION_MESSAGEUpdate an existing message in the conversation

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.
string
The content of the message, can be up to 1,600 characters long.
string
The channel specific identifier of the message’s author. Defaults to system.
string
The subject of the message, can be up to 256 characters long.
string
A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set ”{}” will be returned.
string
The date that this resource was created. If you set this parameter, Twilio ignores any milliseconds in the timestamp.
string
The date that this resource was last updated. null if the message has not been edited. If you set this parameter, Twilio ignores any milliseconds in the timestamp.
string
required
The unique ID of the Conversation for this message.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header

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: TWILIO_CONVERSATIONS_UPDATE_CONVERSATION_PARTICIPANTUpdate an existing participant in the conversation

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.
string
A unique string identifier for the conversation participant as Conversation User. This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters.
string
The SID of a conversation-level Role to assign to the participant.
string
An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set ”{}” will be returned.
string
The date that this resource was created.
string
The date that this resource was last updated.
string
required
The unique ID of the Conversation for this participant.
string
Timestamp of last “read” message in the Conversation for the Participant.
integer
Index of last “read” message in the Conversation for the Participant.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header
string
The address of the Twilio phone number that the participant is in contact with. ‘null’ value will remove it.
string
The address of the Twilio phone number that is used in Group MMS. ‘null’ value will remove it.

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: TWILIO_CONVERSATIONS_UPDATE_CONVERSATION_SCOPED_WEBHOOKUpdate an existing conversation-scoped webhook

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.
string
required
The unique ID of the Conversation for this webhook.
string
The absolute url the webhook request should be sent to.
string ("get" | "post")
Twilio Configuration.Method request value.
array
The list of events, firing webhook event for this Conversation.
string
The studio flow SID, where the webhook should be sent to.
array
The list of keywords, firing webhook event for this Conversation.

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: TWILIO_CONVERSATIONS_UPDATE_CREDENTIALUpdate an existing push notification credential on your account

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.
string ("apn" | "gcm" | "fcm")
The type of push-notification service the credential is for. Can be: fcm, gcm, or apn.
string
[FCM only] The Server key of your project from the Firebase console, found under Settings / Cloud messaging.
string
[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.
boolean
[APN only] Whether to send the credential to sandbox APNs. Can be true to send to sandbox APNs or false to send to production.
string
[APN only] The URL encoded representation of the certificate.
string
[APN only] The URL encoded representation of the private key.
string
A descriptive string that you create to describe the new resource. It can be up to 64 characters long.

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: TWILIO_CONVERSATIONS_UPDATE_ROLEUpdate an existing user role in your account’s default service

Input Parameters

string
required
The SID of the Role resource to update.
array
required
A permission that you grant to the role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. Note that the update action replaces all previously assigned permissions with those defined in the update action. To remove a permission, do not include it in the subsequent update action. The values for this parameter depend on the role’s type.

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: TWILIO_CONVERSATIONS_UPDATE_SERVICE_CONFIGURATIONUpdate configuration settings of a conversation service

Input Parameters

string
required
The SID of the Service configuration resource to update.
boolean
Whether the Reachability Indicator is enabled for this Conversations Service. The default is false.
string
The service-level role assigned to users when they are added to the service. See Conversation Role for more info about roles.
string
The conversation-level role assigned to users when they are added to a conversation. See Conversation Role for more info about roles.
string
The conversation-level role assigned to a conversation creator when they join a new conversation. See Conversation Role for more info about roles.

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: TWILIO_CONVERSATIONS_UPDATE_SERVICE_CONVERSATIONUpdate an existing conversation in your service

Input Parameters

string
required
A 34 character string that uniquely identifies this resource. Can also be the unique_name of the Conversation.
string ("initializing" | "inactive" | "active" | "closed")
Current state of this conversation. Can be either initializing, active, inactive or closed and defaults to active
string
An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set ”{}” will be returned.
string
An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource’s sid in the URL.
string
The date that this resource was created.
string
The date that this resource was last updated.
string
The human-readable name of this conversation, limited to 256 characters. Optional.
string
ISO8601 duration when conversation will be switched to closed state. Minimum value for this timer is 10 minutes.
string
ISO8601 duration when conversation will be switched to inactive state. Minimum value for this timer is 1 minute.
string
required
The SID of the Conversation Service the Conversation resource is associated with.
string
The default name that will be used when sending outbound emails in this conversation.
string
The unique ID of the Messaging Service this conversation belongs to.
string
The default email address that will be used when sending outbound emails in this conversation.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header

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: TWILIO_CONVERSATIONS_UPDATE_SERVICE_CONVERSATION_MESSAGEUpdate an existing message in the conversation

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.
string
The content of the message, can be up to 1,600 characters long.
string
The channel specific identifier of the message’s author. Defaults to system.
string
The subject of the message, can be up to 256 characters long.
string
A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set ”{}” will be returned.
string
The date that this resource was created. If you set this parameter, Twilio ignores any milliseconds in the timestamp.
string
The date that this resource was last updated. null if the message has not been edited. If you set this parameter, Twilio ignores any milliseconds in the timestamp.
string
required
The SID of the Conversation Service the Participant resource is associated with.
string
required
The unique ID of the Conversation for this message.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header

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: TWILIO_CONVERSATIONS_UPDATE_SERVICE_CONVERSATION_PARTICIPANTUpdate an existing participant in the conversation

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.
string
A unique string identifier for the conversation participant as Conversation User. This parameter is non-null if (and only if) the participant is using the Conversation SDK to communicate. Limited to 256 characters.
string
The SID of a conversation-level Role to assign to the participant.
string
An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set {} will be returned.
string
The date on which this resource was created.
string
The date on which this resource was last updated.
string
required
The SID of the Conversation Service the Participant resource is associated with.
string
required
The unique ID of the Conversation for this participant.
string
Timestamp of last “read” message in the Conversation for the Participant.
integer
Index of last “read” message in the Conversation for the Participant.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header
string
The address of the Twilio phone number that the participant is in contact with. ‘null’ value will remove it.
string
The address of the Twilio phone number that is used in Group MMS. ‘null’ value will remove it.

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: TWILIO_CONVERSATIONS_UPDATE_SERVICE_CONVERSATION_SCOPED_WEBHOOKUpdate an existing conversation-scoped webhook

Input Parameters

string
required
A 34 character string that uniquely identifies this resource.
string
required
The SID of the Conversation Service the Participant resource is associated with.
string
required
The unique ID of the Conversation for this webhook.
string
The absolute url the webhook request should be sent to.
string ("get" | "post")
Twilio Configuration.Method request value.
array
The list of events, firing webhook event for this Conversation.
string
The studio flow SID, where the webhook should be sent to.
array
The list of keywords, firing webhook event for this Conversation.

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: TWILIO_CONVERSATIONS_UPDATE_SERVICE_NOTIFICATIONUpdate push notification service settings

Input Parameters

boolean
Weather the notification logging is enabled.
string
required
The SID of the Conversation Service the Configuration applies to.
string
The name of the sound to play when a new message is added to a conversation and new_message.enabled is true.
boolean
Whether to send a notification when a new message is added to a conversation. The default is false.
string
The template to use to create the notification text displayed when a new message is added to a conversation and new_message.enabled is true.
string
The name of the sound to play when a participant is added to a conversation and added_to_conversation.enabled is true.
boolean
Whether to send a notification when a participant is added to a conversation. The default is false.
string
The template to use to create the notification text displayed when a participant is added to a conversation and added_to_conversation.enabled is true.
boolean
Whether to send a notification when a new message with media/file attachments is added to a conversation. The default is false.
boolean
Whether the new message badge is enabled. The default is false.
string
The template to use to create the notification text displayed when a new message with media/file attachments is added to a conversation and new_message.attachments.enabled is true.
string
The name of the sound to play to a user when they are removed from a conversation and removed_from_conversation.enabled is true.
boolean
Whether to send a notification to a user when they are removed from a conversation. The default is false.
string
The template to use to create the notification text displayed to a user when they are removed from a conversation and removed_from_conversation.enabled is true.

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: TWILIO_CONVERSATIONS_UPDATE_SERVICE_ROLEUpdate an existing user role in your service

Input Parameters

string
required
The SID of the Role resource to update.
array
required
A permission that you grant to the role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. Note that the update action replaces all previously assigned permissions with those defined in the update action. To remove a permission, do not include it in the subsequent update action. The values for this parameter depend on the role’s type.
string
required
The SID of the Conversation Service to update the Role resource in.

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: TWILIO_CONVERSATIONS_UPDATE_SERVICE_USERUpdate an existing conversation user in your service

Input Parameters

string
required
The SID of the User resource to update. This value can be either the sid or the identity of the User resource to update.
string
The SID of a service-level Role to assign to the user.
string
The JSON Object string that stores application-specific data. If attributes have not been set, {} is returned.
string
The string that you assigned to describe the resource.
string
required
The SID of the Conversation Service the User resource is associated with.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header

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: TWILIO_CONVERSATIONS_UPDATE_SERVICE_USER_CONVERSATIONUpdate a specific User Conversation.

Input Parameters

string
required
The unique SID identifier of the User resource. This value can be either the sid or the identity of the User resource.
string
required
The SID of the Conversation Service the Conversation resource is associated with.
string
required
The unique SID identifier of the Conversation. This value can be either the sid or the unique_name of the Conversation resource.
string ("default" | "muted")
The Notification Level of this User Conversation. One of default or muted.
string
The date of the last message read in conversation by the user, given in ISO 8601 format.
integer
The index of the last Message in the Conversation that the Participant has read.

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: TWILIO_CONVERSATIONS_UPDATE_SERVICE_WEBHOOK_CONFIGURATIONUpdate a specific Webhook.

Input Parameters

string
The HTTP method to be used when sending a webhook request. One of GET or POST.
array
The list of events that your configured webhook targets will receive. Events not configured here will not fire. Possible values are onParticipantAdd, onParticipantAdded, onDeliveryUpdated, onConversationUpdated, onConversationRemove, onParticipantRemove, onConversationUpdate, onMessageAdd, onMessageRemoved, onParticipantUpdated, onConversationAdded, onMessageAdded, onConversationAdd, onConversationRemoved, onParticipantUpdate, onMessageRemove, onMessageUpdated, onParticipantRemoved, onMessageUpdate or onConversationStateUpdated.
string
The absolute url the pre-event webhook request should be sent to.
string
required
The unique ID of the Conversation Service this conversation belongs to.
string
The absolute url the post-event webhook request should be sent to.

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: TWILIO_CONVERSATIONS_UPDATE_USERUpdate an existing conversation user in your account’s default service

Input Parameters

string
required
The SID of the User resource to update. This value can be either the sid or the identity of the User resource to update.
string
The SID of a service-level Role to assign to the user.
string
The JSON Object string that stores application-specific data. If attributes have not been set, {} is returned.
string
The string that you assigned to describe the resource.
string ("true" | "false")
The X-Twilio-Webhook-Enabled HTTP request header

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: TWILIO_CONVERSATIONS_UPDATE_USER_CONVERSATIONUpdate a specific User Conversation.

Input Parameters

string
required
The unique SID identifier of the User resource. This value can be either the sid or the identity of the User resource.
string
required
The unique SID identifier of the Conversation. This value can be either the sid or the unique_name of the Conversation resource.
string ("default" | "muted")
The Notification Level of this User Conversation. One of default or muted.
string
The date of the last message read in conversation by the user, given in ISO 8601 format.
integer
The index of the last Message in the Conversation that the Participant has read.

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: TWILIO_CREATE_ACCOUNTCreate a new Twilio Subaccount from the account making the request

Input Parameters

string
A human readable description of the account to create, defaults to SubAccount Created at {YYYY-MM-DD HH:MM meridian}

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: TWILIO_CREATE_ADDRESSCreate Address using the Twilio api_v2010 REST API.

Input Parameters

string
required
The city of the new address.
string
required
The state or region of the new address.
string
required
The number and street address of the new address.
string
required
The SID of the Account that will be responsible for the new Address resource.
string
required
The ISO country code of the new address.
string
required
The postal code of the new address.
string
required
The name to associate with the new address.
string
A descriptive string that you create to describe the new address. It can be up to 64 characters long for Regulatory Compliance addresses and 32 characters long for Emergency addresses.
string
The additional number and street address of the address.
boolean
Whether to enable emergency calling on the new address. Can be: true or false.
boolean
Whether we should automatically correct the address. Can be: true or false and the default is true. If empty or true, we will correct the address you provide if necessary. If false, we won’t alter the address you provide.

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: TWILIO_CREATE_APPLICATIONCreate a new application within your account

Input Parameters

string
The URL we should call when the phone number receives an incoming SMS message.
string
The URL we should call when the phone number assigned to this application receives a call.
string ("GET" | "POST")
The HTTP method we should use to call sms_url. Can be: GET or POST.
string
required
The SID of the Account that will create the resource.
string
The API version to use to start a new TwiML session. Can be: 2010-04-01 or 2008-08-01. The default value is the account’s default API version.
string ("GET" | "POST")
The HTTP method we should use to call voice_url. Can be: GET or POST.
string
A descriptive string that you create to describe the new application. It can be up to 64 characters long.
string
The URL we should call using the status_callback_method to send status information to your application.
string
The URL that we should call when an error occurs while retrieving or executing the TwiML from sms_url.
string
The URL that we should call when an error occurs retrieving or executing the TwiML requested by url.
string ("GET" | "POST")
The HTTP method we should use to call sms_fallback_url. Can be: GET or POST.
string
The URL we should call using a POST method to send status information about SMS messages sent by the application.
string ("GET" | "POST")
The HTTP method we should use to call voice_fallback_url. Can be: GET or POST.
string ("GET" | "POST")
The HTTP method we should use to call status_callback. Can be: GET or POST.
boolean
Whether we should look up the caller’s caller-ID name from the CNAM database (additional charges apply). Can be: true or false.
string
The URL we should call using a POST method to send message status information to your application.
boolean
Whether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be: true or false.

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: TWILIO_CREATE_CALLCreate a new outgoing call to phones, SIP-enabled endpoints or Twilio Client connections

Input Parameters

string
required
The phone number, SIP address, or client identifier to call.
string
The absolute URL that returns the TwiML instructions for the call. We will call this URL using the method when the call connects. For more information, see the Url Parameter section in Making Calls.
string
The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that byoc is only meaningful when to is a phone number; it will otherwise be ignored. (Beta)
string
Whether to trim any leading and trailing silence from the recording. Can be: trim-silence or do-not-trim and the default is trim-silence.
string
required
The phone number or client identifier to use as the caller id. If using a phone number, it must be a Twilio number or a Verified outgoing caller id for your account. If the to parameter is a phone number, From must also be a phone number.
string
TwiML instructions for the call Twilio will use without fetching Twiml from url parameter. If both twiml and url are provided then twiml parameter will be ignored. Max 4000 characters.
string ("GET" | "POST")
The HTTP method we should use when calling the url parameter’s value. Can be: GET or POST and the default is POST. If an application_sid parameter is present, this parameter is ignored.
boolean
Whether to record the call. Can be true to record the phone call, or false to not. The default is false. The recording_url is sent to the status_callback URL.
integer
The integer number of seconds that we should allow the phone to ring before assuming there is no answer. The default is 60 seconds and the maximum is 600 seconds. For some call flows, we will add a 5-second buffer to the timeout value you provide. For this reason, a timeout value of 10 seconds could result in an actual timeout closer to 15 seconds. You can set this to a short time, such as 15 seconds, to hang up before reaching an answering machine or voicemail.
string
Select whether to perform answering machine detection in the background. Default, blocks the execution of the call until Answering Machine Detection is completed. Can be: true or false.
string
The phone number, SIP address, or Client identifier that made this call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as name@company.com.
string
The STIR/SHAKEN passport for this call, provided as a base64 encoded string. Multiple passports (at max 5) are comma separated and provided as base64 encoded string
string
A token string needed to invoke a forwarded call. A call_token is generated when an incoming call is received on a Twilio number. Pass an incoming call’s call_token value to a forwarded call via the call_token parameter when creating a new call. A forwarded call should bear the same CallerID of the original incoming call.
integer
The maximum duration of the call in seconds. Constraints depend on account and configuration.
string
required
The SID of the Account that will create the resource.
string
The Reason for the outgoing call. Use it to specify the purpose of the call that is presented on the called party’s phone. (Branded Calls Beta)
string
The string of keys to dial after connecting to the number, with a maximum length of 32 digits. Valid digits in the string include any digit (0-9), ‘A’, ‘B’, ‘C’, ‘D’, ‘#’, and ‘*’. You can also use ‘w’ to insert a half-second pause and ‘W’ to insert a one-second pause. For example, to pause for one second after connecting and then dial extension 1234 followed by the # key, set this parameter to W1234#. Be sure to URL-encode this string because the ‘#’ character has special meaning in a URL. If both SendDigits and MachineDetection parameters are provided, then MachineDetection will be ignored.
string
The URL that we call using the fallback_method if an error occurs when requesting or executing the TwiML at url. If an application_sid parameter is present, this parameter is ignored.
string
The SID of the Application resource that will handle the call, if the call will be handled by an application.
string ("GET" | "POST")
The HTTP method that we should use to request the fallback_url. Can be: GET or POST and the default is POST. If an application_sid parameter is present, this parameter is ignored.
string
The audio track to record for the call. Can be: inbound, outbound or both. The default is both. inbound records the audio that is received by Twilio. outbound records the audio that is generated from Twilio. both records the audio that is received and generated by Twilio.
string
The URL we should call using the status_callback_method to send status information to your application. If no status_callback_event is specified, we will send the completed status. If an application_sid parameter is present, this parameter is ignored. URLs must contain a valid hostname (underscores are not permitted).
string
Whether to detect if a human, answering machine, or fax has picked up the call. Can be: Enable or DetectMessageEnd. Use Enable if you would like us to return AnsweredBy as soon as the called party is identified. Use DetectMessageEnd, if you would like to leave a message on an answering machine. If send_digits is provided, this parameter is ignored. For more information, see Answering Machine Detection.
string
The password required to authenticate the user account specified in sip_auth_username.
string
The username used to authenticate the caller making a SIP call.
string
The number of channels in the final recording. Can be: mono or dual. The default is mono. mono records both legs of the call in a single channel of the recording file. dual records each leg to a separate channel of the recording file. The first channel of a dual-channel recording contains the parent call and the second channel contains the child call.
array
The call progress events that we will send to the status_callback URL. Can be: initiated, ringing, answered, and completed. If no event is specified, we send the completed status. If you want to receive multiple events, specify each one in a separate status_callback_event parameter. See the code sample for monitoring call progress. If an application_sid is present, this parameter is ignored.
string ("GET" | "POST")
The HTTP method we should use when calling the status_callback URL. Can be: GET or POST and the default is POST. If an application_sid parameter is present, this parameter is ignored.
string
The URL that we should use to deliver push call notification.
string
The URL that we should call using the async_amd_status_callback_method to notify customer application whether the call was answered by human, machine or fax.
integer
The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with AnsweredBy of unknown. The default timeout is 30 seconds.
string
The URL that we call when the recording is available to be accessed.
string
The identifier of the configuration to be used when creating and processing the recording
array
The recording status events that will trigger calls to the URL specified in recording_status_callback. Can be: in-progress, completed and absent. Defaults to completed. Separate multiple values with a space.
string ("GET" | "POST")
The HTTP method we should use when calling the async_amd_status_callback URL. Can be: GET or POST and the default is POST.
string ("GET" | "POST")
The HTTP method we should use when calling the recording_status_callback URL. Can be: GET or POST and the default is POST.
integer
The number of milliseconds of initial silence after which an unknown AnsweredBy result will be returned. Possible Values: 2000-10000. Default: 5000.
integer
The number of milliseconds that is used as the measuring stick for the length of the speech activity, where durations lower than this value will be interpreted as a human and longer than this value as a machine. Possible Values: 1000-6000. Default: 2400.
integer
The number of milliseconds of silence after speech activity at which point the speech activity is considered complete. Possible Values: 500-5000. Default: 1200.

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: TWILIO_CREATE_CALL_RECORDINGCreate a recording for the call

Input Parameters

string
Whether to trim any leading and trailing silence in the recording. Can be: trim-silence or do-not-trim and the default is do-not-trim. trim-silence trims the silence from the beginning and end of the recording and do-not-trim does not.
string
required
The SID of the Call to associate the resource with.
string
required
The SID of the Account that will create the resource.
string
The audio track to record for the call. Can be: inbound, outbound or both. The default is both. inbound records the audio that is received by Twilio. outbound records the audio that is generated from Twilio. both records the audio that is received and generated by Twilio.
string
The number of channels used in the recording. Can be: mono or dual and the default is mono. mono records all parties of the call into one channel. dual records each party of a 2-party call into separate channels.
string
The URL we should call using the recording_status_callback_method on each recording event specified in recording_status_callback_event. For more information, see RecordingStatusCallback parameters.
string
The identifier of the configuration to be used when creating and processing the recording
array
The recording status events on which we should call the recording_status_callback URL. Can be: in-progress, completed and absent and the default is completed. Separate multiple event values with a space.
string ("GET" | "POST")
The HTTP method we should use to call recording_status_callback. Can be: GET or POST and the default is POST.

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: TWILIO_CREATE_INCOMING_PHONE_NUMBERPurchase a phone-number for the account.

Input Parameters

string
The URL we should call when the new phone number receives an incoming SMS message.
string
The desired area code for your new incoming phone number. Can be any three-digit, US or Canada area code. We will provision an available phone number within this area code for you. You must provide an area_code or a phone_number. (US and Canada only).
string
The SID of the Trunk we should use to handle calls to the new phone number. If a trunk_sid is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a trunk_sid will automatically delete your voice_application_sid and vice versa.
string
The URL that we should call to answer a call to the new phone number. The voice_url will not be called if a voice_application_sid or a trunk_sid is set.
string
The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.
string ("GET" | "POST")
The HTTP method that we should use to call sms_url. Can be: GET or POST and defaults to POST.
string
required
The SID of the Account that will create the resource.
string
The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.
string
The API version to use for incoming calls made to the new phone number. The default is 2010-04-01.
string
The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations.
string
The phone number to purchase specified in E.164 format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.
string ("GET" | "POST")
The HTTP method that we should use to call voice_url. Can be: GET or POST and defaults to POST.
string
A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the new phone number.
string
The URL we should call using the status_callback_method to send status information to your application.
string ("Active" | "Inactive")
The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country.
string
The URL that we should call when an error occurs while requesting or executing the TwiML defined by sms_url.
string
The URL that we should call when an error occurs retrieving or executing the TwiML requested by url.
string ("voice" | "fax")
Twilio VoiceReceiveMode request value.
string
The SID of the application that should handle SMS messages sent to the new phone number. If an sms_application_sid is present, we ignore all of the sms_*_url urls and use those set on the application.
string ("GET" | "POST")
The HTTP method that we should use to call sms_fallback_url. Can be: GET or POST and defaults to POST.
string
The SID of the emergency address configuration to use for emergency calling from the new phone number.
string
The SID of the application we should use to handle calls to the new phone number. If a voice_application_sid is present, we ignore all of the voice urls and use only those set on the application. Setting a voice_application_sid will automatically delete your trunk_sid and vice versa.
string ("GET" | "POST")
The HTTP method that we should use to call voice_fallback_url. Can be: GET or POST and defaults to POST.
string ("GET" | "POST")
The HTTP method we should use to call status_callback. Can be: GET or POST and defaults to POST.
boolean
Whether to lookup the caller’s name from the CNAM database and post it to your app. Can be: true or false and defaults to false.

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: TWILIO_CREATE_INCOMING_PHONE_NUMBER_ASSIGNED_ADD_ONAssign an Add-on installation to the Number specified.

Input Parameters

string
required
The SID of the Account that will create the resource.
string
required
The SID of the Phone Number to assign the Add-on.
string
required
The SID that identifies the Add-on installation.

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: TWILIO_CREATE_INCOMING_PHONE_NUMBER_LOCALCreate Incoming Phone Number Local using the Twilio api_v2010 REST API.

Input Parameters

string
The URL we should call when the new phone number receives an incoming SMS message.
string
The SID of the Trunk we should use to handle calls to the new phone number. If a trunk_sid is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a trunk_sid will automatically delete your voice_application_sid and vice versa.
string
The URL that we should call to answer a call to the new phone number. The voice_url will not be called if a voice_application_sid or a trunk_sid is set.
string
The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.
string ("GET" | "POST")
The HTTP method that we should use to call sms_url. Can be: GET or POST and defaults to POST.
string
required
The SID of the Account that will create the resource.
string
The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.
string
The API version to use for incoming calls made to the new phone number. The default is 2010-04-01.
string
The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations.
string
required
The phone number to purchase specified in E.164 format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.
string ("GET" | "POST")
The HTTP method that we should use to call voice_url. Can be: GET or POST and defaults to POST.
string
A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number.
string
The URL we should call using the status_callback_method to send status information to your application.
string ("Active" | "Inactive")
The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country.
string
The URL that we should call when an error occurs while requesting or executing the TwiML defined by sms_url.
string
The URL that we should call when an error occurs retrieving or executing the TwiML requested by url.
string ("voice" | "fax")
Twilio VoiceReceiveMode request value.
string
The SID of the application that should handle SMS messages sent to the new phone number. If an sms_application_sid is present, we ignore all of the sms_*_url urls and use those set on the application.
string ("GET" | "POST")
The HTTP method that we should use to call sms_fallback_url. Can be: GET or POST and defaults to POST.
string
The SID of the emergency address configuration to use for emergency calling from the new phone number.
string
The SID of the application we should use to handle calls to the new phone number. If a voice_application_sid is present, we ignore all of the voice urls and use only those set on the application. Setting a voice_application_sid will automatically delete your trunk_sid and vice versa.
string ("GET" | "POST")
The HTTP method that we should use to call voice_fallback_url. Can be: GET or POST and defaults to POST.
string ("GET" | "POST")
The HTTP method we should use to call status_callback. Can be: GET or POST and defaults to POST.
boolean
Whether to lookup the caller’s name from the CNAM database and post it to your app. Can be: true or false and defaults to false.

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: TWILIO_CREATE_INCOMING_PHONE_NUMBER_MOBILECreate Incoming Phone Number Mobile using the Twilio api_v2010 REST API.

Input Parameters

string
The URL we should call when the new phone number receives an incoming SMS message.
string
The SID of the Trunk we should use to handle calls to the new phone number. If a trunk_sid is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a trunk_sid will automatically delete your voice_application_sid and vice versa.
string
The URL that we should call to answer a call to the new phone number. The voice_url will not be called if a voice_application_sid or a trunk_sid is set.
string
The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.
string ("GET" | "POST")
The HTTP method that we should use to call sms_url. Can be: GET or POST and defaults to POST.
string
required
The SID of the Account that will create the resource.
string
The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.
string
The API version to use for incoming calls made to the new phone number. The default is 2010-04-01.
string
The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations.
string
required
The phone number to purchase specified in E.164 format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.
string ("GET" | "POST")
The HTTP method that we should use to call voice_url. Can be: GET or POST and defaults to POST.
string
A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, the is a formatted version of the phone number.
string
The URL we should call using the status_callback_method to send status information to your application.
string ("Active" | "Inactive")
The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country.
string
The URL that we should call when an error occurs while requesting or executing the TwiML defined by sms_url.
string
The URL that we should call when an error occurs retrieving or executing the TwiML requested by url.
string ("voice" | "fax")
Twilio VoiceReceiveMode request value.
string
The SID of the application that should handle SMS messages sent to the new phone number. If an sms_application_sid is present, we ignore all of the sms_*_url urls and use those of the application.
string ("GET" | "POST")
The HTTP method that we should use to call sms_fallback_url. Can be: GET or POST and defaults to POST.
string
The SID of the emergency address configuration to use for emergency calling from the new phone number.
string
The SID of the application we should use to handle calls to the new phone number. If a voice_application_sid is present, we ignore all of the voice urls and use only those set on the application. Setting a voice_application_sid will automatically delete your trunk_sid and vice versa.
string ("GET" | "POST")
The HTTP method that we should use to call voice_fallback_url. Can be: GET or POST and defaults to POST.
string ("GET" | "POST")
The HTTP method we should use to call status_callback. Can be: GET or POST and defaults to POST.
boolean
Whether to lookup the caller’s name from the CNAM database and post it to your app. Can be: true or false and defaults to false.

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: TWILIO_CREATE_INCOMING_PHONE_NUMBER_TOLL_FREECreate Incoming Phone Number Toll Free using the Twilio api_v2010 REST API.

Input Parameters

string
The URL we should call when the new phone number receives an incoming SMS message.
string
The SID of the Trunk we should use to handle calls to the new phone number. If a trunk_sid is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a trunk_sid will automatically delete your voice_application_sid and vice versa.
string
The URL that we should call to answer a call to the new phone number. The voice_url will not be called if a voice_application_sid or a trunk_sid is set.
string
The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.
string ("GET" | "POST")
The HTTP method that we should use to call sms_url. Can be: GET or POST and defaults to POST.
string
required
The SID of the Account that will create the resource.
string
The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.
string
The API version to use for incoming calls made to the new phone number. The default is 2010-04-01.
string
The SID of the Identity resource that we should associate with the new phone number. Some regions require an Identity to meet local regulations.
string
required
The phone number to purchase specified in E.164 format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.
string ("GET" | "POST")
The HTTP method that we should use to call voice_url. Can be: GET or POST and defaults to POST.
string
A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number.
string
The URL we should call using the status_callback_method to send status information to your application.
string ("Active" | "Inactive")
The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country.
string
The URL that we should call when an error occurs while requesting or executing the TwiML defined by sms_url.
string
The URL that we should call when an error occurs retrieving or executing the TwiML requested by url.
string ("voice" | "fax")
Twilio VoiceReceiveMode request value.
string
The SID of the application that should handle SMS messages sent to the new phone number. If an sms_application_sid is present, we ignore all sms_*_url values and use those of the application.
string ("GET" | "POST")
The HTTP method that we should use to call sms_fallback_url. Can be: GET or POST and defaults to POST.
string
The SID of the emergency address configuration to use for emergency calling from the new phone number.
string
The SID of the application we should use to handle calls to the new phone number. If a voice_application_sid is present, we ignore all of the voice urls and use those set on the application. Setting a voice_application_sid will automatically delete your trunk_sid and vice versa.
string ("GET" | "POST")
The HTTP method that we should use to call voice_fallback_url. Can be: GET or POST and defaults to POST.
string ("GET" | "POST")
The HTTP method we should use to call status_callback. Can be: GET or POST and defaults to POST.
boolean
Whether to lookup the caller’s name from the CNAM database and post it to your app. Can be: true or false and defaults to false.

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: TWILIO_CREATE_MESSAGESend a message

Input Parameters

string
required
The recipient’s phone number in E.164 format (for SMS/MMS) or channel address, e.g. whatsapp:+15552229999.
string
The text content of the outgoing message. Can be up to 1,600 characters in length. SMS only: If the body contains more than 160 GSM-7 characters (or 70 UCS-2 characters), the message is segmented and charged accordingly. For long body text, consider using the send_as_mms parameter.
string
The sender’s Twilio phone number (in E.164 format), alphanumeric sender ID, Wireless SIM, short code, or channel address (e.g., whatsapp:+15554449999). The value of the from parameter must be a sender that is hosted within Twilio and belongs to the Account creating the Message. If you are using messaging_service_sid, this parameter can be empty (Twilio assigns a from value from the Messaging Service’s Sender Pool) or you can provide a specific sender from your Sender Pool.
integer
Total number of attempts made (including this request) to send the message regardless of the provider used
string
The time that Twilio will send the message. Must be in ISO 8601 format.
number
[OBSOLETE] This parameter will no longer have any effect as of 2024-06-03.
array
The URL of media to include in the Message content. jpeg, jpg, gif, and png file types are fully supported by Twilio and content is formatted for delivery on destination devices. The media size limit is 5 MB for supported file types (jpeg, jpg, png, gif) and 500 KB for other types of accepted media. To send more than one image in the message, provide multiple media_url parameters in the POST request. You can include up to ten media_url parameters per message. International and carrier limits apply.
string ("enable" | "disable")
Include this parameter with a value of disable to skip any kind of risk check on the respective message request.
string
required
The SID of the Account creating the Message resource.
string
For Content Editor/API only: The SID of the Content Template to be used with the Message, e.g., HXXXXXXXXXXXXXXXXXXXXXXXXXXXXX. If this parameter is not provided, a Content Template is not used. Find the SID in the Console on the Content Editor page. For Content API users, the SID is found in Twilio’s response when creating the Template or by fetching your Templates.
boolean
If set to true, Twilio delivers the message as a single MMS message, regardless of the presence of media.
boolean
For Messaging Services with Link Shortening configured only: A Boolean indicating whether or not Twilio should shorten links in the body of the Message. Default value is false. If true, the messaging_service_sid parameter must also be provided.
string
Twilio TrafficType request value.
string
A fallback SMS sender to use when the recipient cannot be reached over RCS. This parameter may only be used when also providing a Messaging Service containing an RCS sender. The fallback SMS sender must be either a Twilio phone number (in E.164 format), alphanumeric sender ID, or short code, hosted within Twilio and belong to the Account creating the Message.
string
For Messaging Services only: Include this parameter with a value of fixed in conjuction with the send_time parameter in order to schedule a Message.
boolean
Whether to detect Unicode characters that have a similar GSM-7 character and replace them. Can be: true or false.
boolean
Reserved
string
Specifies the purpose or use case of the outbound communication. This parameter is used by Twilio’s Traffic Shaping and Compliance Toolkit products. Possible values include: otp, notifications, marketing, fraud, security, customercare, delivery, education, polling, announcements, and events.
string
The SID of the associated TwiML Application. Message status callback requests are sent to the TwiML App’s message_status_callback URL. Note that the status_callback parameter of a request takes priority over the application_sid parameter; if both are included application_sid is ignored.
string
The URL of the endpoint to which Twilio sends Message status callback requests. URL must contain a valid hostname and underscores are not allowed. If you include this parameter with the messaging_service_sid, Twilio uses this URL instead of the Status Callback URL of the Messaging Service.
integer
The maximum length in seconds that the Message can remain in Twilio’s outgoing message queue. If a queued Message exceeds the validity_period, the Message is not sent. Accepted values are integers from 1 to 36000. Default value is 36000. A validity_period greater than 5 is recommended. Learn more about the validity period
boolean
Boolean indicating whether or not you intend to provide delivery confirmation feedback to Twilio (used in conjunction with the Message Feedback subresource). Default value is false.
string ("retain" | "obfuscate")
Determines if the address can be stored or obfuscated based on privacy settings
string ("retain" | "discard")
Determines if the message content can be stored or redacted based on privacy settings
string
For Content Editor/API only: Key-value pairs of Template variables and their substitution values. content_sid parameter must also be provided. If values are not defined in the content_variables parameter, the Template’s default placeholder values are used.
array
Rich actions for non-SMS/MMS channels. Used for sending location in WhatsApp messages.
string
The SID of the Messaging Service you want to associate with the Message. When this parameter is provided and the from parameter is omitted, Twilio selects the optimal sender from the Messaging Service’s Sender Pool. You may also provide a from parameter if you want to use a specific Sender from the Sender Pool.

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: TWILIO_CREATE_MESSAGE_FEEDBACKCreate Message Feedback to confirm a tracked user action was performed by the recipient of the associated Message

Input Parameters

string ("confirmed" | "unconfirmed")
Reported outcome indicating whether there is confirmation that the Message recipient performed a tracked user action. Can be: unconfirmed or confirmed. For more details see How to Optimize Message Deliverability with Message Feedback.
string
required
The SID of the Account associated with the Message resource for which to create MessageFeedback.
string
required
The SID of the Message resource for which to create MessageFeedback.

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: TWILIO_CREATE_NEW_KEYCreate New Key using the Twilio api_v2010 REST API.

Input Parameters

string
required
The SID of the Account that will be responsible for the new Key resource.
string
A descriptive string that you create to describe the resource. It can be up to 64 characters long.

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: TWILIO_CREATE_NEW_SIGNING_KEYCreate a new Signing Key for the account making the request.

Input Parameters

string
required
The SID of the Account that will be responsible for the new Key resource.
string
A descriptive string that you create to describe the resource. It can be up to 64 characters long.

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: TWILIO_CREATE_PARTICIPANTCreate Participant using the Twilio api_v2010 REST API.

Input Parameters

string
required
The phone number, SIP address, Client, TwiML App identifier that received this call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as sip:name@company.com. Client identifiers are formatted client:name. TwiML App identifiers are formatted app:<APP_SID>. Custom parameters may also be specified.
string
Whether to play a notification beep to the conference when the participant joins. Can be: true, false, onEnter, or onExit. The default value is true.
string
The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that byoc is only meaningful when to is a phone number; it will otherwise be ignored. (Beta)
string
Whether to trim any leading and trailing silence from the participant recording. Can be: trim-silence or do-not-trim and the default is trim-silence.
string
required
The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in E.164 format (e.g., +16175551212). Client identifiers are formatted client:name. If using a phone number, it must be a Twilio number or a Verified outgoing caller id for your account. If the to parameter is a phone number, from must also be a phone number. If to is sip address, this value of from should be a username portion to be used to populate the P-Asserted-Identity header that is passed to the SIP endpoint.
string
A label for this participant. If one is supplied, it may subsequently be used to fetch, update or delete the participant.
boolean
Whether the agent is muted in the conference. Can be true or false and the default is false.
boolean
Whether to record the participant and their conferences, including the time between conferences. Can be true or false and the default is false.
string
The region where we should mix the recorded audio. Can be:us1, us2, ie1, de1, sg1, br1, au1, or jp1.
integer
The number of seconds that we should allow the phone to ring before assuming there is no answer. Can be an integer between 5 and 600, inclusive. The default value is 60. We always add a 5-second timeout buffer to outgoing calls, so value of 10 would result in an actual timeout that was closer to 15 seconds.
boolean
Whether the participant is coaching another call. Can be: true or false. If not present, defaults to false unless call_sid_to_coach is defined. If true, call_sid_to_coach must be defined.
string
The URL that Twilio calls using the wait_method before the conference has started. The URL may return an MP3 file, a WAV file, or a TwiML document. The default value is the URL of our standard hold music. If you do not want anything to play while waiting for the conference to start, specify an empty string by setting wait_url to ''. For more details on the allowable verbs within the waitUrl, see the waitUrl attribute in the <Conference> TwiML instruction.
string
The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in E.164 format (e.g., +16175551212). Client identifiers are formatted client:name. If using a phone number, it must be a Twilio number or a Verified outgoing caller id for your account. If the to parameter is a phone number, callerId must also be a phone number. If to is sip address, this value of callerId should be a username portion to be used to populate the From header that is passed to the SIP endpoint.
string
The STIR/SHAKEN passport for this call, provided as a base64 encoded string. Multiple passports (at max 5) are comma separated and provided as base64 encoded string
string
A token string needed to invoke a forwarded call. A call_token is generated when an incoming call is received on a Twilio number. Pass an incoming call’s call_token value to a forwarded call via the call_token parameter when creating a new call. A forwarded call should bear the same CallerID of the original incoming call.
integer
The maximum duration of the call in seconds. Constraints depend on account and configuration.
string
required
The SID of the Account that will create the resource.
string
The Reason for the outgoing call. Use it to specify the purpose of the call that is presented on the called party’s phone. (Branded Calls Beta)
boolean
Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. Can be: true or false and defaults to true.
string ("GET" | "POST")
The HTTP method we should use to call wait_url. Can be GET or POST and the default is POST. When using a static audio file, this should be GET so that we can cache the file.
string
required
The SID of the participant’s conference.
string
The emergency caller’s city or municipality name. Should be the official city name as recognized by local authorities. Used in combination with state and country for emergency call routing. Note: If the value exceeds 20 characters, only the first 20 characters will be used.
string
The emergency caller’s organization or entity name. Note: If the value exceeds 20 characters, only the first 20 characters will be used.
string
Whether to trim leading and trailing silence from the conference recording. Can be: trim-silence or do-not-trim and defaults to trim-silence.
string
The emergency caller’s state or province. Note: If the value exceeds 20 characters, only the first 20 characters will be used.
string
The audio track to record for the call. Can be: inbound, outbound or both. The default is both. inbound records the audio that is received by Twilio. outbound records the audio that is sent from Twilio. both records the audio that is received and sent by Twilio.
string
The URL we should call using the status_callback_method to send status information to your application.
integer
The maximum number of participants in the conference. Can be a positive integer from 2 to 250. The default value is 250.
string
The SID of the participant who is being coached. The participant being coached is the only participant who can hear the participant who is coaching.
string
Whether to record the conference the participant is joining. Can be: true, false, record-from-start, and do-not-record. The default value is false.
string
The emergency caller’s street address including street number and street name. Note: If the value exceeds 60 characters, only the first 60 characters will be used.
string
The emergency caller’s country. Currently supported US and CA only. Note: If the value exceeds 20 characters, only the first 20 characters will be used.
string
Whether to detect if a human, answering machine, or fax has picked up the call. Can be: Enable or DetectMessageEnd. Use Enable if you would like us to return AnsweredBy as soon as the called party is identified. Use DetectMessageEnd, if you would like to leave a message on an answering machine. For more information, see Answering Machine Detection.
string
The SIP password for authentication.
string
The SIP username used for authentication.
string
The emergency caller’s postal code or ZIP code. Note: If the value exceeds 20 characters, only the first 20 characters will be used.
string
Jitter buffer size for the connecting participant. Twilio will use this setting to apply Jitter Buffer before participant’s audio is mixed into the conference. Can be: off, small, medium, and large. Default to large.
string
The recording channels for the final recording. Can be: mono or dual and the default is mono.
string
The URL that we should call using the amd_status_callback_method to notify customer application whether the call was answered by human, machine or fax.
string
The name that populates the display name in the From header. Must be between 2 and 255 characters. Only applicable for calls to sip address.
array
The conference state changes that should generate a call to status_callback. Can be: initiated, ringing, answered, and completed. Separate multiple values with a space. The default value is completed.
boolean
Whether to end the conference when the participant leaves. Can be: true or false and defaults to false.
string ("GET" | "POST")
The HTTP method we should use to call status_callback. Can be: GET and POST and defaults to POST.
string
The URL that we should use to deliver push call notification.
string
The emergency caller’s physical location description within a building or facility. Note: If the value exceeds 20 characters, only the first 20 characters will be used.
string
The emergency caller’s GPS coordinates in decimal degrees format. Format: “latitude longitude” (space-separated) - Latitude: decimal degrees, range -90.0 to +90.0 (negative for South, positive for North) - Longitude: decimal degrees, range -180.0 to +180.0 (negative for West, positive for East) - Precision: up to 6 decimal places recommended for meter-level accuracy Note: If the value exceeds 150 characters, only the first 150 characters will be used.
integer
The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with AnsweredBy of unknown. The default timeout is 30 seconds.
string
The URL that we should call using the recording_status_callback_method when the recording status changes.
boolean
Whether to start the conference when the participant joins, if it has not already started. Can be: true or false and the default is true. If false and the conference has not started, the participant is muted and hears background music until another participant starts the conference.
string ("GET" | "POST")
The HTTP method we should use when calling the amd_status_callback URL. Can be: GET or POST and the default is POST.
string
The URL we should call using the conference_status_callback_method when the conference events in conference_status_callback_event occur. Only the value set by the first participant to join the conference is used. Subsequent conference_status_callback values are ignored.
string
The identifier of the configuration to be used when creating and processing the recording
array
The recording state changes that should generate a call to recording_status_callback. Can be: started, in-progress, paused, resumed, stopped, completed, failed, and absent. Separate multiple values with a space, ex: 'in-progress completed failed'.
array
The conference state changes that should generate a call to conference_status_callback. Can be: start, end, join, leave, mute, hold, modify, speaker, and announcement. Separate multiple values with a space. Defaults to start end.
string ("GET" | "POST")
The HTTP method we should use when we call recording_status_callback. Can be: GET or POST and defaults to POST.
string ("GET" | "POST")
The HTTP method we should use to call conference_status_callback. Can be: GET or POST and defaults to POST.
integer
The number of milliseconds of initial silence after which an unknown AnsweredBy result will be returned. Possible Values: 2000-10000. Default: 5000.
integer
The number of milliseconds that is used as the measuring stick for the length of the speech activity, where durations lower than this value will be interpreted as a human and longer than this value as a machine. Possible Values: 1000-6000. Default: 2400.
string
The URL we should call using the conference_recording_status_callback_method when the conference recording is available.
integer
The number of milliseconds of silence after speech activity at which point the speech activity is considered complete. Possible Values: 500-5000. Default: 1200.
array
The conference recording state changes that generate a call to conference_recording_status_callback. Can be: in-progress, completed, failed, and absent. Separate multiple values with a space, ex: 'in-progress completed failed'
string ("GET" | "POST")
The HTTP method we should use to call conference_recording_status_callback. Can be: GET or POST and defaults to POST.

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: TWILIO_CREATE_PAYMENTScreate an instance of payments. This will start a new payments session

Input Parameters

string
A list of inputs that should be accepted. Currently only dtmf is supported. All digits captured during a pay session are redacted from the logs.
integer
The number of seconds that <Pay> should wait for the caller to press a digit between each subsequent digit, after the first one, before moving on to validate the digits captured. The default is 5, maximum is 600.
string
required
The SID of the call that will create the resource. Call leg associated with this sid is expected to provide payment information thru DTMF.
string
The currency of the charge_amount, formatted as ISO 4127 format. The default value is USD and all values allowed from the Pay Connector are accepted.
object
A single-level JSON object used to pass custom parameters to payment processors. (Required for ACH payments). The information that has to be included here depends on the <Pay> Connector. Read more.
string ("one-time" | "reusable" | "payment-method")
Indicates whether the payment method should be tokenized as a one-time, reusable, or payment-method token. The default value is reusable. Do not enter a charge amount when tokenizing. If a charge amount is entered, the payment method will be charged and not tokenized.
string
required
The SID of the Account that will create the resource.
string
The description can be used to provide more details regarding the transaction. This information is submitted along with the payment details to the Payment Connector which are then posted on the transactions.
boolean
Indicates whether the credit card postal code (zip code) is a required piece of payment information that must be provided by the caller. The default is true.
string ("true" | "false")
Whether to prompt the caller to confirm their payment information before submitting to the payment gateway. If true, the caller will hear the last 4 digits of their card or account number and must press 1 to confirm or 2 to cancel. Default is false.
number
A positive decimal value less than 1,000,000 to charge against the credit card or bank account. Default currency can be overwritten with currency field. Leave blank or set to 0 to tokenize.
boolean
Indicates whether the credit card security code is a required piece of payment information that must be provided by the caller. The default is true.
string ("credit-card" | "ach-debit")
Type of payment being captured. One of credit-card or ach-debit. The default value is credit-card.
string
required
A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions. This should be a unique string value per API call and can be a randomly generated.
string
required
Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the expected StatusCallback values
string
Credit card types separated by space that Pay should accept. The default value is visa mastercard amex
string ("consumer-checking" | "consumer-savings" | "commercial-checking")
Type of bank account if payment source is ACH. One of consumer-checking, consumer-savings, or commercial-checking. The default value is consumer-checking.
string
This is the unique name corresponding to the Pay Connector installed in the Twilio Add-ons. Learn more about <Pay> Connectors. The default value is Default.
integer
A positive integer that is used to validate the length of the PostalCode inputted by the user. User must enter this many digits.
string
A comma-separated list of payment information fields that require the caller to enter the same value twice for confirmation. Supported values are payment-card-number, expiration-date, security-code, and postal-code.

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: TWILIO_CREATE_QUEUECreate a queue

Input Parameters

integer
The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000.
string
required
The SID of the Account that will create the resource.
string
required
A descriptive string that you created to describe this resource. It can be up to 64 characters long.

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: TWILIO_CREATE_REALTIME_TRANSCRIPTIONCreate a Transcription

Input Parameters

string
The user-specified name of this Transcription, if one was given when the Transcription was created. This may be used to stop the Transcription.
string
A Phrase contains words and phrase “hints” so that the speech recognition engine is more likely to recognize them.
string ("inbound_track" | "outbound_track" | "both_tracks")
One of inbound_track, outbound_track, both_tracks.
string
required
The SID of the Call the Transcription resource is associated with.
string
required
The SID of the Account that created this Transcription resource.
string
Recognition model used by the transcription engine, among those supported by the provider
string
Language code used by the transcription engine, specified in BCP-47 format
string
The ID of the Conversation for associating this Transcription with an existing Conversation in Intelligence Service
boolean
Indicates if partial results are going to be sent to the customer
boolean
indicates if the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks
string
Friendly name given to the Inbound Track
string
Absolute URL of the status callback.
boolean
Whether the callback includes raw provider data.
string
The SID or unique name of the Intelligence Service for persisting transcripts and running post-call Language Operators
string
Friendly name given to the Outbound Track
string
Definition of the transcription engine to be used, among those supported by Twilio
string ("GET" | "POST")
The http method for the status_callback (one of GET, POST).
string
The ID of the Conversations Configuration for customizing conversation behavior in Intelligence Service
boolean
The provider will add punctuation to recognition result
string
The ID of the RealTimeTranscription Configuration for configuring all the non-default behaviors in one go.

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: TWILIO_CREATE_SIP_AUTH_CALLS_CREDENTIAL_LIST_MAPPINGCreate a new credential list mapping resource

Input Parameters

string
required
The SID of the SIP domain that will contain the new resource.
string
required
The SID of the Account that will create the resource.
string
required
The SID of the CredentialList resource to map to the SIP domain.

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: TWILIO_CREATE_SIP_AUTH_CALLS_IP_ACCESS_CONTROL_LIST_MAPPINGCreate a new IP Access Control List mapping

Input Parameters

string
required
The SID of the SIP domain that will contain the new resource.
string
required
The SID of the Account that will create the resource.
string
required
The SID of the IpAccessControlList resource to map to the SIP domain.

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: TWILIO_CREATE_SIP_AUTH_REGISTRATIONS_CREDENTIAL_LIST_MAPPINGCreate a new credential list mapping resource

Input Parameters

string
required
The SID of the SIP domain that will contain the new resource.
string
required
The SID of the Account that will create the resource.
string
required
The SID of the CredentialList resource to map to the SIP domain.

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: TWILIO_CREATE_SIP_CREDENTIALCreate a new credential resource.

Input Parameters

string
required
The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg IWasAtSignal2018)
string
required
The username that will be passed when authenticating SIP requests. The username should be sent in response to Twilio’s challenge of the initial INVITE. It can be up to 32 characters long.
string
required
The unique id of the Account that is responsible for this resource.
string
required
The unique id that identifies the credential list to include the created credential.

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: TWILIO_CREATE_SIP_CREDENTIAL_LISTCreate a Credential List

Input Parameters

string
required
The unique id of the Account that is responsible for this resource.
string
required
A human readable descriptive text that describes the CredentialList, up to 64 characters long.

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: TWILIO_CREATE_SIP_CREDENTIAL_LIST_MAPPINGCreate a CredentialListMapping resource for an account.

Input Parameters

string
required
A 34 character string that uniquely identifies the SIP Domain for which the CredentialList resource will be mapped.
string
required
The unique id of the Account responsible for this resource.
string
required
A 34 character string that uniquely identifies the CredentialList resource to map to the SIP domain.

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: TWILIO_CREATE_SIP_DOMAINCreate a new Domain

Input Parameters

boolean
Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain.
string
The URL we should when the domain receives a call.
string
required
The SID of the Account that will create the resource.
string
required
The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and ”-” and must end with sip.twilio.com.
string ("GET" | "POST")
The HTTP method we should use to call voice_url. Can be: GET or POST.
string
A descriptive string that you created to describe the resource. It can be up to 64 characters long.
string
The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with.
boolean
Whether to allow SIP Endpoints to register with the domain to receive calls. Can be true or false. true allows SIP Endpoints to register with the domain to receive calls, false does not.
string
The URL that we should call when an error occurs while retrieving or executing the TwiML from voice_url.
string
Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call.
string ("GET" | "POST")
The HTTP method we should use to call voice_fallback_url. Can be: GET or POST.
boolean
Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.
string
The URL that we should call to pass status parameters (such as call ended) to your application.
string ("GET" | "POST")
The HTTP method we should use to call voice_status_callback_url. Can be: GET or POST.

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: TWILIO_CREATE_SIP_IP_ACCESS_CONTROL_LISTCreate a new IpAccessControlList resource

Input Parameters

string
required
The unique id of the Account responsible for this resource.
string
required
A human readable descriptive text that describes the IpAccessControlList, up to 255 characters long.

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: TWILIO_CREATE_SIP_IP_ACCESS_CONTROL_LIST_MAPPINGCreate a new IpAccessControlListMapping resource.

Input Parameters

string
required
A 34 character string that uniquely identifies the SIP domain.
string
required
The unique id of the Account that is responsible for this resource.
string
required
The unique id of the IP access control list to map to the SIP domain.

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: TWILIO_CREATE_SIP_IP_ADDRESSCreate a new IpAddress resource.

Input Parameters

string
required
An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today.
string
required
The unique id of the Account responsible for this resource.
string
required
A human readable descriptive text for this resource, up to 255 characters long.
integer
An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used.
string
required
The IpAccessControlList Sid with which to associate the created IpAddress resource.

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: TWILIO_CREATE_SIPRECCreate a Siprec

Input Parameters

string
The user-specified name of this Siprec, if one was given when the Siprec was created. This may be used to stop the Siprec.
string ("inbound_track" | "outbound_track" | "both_tracks")
One of inbound_track, outbound_track, both_tracks.
string
required
The SID of the Call the Siprec resource is associated with.
string
required
The SID of the Account that created this Siprec resource.
string
Unique name used when configuring the connector via Marketplace Add-on.
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Absolute URL of the status callback.
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter value
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter value
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter value
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter value
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter value
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter value
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter value
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter value
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string ("GET" | "POST")
The http method for the status_callback (one of GET, POST).

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: TWILIO_CREATE_STREAMCreate a Stream

Input Parameters

string
required
Relative or absolute URL where WebSocket connection will be established.
string
The user-specified name of this Stream, if one was given when the Stream was created. This can be used to stop the Stream.
string ("inbound_track" | "outbound_track" | "both_tracks")
The tracks to be included in the Stream. Possible values are inbound_track, outbound_track, both_tracks. Default value is inbound_track.
string
required
The SID of the Call the Stream resource is associated with.
string
required
The SID of the Account that created this Stream resource.
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Absolute URL to which Twilio sends status callback HTTP requests.
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter value
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter value
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter value
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter value
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter value
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter value
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter value
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter value
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter name
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string
Parameter value
string ("GET" | "POST")
The HTTP method Twilio uses when sending status_callback requests. Possible values are GET and POST. Default is POST.

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: TWILIO_CREATE_TOKENCreate a new token for ICE servers

Input Parameters

integer
The duration in seconds for which the generated credentials are valid. The default value is 86400 (24 hours).
string
required
The SID of the Account that will create the resource.

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: TWILIO_CREATE_USAGE_TRIGGERCreate a new UsageTrigger

Input Parameters

string ("daily" | "monthly" | "yearly" | "alltime")
The frequency of a recurring UsageTrigger. Can be: daily, monthly, or yearly for recurring triggers or empty for non-recurring triggers. A trigger will only fire once during each period. Recurring times are in GMT.
string ("count" | "usage" | "price")
The field in the UsageRecord resource that fires the trigger. Can be: count, usage, or price, as described in the UsageRecords documentation.
string
required
The SID of the Account that will create the resource.
string
required
The URL we should call using callback_method when the trigger fires.
string
A descriptive string that you create to describe the resource. It can be up to 64 characters long.
string
required
The usage value at which the trigger should fire. For convenience, you can use an offset value such as +30 to specify a trigger_value that is 30 units more than the current usage value. Be sure to urlencode a + as %2B.
string
required
The usage category that the trigger should watch. Use one of the supported usage categories for this value.
string ("GET" | "POST")
The HTTP method we should use to call callback_url. Can be: GET or POST and the default is POST.

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: TWILIO_CREATE_USER_DEFINED_MESSAGECreate a new User Defined Message for the given Call SID.

Input Parameters

string
required
The User Defined Message in the form of URL-encoded JSON string.
string
required
The SID of the Call the User Defined Message is associated with.
string
required
The SID of the Account that created User Defined Message.
string
A unique string value to identify API call. This should be a unique string value per API call and can be a randomly generated.

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: TWILIO_CREATE_USER_DEFINED_MESSAGE_SUBSCRIPTIONSubscribe to User Defined Messages for a given Call SID.

Input Parameters

string ("GET" | "POST")
The HTTP method Twilio will use when requesting the above Url. Either GET or POST. Default is POST.
string
required
The SID of the Call the User Defined Messages subscription is associated with. This refers to the Call SID that is producing the user defined messages.
string
required
The URL we should call using the method to send user defined events to your application. URLs must contain a valid hostname (underscores are not permitted).
string
required
The SID of the Account that subscribed to the User Defined Messages.
string
A unique string value to identify API call. This should be a unique string value per API call and can be a randomly generated.

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: TWILIO_CREATE_VALIDATION_REQUESTCreate Validation Request using the Twilio api_v2010 REST API.

Input Parameters

string
The digits to dial after connecting the verification call.
integer
The number of seconds to delay before initiating the verification call. Can be an integer between 0 and 60, inclusive. The default is 0.
string
required
The SID of the Account responsible for the new caller ID resource.
string
required
The phone number to verify in E.164 format, which consists of a + followed by the country code and subscriber number.
string
A descriptive string that you create to describe the new caller ID resource. It can be up to 64 characters long. The default value is a formatted version of the phone number.
string
The URL we should call using the status_callback_method to send status information about the verification process to your application.
string ("GET" | "POST")
The HTTP method we should use to call status_callback. Can be: GET or POST, and the default is POST.

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: TWILIO_DELETE_ADDRESSDelete Address using the Twilio api_v2010 REST API.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Address resource to delete.
string
required
The SID of the Account that is responsible for the Address resource 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: TWILIO_DELETE_APPLICATIONDelete the application by the specified application sid

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Application resource to delete.
string
required
The SID of the Account that created the Application resources 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: TWILIO_DELETE_CALLDelete a Call record from your account. Once the record is deleted, it will no longer appear in the API and Account Portal logs.

Input Parameters

string
required
The Twilio-provided Call SID that uniquely identifies the Call resource to delete
string
required
The SID of the Account that created the Call resource(s) 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: TWILIO_DELETE_CALL_RECORDINGDelete a recording from your account

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Recording resource to delete.
string
required
The Call SID of the resources to delete.
string
required
The SID of the Account that created the Recording resources 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: TWILIO_DELETE_CONFERENCE_RECORDINGDelete a recording from your account

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Conference Recording resource to delete.
string
required
The SID of the Account that created the Conference Recording resources to delete.
string
required
The Conference SID that identifies the conference associated with the recording 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: TWILIO_DELETE_INCOMING_PHONE_NUMBERDelete a phone-numbers belonging to the account used to make the request.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the IncomingPhoneNumber resource to delete.
string
required
The SID of the Account that created the IncomingPhoneNumber resources 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: TWILIO_DELETE_INCOMING_PHONE_NUMBER_ASSIGNED_ADD_ONRemove the assignment of an Add-on installation from the Number specified.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the resource to delete.
string
required
The SID of the Account that created the resources to delete.
string
required
The SID of the Phone Number to which the Add-on is assigned.

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: TWILIO_DELETE_KEYDelete Key using the Twilio api_v2010 REST API.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Key resource to delete.
string
required
The SID of the Account that created the Key resources 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: TWILIO_DELETE_MEDIADelete the Media resource.

Input Parameters

string
required
The unique identifier of the to-be-deleted Media resource.
string
required
The SID of the Account that is associated with the Media resource.
string
required
The SID of the Message resource that is associated with the Media resource.

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: TWILIO_DELETE_MESSAGEDeletes a Message resource from your account

Input Parameters

string
required
The SID of the Message resource you wish to delete
string
required
The SID of the Account associated with the Message resource

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: TWILIO_DELETE_OUTGOING_CALLER_IDDelete the caller-id specified from the account

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to delete.
string
required
The SID of the Account that created the OutgoingCallerId resources 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: TWILIO_DELETE_PARTICIPANTKick a participant from a given conference

Input Parameters

string
required
The Call SID or label of the participant to delete. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20.
string
required
The SID of the Account that created the Participant resources to delete.
string
required
The SID of the conference with the participants 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: TWILIO_DELETE_QUEUERemove an empty queue

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Queue resource to delete
string
required
The SID of the Account that created the Queue resource 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: TWILIO_DELETE_RECORDINGDelete a recording from your account

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Recording resource to delete.
string
required
The SID of the Account that created the Recording resources 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: TWILIO_DELETE_RECORDING_ADD_ON_RESULTDelete a result and purge all associated Payloads

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Recording AddOnResult resource to delete.
string
required
The SID of the Account that created the Recording AddOnResult resources to delete.
string
required
The SID of the recording to which the result to delete belongs.

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: TWILIO_DELETE_RECORDING_ADD_ON_RESULT_PAYLOADDelete a payload from the result along with all associated Data

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Recording AddOnResult Payload resource to delete.
string
required
The SID of the Account that created the Recording AddOnResult Payload resources to delete.
string
required
The SID of the recording to which the AddOnResult resource that contains the payloads to delete belongs.
string
required
The SID of the AddOnResult to which the payloads to delete belongs.

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: TWILIO_DELETE_RECORDING_TRANSCRIPTIONDelete Recording Transcription using the Twilio api_v2010 REST API.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Transcription resource to delete.
string
required
The SID of the Account that created the Transcription resources to delete.
string
required
The SID of the Recording that created the transcription 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: TWILIO_DELETE_SIGNING_KEYDelete Signing Key using the Twilio api_v2010 REST API.

Input Parameters

string
required
Twilio Sid parameter.
string
required
Twilio AccountSid parameter.

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: TWILIO_DELETE_SIP_AUTH_CALLS_CREDENTIAL_LIST_MAPPINGDelete a credential list mapping from the requested domain

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the CredentialListMapping resource to delete.
string
required
The SID of the SIP domain that contains the resource to delete.
string
required
The SID of the Account that created the CredentialListMapping resources 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: TWILIO_DELETE_SIP_AUTH_CALLS_IP_ACCESS_CONTROL_LIST_MAPPINGDelete an IP Access Control List mapping from the requested domain

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the IpAccessControlListMapping resource to delete.
string
required
The SID of the SIP domain that contains the resources to delete.
string
required
The SID of the Account that created the IpAccessControlListMapping resources 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: TWILIO_DELETE_SIP_AUTH_REGISTRATIONS_CREDENTIAL_LIST_MAPPINGDelete a credential list mapping from the requested domain

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the CredentialListMapping resource to delete.
string
required
The SID of the SIP domain that contains the resources to delete.
string
required
The SID of the Account that created the CredentialListMapping resources 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: TWILIO_DELETE_SIP_CREDENTIALDelete a credential resource.

Input Parameters

string
required
The unique id that identifies the resource to delete.
string
required
The unique id of the Account that is responsible for this resource.
string
required
The unique id that identifies the credential list that contains the desired credentials.

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: TWILIO_DELETE_SIP_CREDENTIAL_LISTDelete a Credential List

Input Parameters

string
required
The credential list Sid that uniquely identifies this resource
string
required
The unique id of the Account that is responsible for this resource.

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: TWILIO_DELETE_SIP_CREDENTIAL_LIST_MAPPINGDelete a CredentialListMapping resource from an account.

Input Parameters

string
required
A 34 character string that uniquely identifies the resource to delete.
string
required
A 34 character string that uniquely identifies the SIP Domain that includes the resource to delete.
string
required
The unique id of the Account responsible for this resource.

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: TWILIO_DELETE_SIP_DOMAINDelete an instance of a Domain

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the SipDomain resource to delete.
string
required
The SID of the Account that created the SipDomain resources 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: TWILIO_DELETE_SIP_IP_ACCESS_CONTROL_LISTDelete an IpAccessControlList from the requested account

Input Parameters

string
required
A 34 character string that uniquely identifies the resource to delete.
string
required
The unique id of the Account responsible for this resource.

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: TWILIO_DELETE_SIP_IP_ACCESS_CONTROL_LIST_MAPPINGDelete an IpAccessControlListMapping resource.

Input Parameters

string
required
A 34 character string that uniquely identifies the resource to delete.
string
required
A 34 character string that uniquely identifies the SIP domain.
string
required
The unique id of the Account that is responsible for this resource.

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: TWILIO_DELETE_SIP_IP_ADDRESSDelete an IpAddress resource.

Input Parameters

string
required
A 34 character string that uniquely identifies the resource to delete.
string
required
The unique id of the Account responsible for this resource.
string
required
The IpAccessControlList Sid that identifies the IpAddress resources 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: TWILIO_DELETE_TRANSCRIPTIONDelete a transcription from the account used to make the request

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Transcription resource to delete.
string
required
The SID of the Account that created the Transcription resources 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: TWILIO_DELETE_USAGE_TRIGGERDelete Usage Trigger using the Twilio api_v2010 REST API.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the UsageTrigger resource to delete.
string
required
The SID of the Account that created the UsageTrigger resources 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: TWILIO_DELETE_USER_DEFINED_MESSAGE_SUBSCRIPTIONDelete a specific User Defined Message Subscription.

Input Parameters

string
required
The SID that uniquely identifies this User Defined Message Subscription.
string
required
The SID of the Call the User Defined Message Subscription is associated with. This refers to the Call SID that is producing the User Defined Messages.
string
required
The SID of the Account that subscribed to the User Defined Messages.

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: TWILIO_FETCH_ACCOUNTFetch the account specified by the provided Account Sid

Input Parameters

string
required
The Account Sid that uniquely identifies the account to fetch

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: TWILIO_FETCH_ADDRESSFetch Address using the Twilio api_v2010 REST API.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Address resource to fetch.
string
required
The SID of the Account that is responsible for the Address resource to fetch.

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: TWILIO_FETCH_APPLICATIONFetch the application specified by the provided sid

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Application resource to fetch.
string
required
The SID of the Account that created the Application resource to fetch.

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: TWILIO_FETCH_AUTHORIZED_CONNECT_APPFetch an instance of an authorized-connect-app

Input Parameters

string
required
The SID of the Account that created the AuthorizedConnectApp resource to fetch.
string
required
The SID of the Connect App to fetch.

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: TWILIO_FETCH_AVAILABLE_PHONE_NUMBER_COUNTRYFetch Available Phone Number Country using the Twilio api_v2010 REST API.

Input Parameters

string
required
The SID of the Account requesting the available phone number Country resource.
string
required
The ISO-3166-1 country code of the country to fetch available phone number information about.

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: TWILIO_FETCH_BALANCEFetch the balance for an Account based on Account Sid. Balance changes may not be reflected immediately. Child accounts do not contain balance information

Input Parameters

string
required
The unique SID identifier of the 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: TWILIO_FETCH_CALLFetch the call specified by the provided Call SID

Input Parameters

string
required
The SID of the Call resource to fetch.
string
required
The SID of the Account that created the Call resource(s) to fetch.

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: TWILIO_FETCH_CALL_NOTIFICATIONFetch Call Notification using the Twilio api_v2010 REST API.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Call Notification resource to fetch.
string
required
The Call SID of the Call Notification resource to fetch.
string
required
The SID of the Account that created the Call Notification resource to fetch.

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: TWILIO_FETCH_CALL_RECORDINGFetch an instance of a recording for a call

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Recording resource to fetch.
string
required
The Call SID of the resource to fetch.
string
required
The SID of the Account that created the Recording resource to fetch.

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: TWILIO_FETCH_CONFERENCEFetch an instance of a conference

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Conference resource to fetch
string
required
The SID of the Account that created the Conference resource(s) to fetch.

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: TWILIO_FETCH_CONFERENCE_RECORDINGFetch an instance of a recording for a call

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Conference Recording resource to fetch.
string
required
The SID of the Account that created the Conference Recording resource to fetch.
string
required
The Conference SID that identifies the conference associated with the recording to fetch.

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: TWILIO_FETCH_CONNECT_APPFetch an instance of a connect-app

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the ConnectApp resource to fetch.
string
required
The SID of the Account that created the ConnectApp resource to fetch.

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: TWILIO_FETCH_INCOMING_PHONE_NUMBERFetch an incoming-phone-number belonging to the account used to make the request.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the IncomingPhoneNumber resource to fetch.
string
required
The SID of the Account that created the IncomingPhoneNumber resource to fetch.

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: TWILIO_FETCH_INCOMING_PHONE_NUMBER_ASSIGNED_ADD_ONFetch an instance of an Add-on installation currently assigned to this Number.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the resource to fetch.
string
required
The SID of the Account that created the resource to fetch.
string
required
The SID of the Phone Number to which the Add-on is assigned.

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: TWILIO_FETCH_INCOMING_PHONE_NUMBER_ASSIGNED_ADD_ON_EXTENSIONFetch an instance of an Extension for the Assigned Add-on.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the resource to fetch.
string
required
The SID of the Account that created the resource to fetch.
string
required
The SID of the Phone Number to which the Add-on is assigned.
string
required
The SID that uniquely identifies the assigned Add-on installation.

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: TWILIO_FETCH_KEYFetch Key using the Twilio api_v2010 REST API.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Key resource to fetch.
string
required
The SID of the Account that created the Key resource to fetch.

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: TWILIO_FETCH_MEDIAFetch a single Media resource associated with a specific Message resource

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Media resource to fetch.
string
required
The SID of the Account associated with the Media resource.
string
required
The SID of the Message resource that is associated with the Media resource.

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: TWILIO_FETCH_MEMBERFetch a specific member from the queue

Input Parameters

string
required
The Call SID of the resource(s) to fetch.
string
required
The SID of the Queue in which to find the members to fetch.
string
required
The SID of the Account that created the Member resource(s) to fetch.

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: TWILIO_FETCH_MESSAGEFetch a specific Message

Input Parameters

string
required
The SID of the Message resource to be fetched
string
required
The SID of the Account associated with the Message resource

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: TWILIO_FETCH_NOTIFICATIONFetch a notification belonging to the account used to make the request

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Notification resource to fetch.
string
required
The SID of the Account that created the Notification resource to fetch.

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: TWILIO_FETCH_OUTGOING_CALLER_IDFetch an outgoing-caller-id belonging to the account used to make the request

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to fetch.
string
required
The SID of the Account that created the OutgoingCallerId resource to fetch.

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: TWILIO_FETCH_PARTICIPANTFetch an instance of a participant

Input Parameters

string
required
The Call SID or label of the participant to fetch. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20.
string
required
The SID of the Account that created the Participant resource to fetch.
string
required
The SID of the conference with the participant to fetch.

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: TWILIO_FETCH_QUEUEFetch an instance of a queue identified by the QueueSid

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Queue resource to fetch
string
required
The SID of the Account that created the Queue resource to fetch.

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: TWILIO_FETCH_RECORDINGFetch an instance of a recording

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Recording resource to fetch.
string
required
The SID of the Account that created the Recording resource to fetch.
boolean
A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days.

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: TWILIO_FETCH_RECORDING_ADD_ON_RESULTFetch an instance of an AddOnResult

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Recording AddOnResult resource to fetch.
string
required
The SID of the Account that created the Recording AddOnResult resource to fetch.
string
required
The SID of the recording to which the result to fetch belongs.

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: TWILIO_FETCH_RECORDING_ADD_ON_RESULT_PAYLOADFetch an instance of a result payload

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Recording AddOnResult Payload resource to fetch.
string
required
The SID of the Account that created the Recording AddOnResult Payload resource to fetch.
string
required
The SID of the recording to which the AddOnResult resource that contains the payload to fetch belongs.
string
required
The SID of the AddOnResult to which the payload to fetch belongs.

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: TWILIO_FETCH_RECORDING_ADD_ON_RESULT_PAYLOAD_DATAFetch an instance of a result payload

Input Parameters

string
required
The SID of the Account that created the Recording AddOnResult Payload resource to fetch.
string
required
The Twilio-provided string that uniquely identifies the Recording AddOnResult Payload resource to fetch.
string
required
The SID of the recording to which the AddOnResult resource that contains the payload to fetch belongs.
string
required
The SID of the AddOnResult to which the payload to fetch belongs.

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: TWILIO_FETCH_RECORDING_TRANSCRIPTIONFetch Recording Transcription using the Twilio api_v2010 REST API.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Transcription resource to fetch.
string
required
The SID of the Account that created the Transcription resource to fetch.
string
required
The SID of the Recording that created the transcription to fetch.

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: TWILIO_FETCH_SHORT_CODEFetch an instance of a short code

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the ShortCode resource to fetch
string
required
The SID of the Account that created the ShortCode resource(s) to fetch.

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: TWILIO_FETCH_SIGNING_KEYFetch Signing Key using the Twilio api_v2010 REST API.

Input Parameters

string
required
Twilio Sid parameter.
string
required
Twilio AccountSid parameter.

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: TWILIO_FETCH_SIP_AUTH_CALLS_CREDENTIAL_LIST_MAPPINGFetch a specific instance of a credential list mapping

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the CredentialListMapping resource to fetch.
string
required
The SID of the SIP domain that contains the resource to fetch.
string
required
The SID of the Account that created the CredentialListMapping resource to fetch.

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: TWILIO_FETCH_SIP_AUTH_CALLS_IP_ACCESS_CONTROL_LIST_MAPPINGFetch a specific instance of an IP Access Control List mapping

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the IpAccessControlListMapping resource to fetch.
string
required
The SID of the SIP domain that contains the resource to fetch.
string
required
The SID of the Account that created the IpAccessControlListMapping resource to fetch.

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: TWILIO_FETCH_SIP_AUTH_REGISTRATIONS_CREDENTIAL_LIST_MAPPINGFetch a specific instance of a credential list mapping

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the CredentialListMapping resource to fetch.
string
required
The SID of the SIP domain that contains the resource to fetch.
string
required
The SID of the Account that created the CredentialListMapping resource to fetch.

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: TWILIO_FETCH_SIP_CREDENTIALFetch a single credential.

Input Parameters

string
required
The unique id that identifies the resource to fetch.
string
required
The unique id of the Account that is responsible for this resource.
string
required
The unique id that identifies the credential list that contains the desired credential.

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: TWILIO_FETCH_SIP_CREDENTIAL_LISTGet a Credential List

Input Parameters

string
required
The credential list Sid that uniquely identifies this resource
string
required
The unique id of the Account that is responsible for this resource.

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: TWILIO_FETCH_SIP_CREDENTIAL_LIST_MAPPINGFetch a single CredentialListMapping resource from an account.

Input Parameters

string
required
A 34 character string that uniquely identifies the resource to fetch.
string
required
A 34 character string that uniquely identifies the SIP Domain that includes the resource to fetch.
string
required
The unique id of the Account responsible for this resource.

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: TWILIO_FETCH_SIP_DOMAINFetch an instance of a Domain

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the SipDomain resource to fetch.
string
required
The SID of the Account that created the SipDomain resource to fetch.

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: TWILIO_FETCH_SIP_IP_ACCESS_CONTROL_LISTFetch a specific instance of an IpAccessControlList

Input Parameters

string
required
A 34 character string that uniquely identifies the resource to fetch.
string
required
The unique id of the Account responsible for this resource.

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: TWILIO_FETCH_SIP_IP_ACCESS_CONTROL_LIST_MAPPINGFetch an IpAccessControlListMapping resource.

Input Parameters

string
required
A 34 character string that uniquely identifies the resource to fetch.
string
required
A 34 character string that uniquely identifies the SIP domain.
string
required
The unique id of the Account that is responsible for this resource.

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: TWILIO_FETCH_SIP_IP_ADDRESSRead one IpAddress resource.

Input Parameters

string
required
A 34 character string that uniquely identifies the IpAddress resource to fetch.
string
required
The unique id of the Account responsible for this resource.
string
required
The IpAccessControlList Sid that identifies the IpAddress resources to fetch.

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: TWILIO_FETCH_TRANSCRIPTIONFetch an instance of a Transcription

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Transcription resource to fetch.
string
required
The SID of the Account that created the Transcription resource to fetch.

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: TWILIO_FETCH_USAGE_TRIGGERFetch and instance of a usage-trigger

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the UsageTrigger resource to fetch.
string
required
The SID of the Account that created the UsageTrigger resource to fetch.

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: TWILIO_LIST_ACCOUNTRetrieves a collection of Accounts belonging to the account used to make the request

Input Parameters

integer
The page index. This value is simply for client state.
string ("active" | "suspended" | "closed")
Only return Account resources with the given status. Can be closed, suspended or active.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
Only return the Account resources with friendly names that exactly match this 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: TWILIO_LIST_ADDRESSList Address using the Twilio api_v2010 REST API.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that is responsible for the Address resource to read.
string
The ISO country code of the Address resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
string
The customer_name of the Address resources to read.
string
The string that identifies the Address resources to read.
boolean
Whether the address can be associated to a number for emergency calling.

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: TWILIO_LIST_APPLICATIONRetrieve a list of applications representing an application within the requesting account

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the Application resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
string
The string that identifies the Application resources to read.

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: TWILIO_LIST_AUTHORIZED_CONNECT_APPRetrieve a list of authorized-connect-apps belonging to the account used to make the request

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the AuthorizedConnectApp resources to read.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_LIST_AVAILABLE_PHONE_NUMBER_COUNTRYList Available Phone Number Country using the Twilio api_v2010 REST API.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account requesting the available phone number Country resources.

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: TWILIO_LIST_AVAILABLE_PHONE_NUMBER_LOCALList Available Phone Number Local using the Twilio api_v2010 REST API.

Input Parameters

boolean
Whether to read phone numbers that are new to the Twilio platform. Can be: true or false and the default is true.
integer
The page index. This value is simply for client state.
string
Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
string
Matching pattern to identify phone numbers. This pattern can be between 2 and 16 characters long and allows all digits (0-9) and all non-diacritic latin alphabet letters (a-z, A-Z). It accepts four meta-characters: *, %, +, $. The * and % meta-characters can appear multiple times in the pattern. To match wildcards at the beginning or end of the pattern, use * to match any single character or % to match a sequence of characters. If you use the wildcard patterns, it must include at least two non-meta-characters, and wildcards cannot be used between non-meta-characters. To match the beginning of a pattern, start the pattern with +. To match the end of the pattern, append the pattern with $. These meta-characters can’t be adjacent to each other.
integer
The search radius, in miles, for a near_ query. Can be up to 500 and the default is 25. Applies to only phone numbers in the US and Canada.
integer
The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
string
Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account requesting the AvailablePhoneNumber resources.
boolean
Whether the phone numbers can receive faxes. Can be: true or false.
string
Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
boolean
Whether the phone numbers can receive MMS messages. Can be: true or false.
string
Given a phone number, find a geographically close number within distance miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
string
Cursor returned by the previous call; resend required path fields with it.
boolean
Whether the phone numbers can receive text messages. Can be: true or false.
string
required
The ISO-3166-1 country code of the country from which to read phone numbers.
string
Given a latitude/longitude pair lat,long find geographically close numbers within distance miles. Applies to only phone numbers in the US and Canada.
boolean
Whether the phone numbers can receive calls. Can be: true or false.
string
Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
string
Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata to be set as well. Applies to only phone numbers in the US and Canada.
boolean
Whether to exclude phone numbers that require an Address. Can be: true or false and the default is false.
boolean
Whether to exclude phone numbers that require a local Address. Can be: true or false and the default is false.
boolean
Whether to exclude phone numbers that require a foreign Address. Can be: true or false and the default is false.

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: TWILIO_LIST_AVAILABLE_PHONE_NUMBER_MACHINE_TO_MACHINETwilio no longer supports the MachineToMachine available-number type. This deprecated compatibility action is retained only to return a clear error.

Input Parameters

boolean
Whether to read phone numbers that are new to the Twilio platform. Can be: true or false and the default is true.
integer
The page index. This value is simply for client state.
string
Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
string
Matching pattern to identify phone numbers. This pattern can be between 2 and 16 characters long and allows all digits (0-9) and all non-diacritic latin alphabet letters (a-z, A-Z). It accepts four meta-characters: *, %, +, $. The * and % meta-characters can appear multiple times in the pattern. To match wildcards at the beginning or end of the pattern, use * to match any single character or % to match a sequence of characters. If you use the wildcard patterns, it must include at least two non-meta-characters, and wildcards cannot be used between non-meta-characters. To match the beginning of a pattern, start the pattern with +. To match the end of the pattern, append the pattern with $. These meta-characters can’t be adjacent to each other.
integer
The search radius, in miles, for a near_ query. Can be up to 500 and the default is 25. Applies to only phone numbers in the US and Canada.
integer
The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
string
Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account requesting the AvailablePhoneNumber resources.
boolean
Whether the phone numbers can receive faxes. Can be: true or false.
string
Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
boolean
Whether the phone numbers can receive MMS messages. Can be: true or false.
string
Given a phone number, find a geographically close number within distance miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
string
Cursor returned by the previous call; resend required path fields with it.
boolean
Whether the phone numbers can receive text messages. Can be: true or false.
string
required
The ISO-3166-1 country code of the country from which to read phone numbers.
string
Given a latitude/longitude pair lat,long find geographically close numbers within distance miles. Applies to only phone numbers in the US and Canada.
boolean
Whether the phone numbers can receive calls. Can be: true or false.
string
Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
string
Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata to be set as well. Applies to only phone numbers in the US and Canada.
boolean
Whether to exclude phone numbers that require an Address. Can be: true or false and the default is false.
boolean
Whether to exclude phone numbers that require a local Address. Can be: true or false and the default is false.
boolean
Whether to exclude phone numbers that require a foreign Address. Can be: true or false and the default is false.

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: TWILIO_LIST_AVAILABLE_PHONE_NUMBER_MOBILEList Available Phone Number Mobile using the Twilio api_v2010 REST API.

Input Parameters

boolean
Whether to read phone numbers that are new to the Twilio platform. Can be: true or false and the default is true.
integer
The page index. This value is simply for client state.
string
Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
string
Matching pattern to identify phone numbers. This pattern can be between 2 and 16 characters long and allows all digits (0-9) and all non-diacritic latin alphabet letters (a-z, A-Z). It accepts four meta-characters: *, %, +, $. The * and % meta-characters can appear multiple times in the pattern. To match wildcards at the beginning or end of the pattern, use * to match any single character or % to match a sequence of characters. If you use the wildcard patterns, it must include at least two non-meta-characters, and wildcards cannot be used between non-meta-characters. To match the beginning of a pattern, start the pattern with +. To match the end of the pattern, append the pattern with $. These meta-characters can’t be adjacent to each other.
integer
The search radius, in miles, for a near_ query. Can be up to 500 and the default is 25. Applies to only phone numbers in the US and Canada.
integer
The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
string
Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account requesting the AvailablePhoneNumber resources.
boolean
Whether the phone numbers can receive faxes. Can be: true or false.
string
Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
boolean
Whether the phone numbers can receive MMS messages. Can be: true or false.
string
Given a phone number, find a geographically close number within distance miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
string
Cursor returned by the previous call; resend required path fields with it.
boolean
Whether the phone numbers can receive text messages. Can be: true or false.
string
required
The ISO-3166-1 country code of the country from which to read phone numbers.
string
Given a latitude/longitude pair lat,long find geographically close numbers within distance miles. Applies to only phone numbers in the US and Canada.
boolean
Whether the phone numbers can receive calls. Can be: true or false.
string
Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
string
Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata to be set as well. Applies to only phone numbers in the US and Canada.
boolean
Whether to exclude phone numbers that require an Address. Can be: true or false and the default is false.
boolean
Whether to exclude phone numbers that require a local Address. Can be: true or false and the default is false.
boolean
Whether to exclude phone numbers that require a foreign Address. Can be: true or false and the default is false.

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: TWILIO_LIST_AVAILABLE_PHONE_NUMBER_NATIONALList Available Phone Number National using the Twilio api_v2010 REST API.

Input Parameters

boolean
Whether to read phone numbers that are new to the Twilio platform. Can be: true or false and the default is true.
integer
The page index. This value is simply for client state.
string
Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
string
Matching pattern to identify phone numbers. This pattern can be between 2 and 16 characters long and allows all digits (0-9) and all non-diacritic latin alphabet letters (a-z, A-Z). It accepts four meta-characters: *, %, +, $. The * and % meta-characters can appear multiple times in the pattern. To match wildcards at the beginning or end of the pattern, use * to match any single character or % to match a sequence of characters. If you use the wildcard patterns, it must include at least two non-meta-characters, and wildcards cannot be used between non-meta-characters. To match the beginning of a pattern, start the pattern with +. To match the end of the pattern, append the pattern with $. These meta-characters can’t be adjacent to each other.
integer
The search radius, in miles, for a near_ query. Can be up to 500 and the default is 25. Applies to only phone numbers in the US and Canada.
integer
The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
string
Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account requesting the AvailablePhoneNumber resources.
boolean
Whether the phone numbers can receive faxes. Can be: true or false.
string
Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
boolean
Whether the phone numbers can receive MMS messages. Can be: true or false.
string
Given a phone number, find a geographically close number within distance miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
string
Cursor returned by the previous call; resend required path fields with it.
boolean
Whether the phone numbers can receive text messages. Can be: true or false.
string
required
The ISO-3166-1 country code of the country from which to read phone numbers.
string
Given a latitude/longitude pair lat,long find geographically close numbers within distance miles. Applies to only phone numbers in the US and Canada.
boolean
Whether the phone numbers can receive calls. Can be: true or false.
string
Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
string
Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata to be set as well. Applies to only phone numbers in the US and Canada.
boolean
Whether to exclude phone numbers that require an Address. Can be: true or false and the default is false.
boolean
Whether to exclude phone numbers that require a local Address. Can be: true or false and the default is false.
boolean
Whether to exclude phone numbers that require a foreign Address. Can be: true or false and the default is false.

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: TWILIO_LIST_AVAILABLE_PHONE_NUMBER_SHARED_COSTList Available Phone Number Shared Cost using the Twilio api_v2010 REST API.

Input Parameters

boolean
Whether to read phone numbers that are new to the Twilio platform. Can be: true or false and the default is true.
integer
The page index. This value is simply for client state.
string
Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
string
Matching pattern to identify phone numbers. This pattern can be between 2 and 16 characters long and allows all digits (0-9) and all non-diacritic latin alphabet letters (a-z, A-Z). It accepts four meta-characters: *, %, +, $. The * and % meta-characters can appear multiple times in the pattern. To match wildcards at the beginning or end of the pattern, use * to match any single character or % to match a sequence of characters. If you use the wildcard patterns, it must include at least two non-meta-characters, and wildcards cannot be used between non-meta-characters. To match the beginning of a pattern, start the pattern with +. To match the end of the pattern, append the pattern with $. These meta-characters can’t be adjacent to each other.
integer
The search radius, in miles, for a near_ query. Can be up to 500 and the default is 25. Applies to only phone numbers in the US and Canada.
integer
The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
string
Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account requesting the AvailablePhoneNumber resources.
boolean
Whether the phone numbers can receive faxes. Can be: true or false.
string
Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
boolean
Whether the phone numbers can receive MMS messages. Can be: true or false.
string
Given a phone number, find a geographically close number within distance miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
string
Cursor returned by the previous call; resend required path fields with it.
boolean
Whether the phone numbers can receive text messages. Can be: true or false.
string
required
The ISO-3166-1 country code of the country from which to read phone numbers.
string
Given a latitude/longitude pair lat,long find geographically close numbers within distance miles. Applies to only phone numbers in the US and Canada.
boolean
Whether the phone numbers can receive calls. Can be: true or false.
string
Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
string
Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata to be set as well. Applies to only phone numbers in the US and Canada.
boolean
Whether to exclude phone numbers that require an Address. Can be: true or false and the default is false.
boolean
Whether to exclude phone numbers that require a local Address. Can be: true or false and the default is false.
boolean
Whether to exclude phone numbers that require a foreign Address. Can be: true or false and the default is false.

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: TWILIO_LIST_AVAILABLE_PHONE_NUMBER_TOLL_FREEList Available Phone Number Toll Free using the Twilio api_v2010 REST API.

Input Parameters

boolean
Whether to read phone numbers that are new to the Twilio platform. Can be: true or false and the default is true.
integer
The page index. This value is simply for client state.
string
Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
string
Matching pattern to identify phone numbers. This pattern can be between 2 and 16 characters long and allows all digits (0-9) and all non-diacritic latin alphabet letters (a-z, A-Z). It accepts four meta-characters: *, %, +, $. The * and % meta-characters can appear multiple times in the pattern. To match wildcards at the beginning or end of the pattern, use * to match any single character or % to match a sequence of characters. If you use the wildcard patterns, it must include at least two non-meta-characters, and wildcards cannot be used between non-meta-characters. To match the beginning of a pattern, start the pattern with +. To match the end of the pattern, append the pattern with $. These meta-characters can’t be adjacent to each other.
integer
The search radius, in miles, for a near_ query. Can be up to 500 and the default is 25. Applies to only phone numbers in the US and Canada.
integer
The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
string
Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account requesting the AvailablePhoneNumber resources.
boolean
Whether the phone numbers can receive faxes. Can be: true or false.
string
Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
boolean
Whether the phone numbers can receive MMS messages. Can be: true or false.
string
Given a phone number, find a geographically close number within distance miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
string
Cursor returned by the previous call; resend required path fields with it.
boolean
Whether the phone numbers can receive text messages. Can be: true or false.
string
required
The ISO-3166-1 country code of the country from which to read phone numbers.
string
Given a latitude/longitude pair lat,long find geographically close numbers within distance miles. Applies to only phone numbers in the US and Canada.
boolean
Whether the phone numbers can receive calls. Can be: true or false.
string
Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
string
Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata to be set as well. Applies to only phone numbers in the US and Canada.
boolean
Whether to exclude phone numbers that require an Address. Can be: true or false and the default is false.
boolean
Whether to exclude phone numbers that require a local Address. Can be: true or false and the default is false.
boolean
Whether to exclude phone numbers that require a foreign Address. Can be: true or false and the default is false.

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: TWILIO_LIST_AVAILABLE_PHONE_NUMBER_VOIPList Available Phone Number Voip using the Twilio api_v2010 REST API.

Input Parameters

boolean
Whether to read phone numbers that are new to the Twilio platform. Can be: true or false and the default is true.
integer
The page index. This value is simply for client state.
string
Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
string
Matching pattern to identify phone numbers. This pattern can be between 2 and 16 characters long and allows all digits (0-9) and all non-diacritic latin alphabet letters (a-z, A-Z). It accepts four meta-characters: *, %, +, $. The * and % meta-characters can appear multiple times in the pattern. To match wildcards at the beginning or end of the pattern, use * to match any single character or % to match a sequence of characters. If you use the wildcard patterns, it must include at least two non-meta-characters, and wildcards cannot be used between non-meta-characters. To match the beginning of a pattern, start the pattern with +. To match the end of the pattern, append the pattern with $. These meta-characters can’t be adjacent to each other.
integer
The search radius, in miles, for a near_ query. Can be up to 500 and the default is 25. Applies to only phone numbers in the US and Canada.
integer
The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
string
Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account requesting the AvailablePhoneNumber resources.
boolean
Whether the phone numbers can receive faxes. Can be: true or false.
string
Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
boolean
Whether the phone numbers can receive MMS messages. Can be: true or false.
string
Given a phone number, find a geographically close number within distance miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
string
Cursor returned by the previous call; resend required path fields with it.
boolean
Whether the phone numbers can receive text messages. Can be: true or false.
string
required
The ISO-3166-1 country code of the country from which to read phone numbers.
string
Given a latitude/longitude pair lat,long find geographically close numbers within distance miles. Applies to only phone numbers in the US and Canada.
boolean
Whether the phone numbers can receive calls. Can be: true or false.
string
Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
string
Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata to be set as well. Applies to only phone numbers in the US and Canada.
boolean
Whether to exclude phone numbers that require an Address. Can be: true or false and the default is false.
boolean
Whether to exclude phone numbers that require a local Address. Can be: true or false and the default is false.
boolean
Whether to exclude phone numbers that require a foreign Address. Can be: true or false and the default is false.

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: TWILIO_LIST_CALLRetrieves a collection of calls made to and from your account

Input Parameters

string
Only show calls made to this phone number, SIP address, Client identifier or SIM SID.
integer
The page index. This value is simply for client state.
string
Only include calls from this phone number, SIP address, Client identifier or SIM SID.
string ("queued" | "ringing" | "in-progress" | "completed" | "busy" | "failed" | "no-answer" | "canceled")
The status of the calls to include. Can be: queued, ringing, in-progress, canceled, completed, failed, busy, or no-answer.
string
Only include calls that ended on this date. Specify a date as YYYY-MM-DD in UTC, for example: 2009-07-06, to read only calls that ended on this date.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Only include calls that started on this date. Specify a date as YYYY-MM-DD in UTC, for example: 2009-07-06, to read only calls that started on this date.
string
required
The SID of the Account that created the Call resource(s) to read.
string
Only include calls that ended on or after this date. Specify a date as YYYY-MM-DD in UTC, for example: 2009-07-06, to read only calls that ended on or after this date.
string
Only include calls that ended before this date. Specify a date as YYYY-MM-DD in UTC, for example: 2009-07-06, to read only calls that ended before this date.
string
Cursor returned by the previous call; resend required path fields with it.
string
Only include calls that started on or after this date. Specify a date as YYYY-MM-DD in UTC, for example: 2009-07-06, to read only calls that started on or after this date.
string
Only include calls that started before this date. Specify a date as YYYY-MM-DD in UTC, for example: 2009-07-06, to read only calls that started before this date.
string
Only include calls spawned by calls with this SID.

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: TWILIO_LIST_CALL_EVENTRetrieve a list of all events for a call.

Input Parameters

integer
The page index. This value is simply for client state.
string
required
The unique SID identifier of the Call.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The unique SID identifier of the Account.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_LIST_CALL_NOTIFICATIONList Call Notification using the Twilio api_v2010 REST API.

Input Parameters

integer
Only read notifications of the specified log level. Can be: 0 to read only ERROR notifications or 1 to read only WARNING notifications. By default, all notifications are read.
integer
The page index. This value is simply for client state.
string
required
The Call SID of the Call Notification resources to read.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the Call Notification resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
string
Only show notifications for the specified date, formatted as YYYY-MM-DD. You can also specify an inequality, such as <=YYYY-MM-DD for messages logged at or before midnight on a date, or >=YYYY-MM-DD for messages logged at or after midnight on a date.
string
Only show notifications for the specified date, formatted as YYYY-MM-DD. You can also specify an inequality, such as <=YYYY-MM-DD for messages logged at or before midnight on a date, or >=YYYY-MM-DD for messages logged at or after midnight on a date.
string
Only show notifications for the specified date, formatted as YYYY-MM-DD. You can also specify an inequality, such as <=YYYY-MM-DD for messages logged at or before midnight on a date, or >=YYYY-MM-DD for messages logged at or after midnight on a date.

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: TWILIO_LIST_CALL_RECORDINGRetrieve a list of recordings belonging to the call used to make the request

Input Parameters

integer
The page index. This value is simply for client state.
string
required
The Call SID of the resources to read.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the Recording resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
string
The date_created value, specified as YYYY-MM-DD, of the resources to read. You can also specify inequality: DateCreated<=YYYY-MM-DD will return recordings generated at or before midnight on a given date, and DateCreated>=YYYY-MM-DD returns recordings generated at or after midnight on a date.
string
The date_created value, specified as YYYY-MM-DD, of the resources to read. You can also specify inequality: DateCreated<=YYYY-MM-DD will return recordings generated at or before midnight on a given date, and DateCreated>=YYYY-MM-DD returns recordings generated at or after midnight on a date.
string
The date_created value, specified as YYYY-MM-DD, of the resources to read. You can also specify inequality: DateCreated<=YYYY-MM-DD will return recordings generated at or before midnight on a given date, and DateCreated>=YYYY-MM-DD returns recordings generated at or after midnight on a date.

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: TWILIO_LIST_CONFERENCERetrieve a list of conferences belonging to the account used to make the request

Input Parameters

integer
The page index. This value is simply for client state.
string ("init" | "in-progress" | "completed")
The status of the resources to read. Can be: init, in-progress, or completed. Starting from September 30th, 2026, the default is in-progress. To read completed conferences, set Status to completed.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the Conference resource(s) to read.
string
Cursor returned by the previous call; resend required path fields with it.
string
Only include conferences that were created on this date. Specify a date as YYYY-MM-DD in UTC, for example: 2009-07-06, to read only conferences that were created on this date. You can also specify an inequality, such as DateCreated<=YYYY-MM-DD, to read conferences that were created on or before midnight of this date, and DateCreated>=YYYY-MM-DD to read conferences that were created on or after midnight of this date.
string
Only include conferences that were last updated on this date. Specify a date as YYYY-MM-DD in UTC, for example: 2009-07-06, to read only conferences that were last updated on this date. You can also specify an inequality, such as DateUpdated<=YYYY-MM-DD, to read conferences that were last updated on or before midnight of this date, and DateUpdated>=YYYY-MM-DD to read conferences that were last updated on or after midnight of this date.
string
The string that identifies the Conference resources to read.
string
Only include conferences that were created on this date. Specify a date as YYYY-MM-DD in UTC, for example: 2009-07-06, to read only conferences that were created on this date. You can also specify an inequality, such as DateCreated<=YYYY-MM-DD, to read conferences that were created on or before midnight of this date, and DateCreated>=YYYY-MM-DD to read conferences that were created on or after midnight of this date.
string
Only include conferences that were created on this date. Specify a date as YYYY-MM-DD in UTC, for example: 2009-07-06, to read only conferences that were created on this date. You can also specify an inequality, such as DateCreated<=YYYY-MM-DD, to read conferences that were created on or before midnight of this date, and DateCreated>=YYYY-MM-DD to read conferences that were created on or after midnight of this date.
string
Only include conferences that were last updated on this date. Specify a date as YYYY-MM-DD in UTC, for example: 2009-07-06, to read only conferences that were last updated on this date. You can also specify an inequality, such as DateUpdated<=YYYY-MM-DD, to read conferences that were last updated on or before midnight of this date, and DateUpdated>=YYYY-MM-DD to read conferences that were last updated on or after midnight of this date.
string
Only include conferences that were last updated on this date. Specify a date as YYYY-MM-DD in UTC, for example: 2009-07-06, to read only conferences that were last updated on this date. You can also specify an inequality, such as DateUpdated<=YYYY-MM-DD, to read conferences that were last updated on or before midnight of this date, and DateUpdated>=YYYY-MM-DD to read conferences that were last updated on or after midnight of this date.

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: TWILIO_LIST_CONFERENCE_RECORDINGRetrieve a list of recordings belonging to the call used to make the request

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the Conference Recording resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
string
The date_created value, specified as YYYY-MM-DD, of the resources to read. You can also specify inequality: DateCreated<=YYYY-MM-DD will return recordings generated at or before midnight on a given date, and DateCreated>=YYYY-MM-DD returns recordings generated at or after midnight on a date.
string
required
The Conference SID that identifies the conference associated with the recording to read.
string
The date_created value, specified as YYYY-MM-DD, of the resources to read. You can also specify inequality: DateCreated<=YYYY-MM-DD will return recordings generated at or before midnight on a given date, and DateCreated>=YYYY-MM-DD returns recordings generated at or after midnight on a date.
string
The date_created value, specified as YYYY-MM-DD, of the resources to read. You can also specify inequality: DateCreated<=YYYY-MM-DD will return recordings generated at or before midnight on a given date, and DateCreated>=YYYY-MM-DD returns recordings generated at or after midnight on a date.

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: TWILIO_LIST_CONNECT_APPRetrieve a list of connect-apps belonging to the account used to make the request

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the ConnectApp resources to read.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_LIST_DEPENDENT_PHONE_NUMBERList Dependent Phone Number using the Twilio api_v2010 REST API.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the DependentPhoneNumber resources to read.
string
required
The SID of the Address resource associated with the phone number.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_LIST_INCOMING_PHONE_NUMBERRetrieve a list of incoming-phone-numbers belonging to the account used to make the request.

Input Parameters

boolean
Whether to include phone numbers new to the Twilio platform. Can be: true or false and the default is true.
integer
The page index. This value is simply for client state.
string
Whether to include phone numbers based on their origin. Can be: twilio or hosted. By default, phone numbers of all origin are included.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the IncomingPhoneNumber resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
string
The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use ’*’ as a wildcard for any digit.
string
A string that identifies the IncomingPhoneNumber resources to read.

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: TWILIO_LIST_INCOMING_PHONE_NUMBER_ASSIGNED_ADD_ONRetrieve a list of Add-on installations currently assigned to this Number.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the Phone Number to which the Add-on is assigned.

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: TWILIO_LIST_INCOMING_PHONE_NUMBER_ASSIGNED_ADD_ON_EXTENSIONRetrieve a list of Extensions for the Assigned Add-on.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the Phone Number to which the Add-on is assigned.
string
required
The SID that uniquely identifies the assigned Add-on installation.

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: TWILIO_LIST_INCOMING_PHONE_NUMBER_LOCALList Incoming Phone Number Local using the Twilio api_v2010 REST API.

Input Parameters

boolean
Whether to include phone numbers new to the Twilio platform. Can be: true or false and the default is true.
integer
The page index. This value is simply for client state.
string
Whether to include phone numbers based on their origin. Can be: twilio or hosted. By default, phone numbers of all origin are included.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
string
The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use ’*’ as a wildcard for any digit.
string
A string that identifies the resources to read.

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: TWILIO_LIST_INCOMING_PHONE_NUMBER_MOBILEList Incoming Phone Number Mobile using the Twilio api_v2010 REST API.

Input Parameters

boolean
Whether to include phone numbers new to the Twilio platform. Can be: true or false and the default is true.
integer
The page index. This value is simply for client state.
string
Whether to include phone numbers based on their origin. Can be: twilio or hosted. By default, phone numbers of all origin are included.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
string
The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use ’*’ as a wildcard for any digit.
string
A string that identifies the resources to read.

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: TWILIO_LIST_INCOMING_PHONE_NUMBER_TOLL_FREEList Incoming Phone Number Toll Free using the Twilio api_v2010 REST API.

Input Parameters

boolean
Whether to include phone numbers new to the Twilio platform. Can be: true or false and the default is true.
integer
The page index. This value is simply for client state.
string
Whether to include phone numbers based on their origin. Can be: twilio or hosted. By default, phone numbers of all origin are included.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
string
The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use ’*’ as a wildcard for any digit.
string
A string that identifies the resources to read.

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: TWILIO_LIST_KEYList Key using the Twilio api_v2010 REST API.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the Key resources to read.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_LIST_MEDIARead a list of Media resources associated with a specific Message resource

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that is associated with the Media resources.
string
required
The SID of the Message resource that is associated with the Media resources.
string
Cursor returned by the previous call; resend required path fields with it.
string
Only include Media resources that were created on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read Media that were created on this date. You can also specify an inequality, such as StartTime<=YYYY-MM-DD, to read Media that were created on or before midnight of this date, and StartTime>=YYYY-MM-DD to read Media that were created on or after midnight of this date.
string
Only include Media resources that were created on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read Media that were created on this date. You can also specify an inequality, such as StartTime<=YYYY-MM-DD, to read Media that were created on or before midnight of this date, and StartTime>=YYYY-MM-DD to read Media that were created on or after midnight of this date.
string
Only include Media resources that were created on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read Media that were created on this date. You can also specify an inequality, such as StartTime<=YYYY-MM-DD, to read Media that were created on or before midnight of this date, and StartTime>=YYYY-MM-DD to read Media that were created on or after midnight of this date.

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: TWILIO_LIST_MEMBERRetrieve the members of the queue

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
required
The SID of the Queue in which to find the members
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the Member resource(s) to read.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_LIST_MESSAGERetrieve a list of Message resources associated with a Twilio Account

Input Parameters

string
Filter by recipient. For example: Set this parameter to +15558881111 to retrieve a list of Message resources sent to +15558881111.
integer
The page index. This value is simply for client state.
string
Filter by sender. For example: Set this parameter to +15552229999 to retrieve a list of Message resources sent by +15552229999.
string
Filter by Message sent_date. Accepts GMT dates in the following formats: YYYY-MM-DD (to find Messages with a specific sent_date), <=YYYY-MM-DD (to find Messages with sent_dates on and before a specific date), and >=YYYY-MM-DD (to find Messages with sent_dates on and after a specific date).
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account associated with the Message resources.
string
Cursor returned by the previous call; resend required path fields with it.
string
Filter by Message sent_date. Accepts GMT dates in the following formats: YYYY-MM-DD (to find Messages with a specific sent_date), <=YYYY-MM-DD (to find Messages with sent_dates on and before a specific date), and >=YYYY-MM-DD (to find Messages with sent_dates on and after a specific date).
string
Filter by Message sent_date. Accepts GMT dates in the following formats: YYYY-MM-DD (to find Messages with a specific sent_date), <=YYYY-MM-DD (to find Messages with sent_dates on and before a specific date), and >=YYYY-MM-DD (to find Messages with sent_dates on and after a specific date).

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: TWILIO_LIST_NOTIFICATIONTwilio retired the Notifications list endpoint. This deprecated compatibility action is retained only to return a clear error.

Input Parameters

integer
Only read notifications of the specified log level. Can be: 0 to read only ERROR notifications or 1 to read only WARNING notifications. By default, all notifications are read.
integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the Notification resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
string
Only show notifications for the specified date, formatted as YYYY-MM-DD. You can also specify an inequality, such as <=YYYY-MM-DD for messages logged at or before midnight on a date, or >=YYYY-MM-DD for messages logged at or after midnight on a date.
string
Only show notifications for the specified date, formatted as YYYY-MM-DD. You can also specify an inequality, such as <=YYYY-MM-DD for messages logged at or before midnight on a date, or >=YYYY-MM-DD for messages logged at or after midnight on a date.
string
Only show notifications for the specified date, formatted as YYYY-MM-DD. You can also specify an inequality, such as <=YYYY-MM-DD for messages logged at or before midnight on a date, or >=YYYY-MM-DD for messages logged at or after midnight on a date.

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: TWILIO_LIST_OUTGOING_CALLER_IDRetrieve a list of outgoing-caller-ids belonging to the account used to make the request

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the OutgoingCallerId resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
string
The phone number of the OutgoingCallerId resources to read.
string
The string that identifies the OutgoingCallerId resources to read.

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: TWILIO_LIST_PARTICIPANTRetrieve a list of participants belonging to the account used to make the request

Input Parameters

boolean
Whether to return only participants that are on hold. Can be: true or false.
integer
The page index. This value is simply for client state.
boolean
Whether to return only participants that are muted. Can be: true or false.
boolean
Whether to return only participants who are coaching another call. Can be: true or false.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the Participant resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the conference with the participants to read.

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: TWILIO_LIST_QUEUERetrieve a list of queues belonging to the account used to make the request

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the Queue resources to read.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_LIST_RECORDINGRetrieve a list of recordings belonging to the account used to make the request

Input Parameters

integer
The page index. This value is simply for client state.
string
The Call SID of the resources to read.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the Recording resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
string
Only include recordings that were created on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read recordings that were created on this date. You can also specify an inequality, such as DateCreated<=YYYY-MM-DD, to read recordings that were created on or before midnight of this date, and DateCreated>=YYYY-MM-DD to read recordings that were created on or after midnight of this date.
string
The Conference SID that identifies the conference associated with the recording to read.
string
Only include recordings that were created on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read recordings that were created on this date. You can also specify an inequality, such as DateCreated<=YYYY-MM-DD, to read recordings that were created on or before midnight of this date, and DateCreated>=YYYY-MM-DD to read recordings that were created on or after midnight of this date.
string
Only include recordings that were created on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read recordings that were created on this date. You can also specify an inequality, such as DateCreated<=YYYY-MM-DD, to read recordings that were created on or before midnight of this date, and DateCreated>=YYYY-MM-DD to read recordings that were created on or after midnight of this date.
boolean
A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days.

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: TWILIO_LIST_RECORDING_ADD_ON_RESULTRetrieve a list of results belonging to the recording

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the Recording AddOnResult resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the recording to which the result to read belongs.

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: TWILIO_LIST_RECORDING_ADD_ON_RESULT_PAYLOADRetrieve a list of payloads belonging to the AddOnResult

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the Recording AddOnResult Payload resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the recording to which the AddOnResult resource that contains the payloads to read belongs.
string
required
The SID of the AddOnResult to which the payloads to read belongs.

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: TWILIO_LIST_RECORDING_TRANSCRIPTIONList Recording Transcription using the Twilio api_v2010 REST API.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the Transcription resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the Recording that created the transcriptions to read.

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: TWILIO_LIST_SHORT_CODERetrieve a list of short-codes belonging to the account used to make the request

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Only show the ShortCode resources that match this pattern. You can specify partial numbers and use ’*’ as a wildcard for any digit.
string
required
The SID of the Account that created the ShortCode resource(s) to read.
string
Cursor returned by the previous call; resend required path fields with it.
string
The string that identifies the ShortCode resources to read.

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: TWILIO_LIST_SIGNING_KEYList Signing Key using the Twilio api_v2010 REST API.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
Twilio AccountSid parameter.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_LIST_SIP_AUTH_CALLS_CREDENTIAL_LIST_MAPPINGRetrieve a list of credential list mappings belonging to the domain used in the request

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
required
The SID of the SIP domain that contains the resources to read.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the CredentialListMapping resources to read.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_LIST_SIP_AUTH_CALLS_IP_ACCESS_CONTROL_LIST_MAPPINGRetrieve a list of IP Access Control List mappings belonging to the domain used in the request

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
required
The SID of the SIP domain that contains the resources to read.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the IpAccessControlListMapping resources to read.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_LIST_SIP_AUTH_REGISTRATIONS_CREDENTIAL_LIST_MAPPINGRetrieve a list of credential list mappings belonging to the domain used in the request

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
required
The SID of the SIP domain that contains the resources to read.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the CredentialListMapping resources to read.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_LIST_SIP_CREDENTIALRetrieve a list of credentials.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The unique id of the Account that is responsible for this resource.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The unique id that identifies the credential list that contains the desired credentials.

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: TWILIO_LIST_SIP_CREDENTIAL_LISTGet All Credential Lists

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The unique id of the Account that is responsible for this resource.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_LIST_SIP_CREDENTIAL_LIST_MAPPINGRead multiple CredentialListMapping resources from an account.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
required
A 34 character string that uniquely identifies the SIP Domain that includes the resource to read.
string
The page token. This is provided by the API.
string
required
The unique id of the Account responsible for this resource.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_LIST_SIP_DOMAINRetrieve a list of domains belonging to the account used to make the request

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the SipDomain resources to read.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_LIST_SIP_IP_ACCESS_CONTROL_LISTRetrieve a list of IpAccessControlLists that belong to the account used to make the request

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The unique id of the Account responsible for this resource.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_LIST_SIP_IP_ACCESS_CONTROL_LIST_MAPPINGRetrieve a list of IpAccessControlListMapping resources.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
required
A 34 character string that uniquely identifies the SIP domain.
string
The page token. This is provided by the API.
string
required
The unique id of the Account that is responsible for this resource.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_LIST_SIP_IP_ADDRESSRead multiple IpAddress resources.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The unique id of the Account responsible for this resource.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The IpAccessControlList Sid that identifies the IpAddress resources to read.

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: TWILIO_LIST_TRANSCRIPTIONRetrieve a list of transcriptions belonging to the account used to make the request

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
required
The SID of the Account that created the Transcription resources to read.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_LIST_USAGE_RECORDRetrieve a list of usage-records belonging to the account used to make the request

Input Parameters

integer
The page index. This value is simply for client state.
string
The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.
string
Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date.
string
required
The SID of the Account that created the UsageRecord resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
boolean
Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified 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: TWILIO_LIST_USAGE_RECORD_ALL_TIMEList Usage Record All Time using the Twilio api_v2010 REST API.

Input Parameters

integer
The page index. This value is simply for client state.
string
The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.
string
Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date.
string
required
The SID of the Account that created the UsageRecord resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
boolean
Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified 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: TWILIO_LIST_USAGE_RECORD_DAILYList Usage Record Daily using the Twilio api_v2010 REST API.

Input Parameters

integer
The page index. This value is simply for client state.
string
The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.
string
Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date.
string
required
The SID of the Account that created the UsageRecord resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
boolean
Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified 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: TWILIO_LIST_USAGE_RECORD_LAST_MONTHList Usage Record Last Month using the Twilio api_v2010 REST API.

Input Parameters

integer
The page index. This value is simply for client state.
string
The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.
string
Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date.
string
required
The SID of the Account that created the UsageRecord resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
boolean
Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified 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: TWILIO_LIST_USAGE_RECORD_MONTHLYList Usage Record Monthly using the Twilio api_v2010 REST API.

Input Parameters

integer
The page index. This value is simply for client state.
string
The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.
string
Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date.
string
required
The SID of the Account that created the UsageRecord resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
boolean
Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified 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: TWILIO_LIST_USAGE_RECORD_THIS_MONTHList Usage Record This Month using the Twilio api_v2010 REST API.

Input Parameters

integer
The page index. This value is simply for client state.
string
The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.
string
Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date.
string
required
The SID of the Account that created the UsageRecord resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
boolean
Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified 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: TWILIO_LIST_USAGE_RECORD_TODAYList Usage Record Today using the Twilio api_v2010 REST API.

Input Parameters

integer
The page index. This value is simply for client state.
string
The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.
string
Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date.
string
required
The SID of the Account that created the UsageRecord resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
boolean
Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified 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: TWILIO_LIST_USAGE_RECORD_YEARLYList Usage Record Yearly using the Twilio api_v2010 REST API.

Input Parameters

integer
The page index. This value is simply for client state.
string
The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.
string
Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date.
string
required
The SID of the Account that created the UsageRecord resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
boolean
Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified 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: TWILIO_LIST_USAGE_RECORD_YESTERDAYList Usage Record Yesterday using the Twilio api_v2010 REST API.

Input Parameters

integer
The page index. This value is simply for client state.
string
The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.
string
Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date.
string
required
The SID of the Account that created the UsageRecord resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
boolean
Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified 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: TWILIO_LIST_USAGE_TRIGGERRetrieve a list of usage-triggers belonging to the account used to make the request

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string ("daily" | "monthly" | "yearly" | "alltime")
The frequency of recurring UsageTriggers to read. Can be: daily, monthly, or yearly to read recurring UsageTriggers. An empty value or a value of alltime reads non-recurring UsageTriggers.
string
The page token. This is provided by the API.
string ("count" | "usage" | "price")
The trigger field of the UsageTriggers to read. Can be: count, usage, or price as described in the UsageRecords documentation.
string
required
The SID of the Account that created the UsageTrigger resources to read.
string
Cursor returned by the previous call; resend required path fields with it.
string
The usage category of the UsageTriggers to read. Must be a supported usage categories.

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: TWILIO_MESSAGING_CREATE_ALPHA_SENDERCreate Alpha Sender using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the Service to create the resource under.
string
required
The Alphanumeric Sender ID string. Can be up to 11 characters long. Valid characters are A-Z, a-z, 0-9, space, hyphen -, plus +, underscore _ and ampersand &. This value cannot contain only numbers.

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: TWILIO_MESSAGING_CREATE_BRAND_REGISTRATION_OTPCreate Brand Registration Otp using the Twilio messaging_v1 REST API.

Input Parameters

string
required
Brand Registration Sid of Sole Proprietor Brand.

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: TWILIO_MESSAGING_CREATE_BRAND_REGISTRATIONSCreate Brand Registrations using the Twilio messaging_v1 REST API.

Input Parameters

boolean
A boolean that specifies whether brand should be a mock or not. If true, brand will be registered as a mock brand. Defaults to false if no value is provided.
string
Type of brand being created. One of: “STANDARD”, “SOLE_PROPRIETOR”. SOLE_PROPRIETOR is for low volume, SOLE_PROPRIETOR use cases. STANDARD is for all other use cases.
string
required
A2P Messaging Profile Bundle Sid.
boolean
A flag to disable automatic secondary vetting for brands which it would otherwise be done.
string
required
Customer Profile Bundle Sid.

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: TWILIO_MESSAGING_CREATE_BRAND_VETTINGCreate Brand Vetting using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the Brand Registration resource of the vettings to create .
string
The unique ID of the vetting
string ("campaign-verify" | "aegis")
required
The third-party provider that has conducted the vetting. One of “CampaignVerify” (Campaign Verify tokens) or “AEGIS” (Secondary Vetting).

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: TWILIO_MESSAGING_CREATE_CHANNEL_SENDERCreate Channel Sender using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the Channel Sender being added to the Service.
string
required
The SID of the Service to create the resource under.

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: TWILIO_MESSAGING_CREATE_DESTINATION_ALPHA_SENDERCreate Destination Alpha Sender using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the Service to create the resource under.
string
required
The Alphanumeric Sender ID string. Can be up to 11 characters long. Valid characters are A-Z, a-z, 0-9, space, hyphen -, plus +, underscore _ and ampersand &. This value cannot contain only numbers.
string
The Optional Two Character ISO Country Code the Alphanumeric Sender ID will be used for. If the IsoCountryCode is not provided, a default Alpha Sender will be created that can be used across all countries.

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: TWILIO_MESSAGING_CREATE_EXTERNAL_CAMPAIGNCreate External Campaign using the Twilio messaging_v1 REST API.

Input Parameters

string
required
ID of the preregistered campaign.
boolean
Customers should use this flag during the ERC registration process to indicate to Twilio that the campaign being registered is undergoing CNP migration. It is important for the user to first trigger the CNP migration process for said campaign in their CSP portal and have Twilio accept the sharing request, before making this api call.
string
required
The SID of the Messaging Service that the resource is associated with.

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: TWILIO_MESSAGING_CREATE_LINKSHORTENING_MESSAGING_SERVICECreate Linkshortening Messaging Service using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The domain SID to associate with a messaging service. With URL shortening enabled, links in messages sent with the associated messaging service will be shortened to the provided domain
string
required
A messaging service SID to associate with a domain. With URL shortening enabled, links in messages sent with the provided messaging service will be shortened to the associated domain

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: TWILIO_MESSAGING_CREATE_PHONE_NUMBERCreate Phone Number using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the Service to create the resource under.
string
required
The SID of the Phone Number being added to the Service.

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: TWILIO_MESSAGING_CREATE_SERVICECreate Service using the Twilio messaging_v1 REST API.

Input Parameters

string
A string that describes the scenario in which the Messaging Service will be used. Possible values are notifications, marketing, verification, discussion, poll, undeclared.
string
The URL that we call using fallback_method if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the use_inbound_webhook_on_number field is enabled then the webhook url defined on the phone number will override the fallback_url defined for the Messaging Service.
string
required
A descriptive string that you create to describe the resource. It can be up to 64 characters long.
boolean
Whether to enable the MMS Converter for messages sent through the Service instance.
boolean
Whether to enable Sticky Sender on the Service instance.
string ("GET" | "POST")
The HTTP method we should use to call inbound_request_url. Can be GET or POST and the default is POST.
boolean
Whether to enable Smart Encoding for messages sent through the Service instance.
string ("GET" | "POST")
The HTTP method we should use to call fallback_url. Can be: GET or POST.
string
The URL we should call to pass status updates about message delivery.
integer
How long, in seconds, messages sent from the Service are valid. Can be an integer from 1 to 36,000. Default value is 36,000.
boolean
Whether to enable Area Code Geomatch on the Service Instance.
string
The URL we call using inbound_method when a message is received by any phone number or short code in the Service. When this property is null, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the use_inbound_webhook_on_number field is enabled then the webhook url defined on the phone number will override the inbound_request_url defined for the Messaging Service.
string ("inherit" | "enable" | "disable")
Reserved.
boolean
[OBSOLETE] Former feature used to fallback to long code sender after certain short code message failures.
boolean
Reserved.
boolean
A boolean value that indicates either the webhook url configured on the phone number will be used or inbound_request_url/fallback_url url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the inbound_request_url/fallback_url defined for the Messaging Service.

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: TWILIO_MESSAGING_CREATE_SHORT_CODECreate Short Code using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the Service to create the resource under.
string
required
The SID of the ShortCode resource being added to the Service.

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: TWILIO_MESSAGING_CREATE_TOLLFREE_VERIFICATIONCreate a tollfree verification

Input Parameters

string
The unique ID of the vetting
string ("VERBAL" | "WEB_FORM" | "PAPER_FORM" | "VIA_TEXT" | "MOBILE_QR_CODE" | "IMPORT" | "IMPORT_PLEASE_REPLACE")
required
Describe how a user opts-in to text messages.
string
The city of the business or organization using the Tollfree number.
string
required
The name of the business or organization using the Tollfree number.
string ("PRIVATE_PROFIT" | "PUBLIC_PROFIT" | "SOLE_PROPRIETOR" | "NON_PROFIT" | "GOVERNMENT")
The type of business, valid values are PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, SOLE_PROPRIETOR, GOVERNMENT. Required field.
string
required
Estimate monthly volume of messages from the Tollfree Number.
array
List of keywords that users can text in to opt in to receive messages.
string
The country of the business or organization using the Tollfree number.
string
required
The website of the business or organization using the Tollfree number.
string
required
Use this to further explain how messaging is used by the business or organization.
string
The third-party political vetting provider.
boolean
Indicates if the content is age gated.
string
Trade name, sub entity, or downstream business name of business being submitted for verification
array
required
Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL.
string
required
The email address to receive the notification about the verification result. .
string
The URL to the privacy policy for the business or organization.
string
A sample help message provided to users.
string
required
The category of the use case for the Tollfree Number. List as many as are applicable.
string
The postal code of the business or organization using the Tollfree number.
string
Customer’s Profile Bundle BundleSid.
string
An optional external reference ID supplied by customer and echoed back on status retrieval.
string
Additional information to be provided for verification.
string
The email address of the contact for the business or organization using the Tollfree number.
string
The E.164 formatted phone number of the contact for the business or organization using the Tollfree number.
string
The address of the business or organization using the Tollfree number.
string
The address of the business or organization using the Tollfree number.
string
The URL to the terms and conditions for the business or organization.
string
required
An example of message content, i.e. a sample message.
string
required
The SID of the Phone Number associated with the Tollfree Verification.
string
The last name of the contact for the business or organization using the Tollfree number.
string
The first name of the contact for the business or organization using the Tollfree number.
string
The confirmation message sent to users when they opt in to receive messages.
string
A legally recognized business registration number. Required for all business types except SOLE_PROPRIETOR.
string
The country where the business is registered. Required for all business types except SOLE_PROPRIETOR.
string
The state/province/region of the business or organization using the Tollfree number.
string ("EIN" | "CBN" | "CRN" | "PROVINCIAL_NUMBER" | "VAT" | "ACN" | "ABN" | "BRN" | "SIREN" | "SIRET" | "NZBN" | "USt-IdNr" | "CIF" | "NIF" | "CNPJ" | "UID" | "NEQ" | "OTHER")
The organizational authority for business registrations. Required for all business types except SOLE_PROPRIETOR.
string
The E.164 formatted number associated with the business.

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: TWILIO_MESSAGING_CREATE_US_APP_TO_PERSONCreate Us App To Person using the Twilio messaging_v1 REST API.

Input Parameters

boolean
A boolean that specifies whether campaign is age gated or not.
string
required
A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters.
string
When customers receive the help keywords from their end users, Twilio customers are expected to send back an auto-generated response; this may include the brand name and additional support contact information. This field is required if managing help keywords yourself (i.e. not using Twilio’s Default or Advanced Opt Out features). 20 character minimum. 320 character maximum.
string
required
Required for all Campaigns. Details around how a consumer opts-in to their campaign, therefore giving consent to receive their messages. If multiple opt-in methods can be used for the same campaign, they must all be listed. 40 character minimum. 2048 character maximum.
array
End users should be able to text in a keyword to receive help. Those keywords must be provided as part of the campaign registration request. This field is required if managing help keywords yourself (i.e. not using Twilio’s Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum.
boolean
A boolean that specifies whether campaign allows direct lending or not.
string
If end users can text in a keyword to start receiving messages from this campaign, the auto-reply messages sent to the end users must be provided. The opt-in response should include the Brand name, confirmation of opt-in enrollment to a recurring message campaign, how to get help, and clear description of how to opt-out. This field is required if end users can text in a keyword to start receiving messages from this campaign. 20 character minimum. 320 character maximum.
array
required
An array of sample message strings, min two and max five. Min length for each sample: 20 chars. Max length for each sample: 1024 chars.
array
If end users can text in a keyword to start receiving messages from this campaign, those keywords must be provided. This field is required if end users can text in a keyword to start receiving messages from this campaign. Values must be alphanumeric. 255 character maximum.
string
Upon receiving the opt-out keywords from the end users, Twilio customers are expected to send back an auto-generated response, which must provide acknowledgment of the opt-out request and confirmation that no further messages will be sent. It is also recommended that these opt-out messages include the brand name. This field is required if managing opt out keywords yourself (i.e. not using Twilio’s Default or Advanced Opt Out features). 20 character minimum. 320 character maximum.
array
End users should be able to text in a keyword to stop receiving messages from this campaign. Those keywords must be provided. This field is required if managing opt out keywords yourself (i.e. not using Twilio’s Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum.
boolean
A boolean that specifies whether campaign has Subscriber Optin or not.
Indicates that this SMS campaign will send messages that contain links.
boolean
required
Indicates that this SMS campaign will send messages that contain phone numbers.
string
The URL of the privacy policy for the campaign.
string
The version of the Messaging API to use for this request
string
required
The SID of the Messaging Service to create the resources from.
string
required
A2P Brand Registration SID
string
The URL of the terms and conditions for the campaign.
string
required
A2P Campaign Use Case. Examples: [ 2FA, EMERGENCY, MARKETING..]

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: TWILIO_MESSAGING_DELETE_ALPHA_SENDERDelete Alpha Sender using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the AlphaSender resource to delete.
string
required
The SID of the Service to delete the resource from.

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: TWILIO_MESSAGING_DELETE_CHANNEL_SENDERDelete Channel Sender using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the Channel Sender resource to delete.
string
required
The SID of the Service to delete the resource from.

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: TWILIO_MESSAGING_DELETE_DESTINATION_ALPHA_SENDERDelete Destination Alpha Sender using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the AlphaSender resource to delete.
string
required
The SID of the Service to delete the resource from.

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: TWILIO_MESSAGING_DELETE_DOMAIN_CERT_V4Delete Domain Cert V4 using the Twilio messaging_v1 REST API.

Input Parameters

string
required
Unique string used to identify the domain that this certificate should be associated with.

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: TWILIO_MESSAGING_DELETE_LINKSHORTENING_MESSAGING_SERVICEDelete Linkshortening Messaging Service using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The domain SID to dissociate from a messaging service. With URL shortening enabled, links in messages sent with the associated messaging service will be shortened to the provided domain
string
required
A messaging service SID to dissociate from a domain. With URL shortening enabled, links in messages sent with the provided messaging service will be shortened to the associated domain

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: TWILIO_MESSAGING_DELETE_PHONE_NUMBERDelete Phone Number using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the PhoneNumber resource to delete.
string
required
The SID of the Service to delete the resource from.

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: TWILIO_MESSAGING_DELETE_SERVICEDelete Service using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the Service resource 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: TWILIO_MESSAGING_DELETE_SHORT_CODEDelete Short Code using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the ShortCode resource to delete.
string
required
The SID of the Service to delete the resource from.

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: TWILIO_MESSAGING_DELETE_TOLLFREE_VERIFICATIONDelete a tollfree verification

Input Parameters

string
required
The unique string to identify Tollfree Verification.

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: TWILIO_MESSAGING_DELETE_US_APP_TO_PERSONDelete Us App To Person using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the US A2P Compliance resource to delete QE{{32_HEX}}.
string
required
The SID of the Messaging Service to delete the resource from.

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: TWILIO_MESSAGING_FETCH_ALPHA_SENDERFetch Alpha Sender using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the AlphaSender resource to fetch.
string
required
The SID of the Service to fetch the resource from.

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: TWILIO_MESSAGING_FETCH_BRAND_REGISTRATIONSFetch Brand Registrations using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the Brand Registration resource to fetch.

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: TWILIO_MESSAGING_FETCH_BRAND_VETTINGFetch Brand Vetting using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the Brand Registration resource of the vettings to read .
string
required
The Twilio SID of the third-party vetting record.

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: TWILIO_MESSAGING_FETCH_CHANNEL_SENDERFetch Channel Sender using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the ChannelSender resource to fetch.
string
required
The SID of the Service to fetch the resource from.

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: TWILIO_MESSAGING_FETCH_DEACTIVATIONFetch a list of all United States numbers that have been deactivated on a specific date.

Input Parameters

string
The request will return a list of all United States Phone Numbers that were deactivated on the day specified by this parameter. This date should be specified in YYYY-MM-DD format.

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: TWILIO_MESSAGING_FETCH_DESTINATION_ALPHA_SENDERFetch Destination Alpha Sender using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the AlphaSender resource to fetch.
string
required
The SID of the Service to fetch the resource from.

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: TWILIO_MESSAGING_FETCH_DOMAIN_CERT_V4Fetch Domain Cert V4 using the Twilio messaging_v1 REST API.

Input Parameters

string
required
Unique string used to identify the domain that this certificate should be associated with.

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: TWILIO_MESSAGING_FETCH_DOMAIN_CONFIGFetch Domain Config using the Twilio messaging_v1 REST API.

Input Parameters

string
required
Unique string used to identify the domain that this config should be associated with.

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: TWILIO_MESSAGING_FETCH_DOMAIN_CONFIG_MESSAGING_SERVICEFetch Domain Config Messaging Service using the Twilio messaging_v1 REST API.

Input Parameters

string
required
Unique string used to identify the Messaging service that this domain should be associated with.

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: TWILIO_MESSAGING_FETCH_DOMAIN_DNS_VALIDATIONFetch Domain Dns Validation using the Twilio messaging_v1 REST API.

Input Parameters

string
required
Unique string used to identify the domain.

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: TWILIO_MESSAGING_FETCH_LINKSHORTENING_MESSAGING_SERVICE_DOMAIN_A656764DFetch Linkshortening Messaging Service Domain Association using the Twilio messaging_v1 REST API.

Input Parameters

string
required
Unique string used to identify the Messaging service that this domain should be associated with.

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: TWILIO_MESSAGING_FETCH_PHONE_NUMBERFetch Phone Number using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the PhoneNumber resource to fetch.
string
required
The SID of the Service to fetch the resource from.

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: TWILIO_MESSAGING_FETCH_SERVICEFetch Service using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the Service resource to fetch.

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: TWILIO_MESSAGING_FETCH_SHORT_CODEFetch Short Code using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the ShortCode resource to fetch.
string
required
The SID of the Service to fetch the resource from.

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: TWILIO_MESSAGING_FETCH_TOLLFREE_VERIFICATIONRetrieve a tollfree verification

Input Parameters

string
required
A unique string identifying a Tollfree Verification.

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: TWILIO_MESSAGING_FETCH_US_APP_TO_PERSONFetch Us App To Person using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the US A2P Compliance resource to fetch QE{{32_HEX}}.
string
The version of the Messaging API to use for this request
string
required
The SID of the Messaging Service to fetch the resource from.

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: TWILIO_MESSAGING_FETCH_US_APP_TO_PERSON_USECASEFetch Us App To Person Usecase using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the Messaging Service to fetch the resource from.
string
The unique string to identify the A2P brand.

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: TWILIO_MESSAGING_FETCH_USECASEFetch Usecase using the Twilio messaging_v1 REST API.

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: TWILIO_MESSAGING_LIST_ALPHA_SENDERList Alpha Sender using the Twilio messaging_v1 REST API.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the Service to read the resources from.

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: TWILIO_MESSAGING_LIST_BRAND_REGISTRATIONSList Brand Registrations using the Twilio messaging_v1 REST API.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_MESSAGING_LIST_BRAND_VETTINGList Brand Vetting using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the Brand Registration resource of the vettings to read .
string
Cursor returned by the previous call; resend required path fields with it.
string ("campaign-verify" | "aegis")
The third-party provider of the vettings to read

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: TWILIO_MESSAGING_LIST_CHANNEL_SENDERList Channel Sender using the Twilio messaging_v1 REST API.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the Service to read the resources from.

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: TWILIO_MESSAGING_LIST_DESTINATION_ALPHA_SENDERList Destination Alpha Sender using the Twilio messaging_v1 REST API.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the Service to read the resources from.
string
Optional filter to return only alphanumeric sender IDs associated with the specified two-character ISO country code.

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: TWILIO_MESSAGING_LIST_PHONE_NUMBERList Phone Number using the Twilio messaging_v1 REST API.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the Service to read the resources from.

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: TWILIO_MESSAGING_LIST_SERVICEList Service using the Twilio messaging_v1 REST API.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_MESSAGING_LIST_SHORT_CODEList Short Code using the Twilio messaging_v1 REST API.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the Service to read the resources from.

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: TWILIO_MESSAGING_LIST_TOLLFREE_VERIFICATIONList tollfree verifications

Input Parameters

integer
The page index. This value is simply for client state.
string ("PENDING_REVIEW" | "IN_REVIEW" | "TWILIO_APPROVED" | "TWILIO_REJECTED")
The compliance status of the Tollfree Verification record.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
array
The trust product sids / tollfree bundle sids of tollfree verifications
boolean
Whether to include Tollfree Verifications from sub accounts in list response.
string
Customer supplied reference id for the Tollfree Verification record.
string
The SID of the Phone Number associated with the Tollfree Verification.

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: TWILIO_MESSAGING_LIST_US_APP_TO_PERSONList Us App To Person using the Twilio messaging_v1 REST API.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
The version of the Messaging API to use for this request
string
required
The SID of the Messaging Service to fetch the resource from.

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: TWILIO_MESSAGING_UPDATE_BRAND_REGISTRATIONSUpdate Brand Registrations using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the Brand Registration resource 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
Slug: TWILIO_MESSAGING_UPDATE_DOMAIN_CERT_V4Update Domain Cert V4 using the Twilio messaging_v1 REST API.

Input Parameters

string
required
Contains the full TLS certificate and private for this domain in PEM format: https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail. Twilio uses this information to process HTTPS traffic sent to your domain.
string
required
Unique string used to identify the domain that this certificate should be associated with.

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: TWILIO_MESSAGING_UPDATE_DOMAIN_CONFIGUpdate Domain Config using the Twilio messaging_v1 REST API.

Input Parameters

string
required
Unique string used to identify the domain that this config should be associated with.
string
URL to receive click events to your webhook whenever the recipients click on the shortened links
string
Any requests we receive to this domain that do not match an existing shortened message will be redirected to the fallback url. These will likely be either expired messages, random misdirected traffic, or intentional scraping.
boolean
Customer’s choice to send links with/without “https://” attached to shortened url. If true, messages will not be sent with https:// at the beginning of the url. If false, messages will be sent with https:// at the beginning of the url. False is the default behavior if it is not specified.
boolean
Boolean field to set customer delivery preference when there is a failure in linkShortening service

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: TWILIO_MESSAGING_UPDATE_REQUEST_MANAGED_CERTUpdate Request Managed Cert using the Twilio messaging_v1 REST API.

Input Parameters

string
required
Unique string used to identify the domain that this certificate should be associated with.

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: TWILIO_MESSAGING_UPDATE_SERVICEUpdate Service using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the Service resource to update.
string
A string that describes the scenario in which the Messaging Service will be used. Possible values are notifications, marketing, verification, discussion, poll, undeclared.
string
The URL that we call using fallback_method if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the use_inbound_webhook_on_number field is enabled then the webhook url defined on the phone number will override the fallback_url defined for the Messaging Service.
string
A descriptive string that you create to describe the resource. It can be up to 64 characters long.
boolean
Whether to enable the MMS Converter for messages sent through the Service instance.
boolean
Whether to enable Sticky Sender on the Service instance.
string ("GET" | "POST")
The HTTP method we should use to call inbound_request_url. Can be GET or POST and the default is POST.
boolean
Whether to enable Smart Encoding for messages sent through the Service instance.
string ("GET" | "POST")
The HTTP method we should use to call fallback_url. Can be: GET or POST.
string
The URL we should call to pass status updates about message delivery.
integer
How long, in seconds, messages sent from the Service are valid. Can be an integer from 1 to 36,000. Default value is 36,000.
boolean
Whether to enable Area Code Geomatch on the Service Instance.
string
The URL we call using inbound_method when a message is received by any phone number or short code in the Service. When this property is null, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the use_inbound_webhook_on_number field is enabled then the webhook url defined on the phone number will override the inbound_request_url defined for the Messaging Service.
string ("inherit" | "enable" | "disable")
Reserved.
boolean
[OBSOLETE] Former feature used to fallback to long code sender after certain short code message failures.
boolean
Reserved.
boolean
A boolean value that indicates either the webhook url configured on the phone number will be used or inbound_request_url/fallback_url url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the inbound_request_url/fallback_url defined for the Messaging Service.

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: TWILIO_MESSAGING_UPDATE_TOLLFREE_VERIFICATIONEdit a tollfree verification

Input Parameters

string
required
The unique string to identify Tollfree Verification.
string
The unique ID of the vetting
string
Describe why the verification is being edited. If the verification was rejected because of a technical issue, such as the website being down, and the issue has been resolved this parameter should be set to something similar to ‘Website fixed’.
string ("VERBAL" | "WEB_FORM" | "PAPER_FORM" | "VIA_TEXT" | "MOBILE_QR_CODE" | "IMPORT" | "IMPORT_PLEASE_REPLACE")
Describe how a user opts-in to text messages.
string
The city of the business or organization using the Tollfree number.
string
The name of the business or organization using the Tollfree number.
string ("PRIVATE_PROFIT" | "PUBLIC_PROFIT" | "SOLE_PROPRIETOR" | "NON_PROFIT" | "GOVERNMENT")
The type of business, valid values are PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, SOLE_PROPRIETOR, GOVERNMENT. Required field.
string
Estimate monthly volume of messages from the Tollfree Number.
array
List of keywords that users can text in to opt in to receive messages.
string
The country of the business or organization using the Tollfree number.
string
The website of the business or organization using the Tollfree number.
string
Use this to further explain how messaging is used by the business or organization.
string
The third-party political vetting provider.
boolean
Indicates if the content is age gated.
string
Trade name, sub entity, or downstream business name of business being submitted for verification
array
Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL.
string
The email address to receive the notification about the verification result. .
string
The URL to the privacy policy for the business or organization.
string
A sample help message provided to users.
array
The category of the use case for the Tollfree Number. List as many as are applicable.
string
The postal code of the business or organization using the Tollfree number.
string
Additional information to be provided for verification.
string
The email address of the contact for the business or organization using the Tollfree number.
string
The E.164 formatted phone number of the contact for the business or organization using the Tollfree number.
string
The address of the business or organization using the Tollfree number.
string
The address of the business or organization using the Tollfree number.
string
The URL to the terms and conditions for the business or organization.
string
An example of message content, i.e. a sample message.
string
The last name of the contact for the business or organization using the Tollfree number.
string
The first name of the contact for the business or organization using the Tollfree number.
string
The confirmation message sent to users when they opt in to receive messages.
string
A legally recognized business registration number
string
Country business is registered in
string
The state/province/region of the business or organization using the Tollfree number.
string ("EIN" | "CBN" | "CRN" | "PROVINCIAL_NUMBER" | "VAT" | "ACN" | "ABN" | "BRN" | "SIREN" | "SIRET" | "NZBN" | "USt-IdNr" | "CIF" | "NIF" | "CNPJ" | "UID" | "NEQ" | "OTHER")
The organizational authority for business registrations. Required for all business types except SOLE_PROPRIETOR.
string
The E.164 formatted number associated with the business.

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: TWILIO_MESSAGING_UPDATE_US_APP_TO_PERSONUpdate Us App To Person using the Twilio messaging_v1 REST API.

Input Parameters

string
required
The SID of the US A2P Compliance resource to update QE{{32_HEX}}.
boolean
required
A boolean that specifies whether campaign requires age gate for federally legal content.
string
required
A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters.
string
required
Required for all Campaigns. Details around how a consumer opts-in to their campaign, therefore giving consent to receive their messages. If multiple opt-in methods can be used for the same campaign, they must all be listed. 40 character minimum. 2048 character maximum.
boolean
required
A boolean that specifies whether campaign allows direct lending or not.
array
required
An array of sample message strings, min two and max five. Min length for each sample: 20 chars. Max length for each sample: 1024 chars.
Indicates that this SMS campaign will send messages that contain links.
boolean
required
Indicates that this SMS campaign will send messages that contain phone numbers.
string
The URL of the privacy policy for the campaign.
string
The version of the Messaging API to use for this request
string
required
The SID of the Messaging Service to update the resource from.
string
The URL of the terms and conditions for the campaign.

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: TWILIO_NUMBERS_CREATE_BULK_ELIGIBILITYCreate a bulk eligibility check for a set of numbers that you want to host in Twilio.

Input Parameters

string
required
Human-readable name for the eligibility check.
array
required
Phone numbers to check for Twilio hosting eligibility.

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: TWILIO_NUMBERS_CREATE_ELIGIBILITYCreate an eligibility check for a number that you want to host in Twilio.

Input Parameters

string
Human-readable name for the eligibility check.
array
required
Phone numbers to check for Twilio hosting eligibility.

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: TWILIO_NUMBERS_CREATE_PORTING_PORT_INAllows to create a new port in request

Input Parameters

array
required
List of document SIDs for all phone numbers included in the port in request. At least one document SID referring to a document of the type Utility Bill is required.
string
The bundle sid is an optional identifier to reference a group of regulatory documents for a port request.
string
required
Account Sid or subaccount where the phone number(s) will be Ported
array
List of phone numbers to be ported. Maximum of 1,000 phone numbers per request.
array
Additional emails to send a copy of the signed LOA to.
string
Target date to port the number. We cannot guarantee that this date will be honored by the other carriers, please work with Ops to get a confirmation of the firm order commitment (FOC) date. Expected format is ISO Local Date, example: ‘2011-12-03`. This date must be at least 7 days in the future for US ports and 10 days in the future for Japanese ports. We can’t guarantee the exact date and time, as this depends on the losing carrier
object
required
Twilio losing_carrier_information request value.
string
A field only required for Japan port in requests. It is a unique identifier for the donor carrier service the line is being ported from.
string
Japan specific field, indicates the number of phone numbers to automatically approve for cancellation.
string
The latest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00’. We can’t guarantee the exact date and time, as this depends on the losing carrier
string
The earliest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00’. We can’t guarantee the exact date and time, as this depends on the losing carrier

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: TWILIO_NUMBERS_CREATE_PORTING_WEBHOOK_CONFIGURATIONCreate a Webhook Configuration

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: TWILIO_NUMBERS_CREATE_SENDER_ID_REGISTRATIONCreates a new sender ID registration and initializes an embedded Persona inquiry session. Returns registration details and embedded session credentials for rendering the Compliance Embeddable UI.

Input Parameters

object
required
Registration data organized by section (alphanumericSender, business, useCase, authorizedRepresentative, officer, businessAddress).
string
Additional comments about the registration.
string
Theme ID for the Compliance Embeddable UI.
string
required
Human-readable name for the registration.
string
required
The regulation for this registration.
integer
required
The regulation version.
string
The URL of this resource.
string
Email address for registration status notifications.

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: TWILIO_NUMBERS_CREATE_SENDER_ID_REGISTRATION_EMBEDDED_SESSIONCreates a new embedded Persona inquiry session for an existing registration in DRAFT or TWILIO_REJECTED status. Use this to resume an incomplete registration or resubmit a rejected one.

Input Parameters

string
required
The unique identifier of the registration (BU-prefixed).
string
Theme ID for the Compliance Embeddable UI. Overrides the theme set during registration creation.

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: TWILIO_NUMBERS_CREATE_SIGNING_REQUEST_CONFIGURATIONSynchronous operation to insert or update a configuration for the customer.

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: TWILIO_NUMBERS_CREATE_SMS_VERIFICATIONInitiate SMS verification for a caller ID

Input Parameters

string
required
The phone number to verify in E.164 format.
string
The locale for the verification SMS message.
string
A human-readable name for the caller 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: TWILIO_NUMBERS_CREATE_SMS_VERIFICATION_CHECKCheck SMS verification code

Input Parameters

string
required
The phone number being verified in E.164 format.
string
A human-readable name for the caller ID.
string
required
The 6 character verification code to check.

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: TWILIO_NUMBERS_CREATE_VOICE_VERIFICATIONInitiate voice verification for a caller ID

Input Parameters

string
Phone extension to dial after connecting.
string
Number of seconds to delay the verification call (0-60).
string
A custom verification code to use instead of a generated one.
string
required
The phone number to verify in E.164 format.
string
A human-readable name for the caller ID.
string
URL to receive status callback events.
string
Custom message to play after successful verification.
string ("HEAD" | "GET" | "POST" | "PATCH" | "PUT" | "DELETE")
HTTP method for status callback requests.

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: TWILIO_NUMBERS_DELETE_PORTING_PORT_INAllows to cancel a port in request by SID

Input Parameters

string
required
The SID of the Port In request. This is a unique identifier of the port in request.

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: TWILIO_NUMBERS_DELETE_PORTING_PORT_IN_PHONE_NUMBERAllows to cancel a port in request phone number by SID

Input Parameters

string
required
The SID of the Port In request phone number. This is a unique identifier of the phone number.
string
required
The SID of the Port In request. This is a unique identifier of the port in request.

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: TWILIO_NUMBERS_DELETE_PORTING_WEBHOOK_CONFIGURATION_DELETEAllows the client to delete a webhook configuration.

Input Parameters

string ("PORT_IN" | "PORT_OUT")
required
The webhook type for the configuration to be delete. PORT_IN, PORT_OUT

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: TWILIO_NUMBERS_FETCH_BULK_ELIGIBILITYFetch an eligibility bulk check that you requested to host in Twilio.

Input Parameters

string
required
The SID of the bulk eligibility check that you want to know about.

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: TWILIO_NUMBERS_FETCH_PORTING_PORTABILITYCheck if a single phone number can be ported to Twilio

Input Parameters

string
Address Sid of customer to which the number will be ported.
string
required
Phone number to check portability in e164 format.
string
Account Sid to which the number will be ported. This can be used to determine if a sub account already has the number in its inventory or a different sub account. If this is not provided, the authenticated account will be assumed to be the target 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: TWILIO_NUMBERS_FETCH_PORTING_PORT_INFetch a port in request by SID

Input Parameters

string
required
The SID of the Port In request. This is a unique identifier of the port in request.

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: TWILIO_NUMBERS_FETCH_PORTING_PORT_IN_PHONE_NUMBERFetch a phone number by port in request SID and phone number SID

Input Parameters

string
required
The SID of the Phone number. This is a unique identifier of the phone number.
string
required
The SID of the Port In request. This is a unique identifier of the port in request.

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: TWILIO_NUMBERS_FETCH_PORTING_WEBHOOK_CONFIGURATION_FETCHAllows to fetch the webhook configuration

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: TWILIO_NUMBERS_LIST_PORT_IN_REQUESTSRetrieve a list of all PortInRequests for a user

Input Parameters

integer
Number of items per page
string
Page start token, if null then it will start from the beginning
string
Cursor returned by the previous call; resend required path fields with it.
string
Find all created after a certain date
string
Find all created before a certain date
string
Filter by Port in request SID, supports multiple values separated by comma
string
Filter by Port In request 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: TWILIO_NUMBERS_LIST_SIGNING_REQUEST_CONFIGURATIONSynchronous operation to retrieve configurations for the customer.

Input Parameters

integer
The page index. This value is simply for client state.
string
The country ISO code to apply this configuration, this is an optional field, Example: US, MX
string
The product or service for which is requesting the signature, this is an optional field, Example: Porting, Hosting
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_SEND_SMSImmediately send an irreversible outbound SMS or supported channel message from a sender owned by the specified Twilio account.

Input Parameters

string
required
Message text, up to 1,600 characters.
string
required
Recipient phone number in E.164 format or supported channel address.
string
required
AC-prefixed Twilio account SID that owns the sender.
string
required
Twilio-owned sender in E.164 format, short code, alphanumeric sender ID, or supported channel address.

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: TWILIO_STUDIO_CREATE_EXECUTIONTriggers a new Execution for the Flow

Input Parameters

string
required
The Contact phone number to start a Studio Flow Execution, available as variable {{contact.channel.address}}.
string
required
The Twilio phone number to send messages or initiate calls from during the Flow’s Execution. Available as variable {{flow.channel.address}}. For SMS, this can also be a Messaging Service SID.
string
required
The SID of the Excecution’s Flow.
string
JSON data that will be added to the Flow’s context and that can be accessed as variables inside your Flow. For example, if you pass in Parameters={"name":"Zeke"}, a widget in your Flow can reference the variable {{flow.data.name}}, which returns “Zeke”. Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode the JSON string.

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: TWILIO_STUDIO_CREATE_FLOWCreate a Flow.

Input Parameters

string ("draft" | "published")
required
The status of the Flow. Can be: draft or published.
string
The SID of the User that created the Flow.
string
required
JSON representation of flow definition.
string
required
The string that you assigned to describe the Flow.
string
Description of change made in the revision.

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: TWILIO_STUDIO_DELETE_EXECUTIONDelete the Execution and all Steps relating to it.

Input Parameters

string
required
The SID of the Execution resource to delete.
string
required
The SID of the Flow with the Execution resources 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: TWILIO_STUDIO_DELETE_FLOWDelete a specific Flow.

Input Parameters

string
required
The SID of the Flow resource 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: TWILIO_STUDIO_FETCH_EXECUTIONRetrieve an Execution

Input Parameters

string
required
The SID of the Execution resource to fetch.
string
required
The SID of the Flow with the Execution resource to fetch

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: TWILIO_STUDIO_FETCH_EXECUTION_CONTEXTRetrieve the most recent context for an Execution.

Input Parameters

string
required
The SID of the Flow with the Execution context to fetch.
string
required
The SID of the Execution context to fetch.

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: TWILIO_STUDIO_FETCH_EXECUTION_STEPRetrieve a Step.

Input Parameters

string
required
The SID of the ExecutionStep resource to fetch.
string
required
The SID of the Flow with the Step to fetch.
string
required
The SID of the Execution resource with the Step to fetch.

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: TWILIO_STUDIO_FETCH_EXECUTION_STEP_CONTEXTRetrieve the context for an Execution Step.

Input Parameters

string
required
The SID of the Flow with the Step to fetch.
string
required
The SID of the Step to fetch.
string
required
The SID of the Execution resource with the Step to fetch.

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: TWILIO_STUDIO_FETCH_FLOWRetrieve a specific Flow.

Input Parameters

string
required
The SID of the Flow resource to fetch.

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: TWILIO_STUDIO_FETCH_FLOW_REVISIONRetrieve a specific Flow revision.

Input Parameters

string
required
The SID of the Flow resource to fetch.
string
required
Specific Revision number or can be LatestPublished and LatestRevision.

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: TWILIO_STUDIO_FETCH_TEST_USERFetch flow test users

Input Parameters

string
required
Unique identifier of the flow.

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: TWILIO_STUDIO_LIST_EXECUTIONRetrieve a list of all Executions for the Flow.

Input Parameters

integer
The page index. This value is simply for client state.
string ("active" | "ended")
Only show Execution resources with the given status. Can be: active or ended.
string
required
The SID of the Flow with the Execution resources to read.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
Only show Execution resources starting before this ISO 8601 date-time, given as YYYY-MM-DDThh:mm:ss-hh:mm.
string
Only show Execution resources starting on or after this ISO 8601 date-time, given as YYYY-MM-DDThh:mm:ss-hh:mm.

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: TWILIO_STUDIO_LIST_EXECUTION_STEPRetrieve a list of all Steps for an Execution.

Input Parameters

integer
The page index. This value is simply for client state.
string
required
The SID of the Flow with the Steps to read.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the Execution with the Steps to read.

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: TWILIO_STUDIO_LIST_FLOWRetrieve a list of all Flows.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_STUDIO_LIST_FLOW_REVISIONRetrieve a list of all Flows revisions.

Input Parameters

string
required
The SID of the Flow resource to fetch.
integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_STUDIO_UPDATE_EXECUTIONUpdate the status of an Execution to ended.

Input Parameters

string
required
The SID of the Execution resource to update.
string ("active" | "ended")
required
The status of the Execution. Can be: active or ended.
string
required
The SID of the Flow with the Execution resources 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
Slug: TWILIO_STUDIO_UPDATE_FLOWUpdate a Flow.

Input Parameters

string
required
The SID of the Flow resource to fetch.
string ("draft" | "published")
required
The status of the Flow. Can be: draft or published.
string
The SID of the User that created or last updated the Flow.
string
JSON representation of flow definition.
string
The string that you assigned to describe the Flow.
string
Description of change made in the revision.

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: TWILIO_STUDIO_UPDATE_FLOW_VALIDATEValidate flow JSON definition

Input Parameters

string ("draft" | "published")
required
The status of the Flow. Can be: draft or published.
string
required
JSON representation of flow definition.
string
required
The string that you assigned to describe the Flow.
string
Description of change made in the revision.

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: TWILIO_STUDIO_UPDATE_TEST_USERUpdate flow test users

Input Parameters

string
required
Unique identifier of the flow.
array
required
List of test user identities that can test draft versions of the flow.

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: TWILIO_UPDATE_ACCOUNTModify the properties of a given Account

Input Parameters

string
required
The Account Sid that uniquely identifies the account to update
string ("active" | "suspended" | "closed")
The status of this account. Usually active, but can be suspended or closed.
string
Update the human-readable description of this 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: TWILIO_UPDATE_ADDRESSUpdate Address using the Twilio api_v2010 REST API.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Address resource to update.
string
The city of the address.
string
The state or region of the address.
string
The number and street address of the address.
string
required
The SID of the Account that is responsible for the Address resource to update.
string
The postal code of the address.
string
The name to associate with the address.
string
A descriptive string that you create to describe the new address. It can be up to 64 characters long for Regulatory Compliance addresses and 32 characters long for Emergency addresses.
string
The additional number and street address of the address.
boolean
Whether to enable emergency calling on the address. Can be: true or false.
boolean
Whether we should automatically correct the address. Can be: true or false and the default is true. If empty or true, we will correct the address you provide if necessary. If false, we won’t alter the address you provide.

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: TWILIO_UPDATE_APPLICATIONUpdates the application’s properties

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Application resource to update.
string
The URL we should call when the phone number receives an incoming SMS message.
string
The URL we should call when the phone number assigned to this application receives a call.
string ("GET" | "POST")
The HTTP method we should use to call sms_url. Can be: GET or POST.
string
required
The SID of the Account that created the Application resources to update.
string
The API version to use to start a new TwiML session. Can be: 2010-04-01 or 2008-08-01. The default value is your account’s default API version.
string ("GET" | "POST")
The HTTP method we should use to call voice_url. Can be: GET or POST.
string
A descriptive string that you create to describe the resource. It can be up to 64 characters long.
string
The URL we should call using the status_callback_method to send status information to your application.
string
The URL that we should call when an error occurs while retrieving or executing the TwiML from sms_url.
string
The URL that we should call when an error occurs retrieving or executing the TwiML requested by url.
string ("GET" | "POST")
The HTTP method we should use to call sms_fallback_url. Can be: GET or POST.
string
Same as message_status_callback: The URL we should call using a POST method to send status information about SMS messages sent by the application. Deprecated, included for backwards compatibility.
string ("GET" | "POST")
The HTTP method we should use to call voice_fallback_url. Can be: GET or POST.
string ("GET" | "POST")
The HTTP method we should use to call status_callback. Can be: GET or POST.
boolean
Whether we should look up the caller’s caller-ID name from the CNAM database (additional charges apply). Can be: true or false.
string
The URL we should call using a POST method to send message status information to your application.
boolean
Whether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be: true or false.

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: TWILIO_UPDATE_CALLInitiates a call redirect or terminates a call

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Call resource to update
string
The absolute URL that returns the TwiML instructions for the call. We will call this URL using the method when the call connects. For more information, see the Url Parameter section in Making Calls.
string
TwiML instructions for the call Twilio will use without fetching Twiml from url. Twiml and url parameters are mutually exclusive
string ("GET" | "POST")
The HTTP method we should use when calling the url. Can be: GET or POST and the default is POST. If an application_sid parameter is present, this parameter is ignored.
string ("canceled" | "completed")
Twilio Status request value.
integer
The maximum duration of the call in seconds. Constraints depend on account and configuration.
string
required
The SID of the Account that created the Call resource(s) to update.
string
The URL that we call using the fallback_method if an error occurs when requesting or executing the TwiML at url. If an application_sid parameter is present, this parameter is ignored.
string ("GET" | "POST")
The HTTP method that we should use to request the fallback_url. Can be: GET or POST and the default is POST. If an application_sid parameter is present, this parameter is ignored.
string
The URL we should call using the status_callback_method to send status information to your application. If no status_callback_event is specified, we will send the completed status. If an application_sid parameter is present, this parameter is ignored. URLs must contain a valid hostname (underscores are not permitted).
string ("GET" | "POST")
The HTTP method we should use when requesting the status_callback URL. Can be: GET or POST and the default is POST. If an application_sid parameter is present, this parameter is ignored.

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: TWILIO_UPDATE_CALL_RECORDINGChanges the status of the recording to paused, stopped, or in-progress. Note: Pass Twilio.CURRENT instead of recording sid to reference current active recording.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Recording resource to update.
string ("in-progress" | "paused" | "stopped" | "processing" | "completed" | "absent")
required
The status of the recording. Can be: processing, completed and absent. For more detailed statuses on in-progress recordings, check out how to Update a Recording Resource.
string
required
The Call SID of the resource to update.
string
required
The SID of the Account that created the Recording resource to update.
string
Whether to record during a pause. Can be: skip or silence and the default is silence. skip does not record during the pause period, while silence will replace the actual audio of the call with silence during the pause period. This parameter only applies when setting status is set to paused.

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: TWILIO_UPDATE_CONFERENCEUpdate Conference using the Twilio api_v2010 REST API.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Conference resource to update
string
Twilio Status request value.
string
required
The SID of the Account that created the Conference resource(s) to update.
string
The URL we should call to announce something into the conference. The URL may return an MP3 file, a WAV file, or a TwiML document that contains <Play>, <Say>, <Pause>, or <Redirect> verbs.
string ("GET" | "POST")
The HTTP method used to call announce_url. Can be: GET or POST and the default is POST

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: TWILIO_UPDATE_CONFERENCE_RECORDINGChanges the status of the recording to paused, stopped, or in-progress. Note: To use Twilio.CURRENT, pass it as recording sid.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Conference Recording resource to update. Use Twilio.CURRENT to reference the current active recording.
string ("in-progress" | "paused" | "stopped" | "processing" | "completed" | "absent")
required
The status of the recording. Can be: processing, completed and absent. For more detailed statuses on in-progress recordings, check out how to Update a Recording Resource.
string
required
The SID of the Account that created the Conference Recording resource to update.
string
required
The Conference SID that identifies the conference associated with the recording to update.
string
Whether to record during a pause. Can be: skip or silence and the default is silence. skip does not record during the pause period, while silence will replace the actual audio of the call with silence during the pause period. This parameter only applies when setting status is set to paused.

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: TWILIO_UPDATE_CONNECT_APPUpdate a connect-app with the specified parameters

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the ConnectApp resource to update.
string
required
The SID of the Account that created the ConnectApp resources to update.
string
A description of the Connect App.
array
A comma-separated list of the permissions you will request from the users of this ConnectApp. Can include: get-all and post-all.
string
The company name to set for the Connect App.
string
A public URL where users can obtain more information about this Connect App.
string
A descriptive string that you create to describe the resource. It can be up to 64 characters long.
string
The URL to redirect the user to after we authenticate the user and obtain authorization to access the Connect App.
string
The URL to call using the deauthorize_callback_method to de-authorize the Connect App.
string ("GET" | "POST")
The HTTP method to use when calling deauthorize_callback_url.

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: TWILIO_UPDATE_INCOMING_PHONE_NUMBERUpdate an incoming-phone-number instance.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the IncomingPhoneNumber resource to update.
string
The URL we should call when the phone number receives an incoming SMS message.
string
The SID of the Trunk we should use to handle phone calls to the phone number. If a trunk_sid is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a trunk_sid will automatically delete your voice_application_sid and vice versa.
string
The URL that we should call to answer a call to the phone number. The voice_url will not be called if a voice_application_sid or a trunk_sid is set.
string
The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.
string ("GET" | "POST")
The HTTP method that we should use to call sms_url. Can be: GET or POST and defaults to POST.
string
required
The SID of the Account that created the IncomingPhoneNumber resource to update. For more information, see Exchanging Numbers Between Subaccounts.
string
The SID of the Address resource we should associate with the phone number. Some regions require addresses to meet local regulations.
string
The API version to use for incoming calls made to the phone number. The default is 2010-04-01.
string
The SID of the Identity resource that we should associate with the phone number. Some regions require an identity to meet local regulations.
string ("GET" | "POST")
The HTTP method that we should use to call voice_url. Can be: GET or POST and defaults to POST.
string
A descriptive string that you created to describe this phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number.
string
The URL we should call using the status_callback_method to send status information to your application.
string
The SID of the Account that created the IncomingPhoneNumber resource to update. For more information, see Exchanging Numbers Between Subaccounts.
string ("Active" | "Inactive")
The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country.
string
The URL that we should call when an error occurs while requesting or executing the TwiML defined by sms_url.
string
The URL that we should call when an error occurs retrieving or executing the TwiML requested by url.
string ("voice" | "fax")
Twilio VoiceReceiveMode request value.
string
The SID of the application that should handle SMS messages sent to the number. If an sms_application_sid is present, we ignore all of the sms_*_url urls and use those set on the application.
string ("GET" | "POST")
The HTTP method that we should use to call sms_fallback_url. Can be: GET or POST and defaults to POST.
string
The SID of the emergency address configuration to use for emergency calling from this phone number.
string
The SID of the application we should use to handle phone calls to the phone number. If a voice_application_sid is present, we ignore all of the voice urls and use only those set on the application. Setting a voice_application_sid will automatically delete your trunk_sid and vice versa.
string ("GET" | "POST")
The HTTP method that we should use to call voice_fallback_url. Can be: GET or POST and defaults to POST.
string ("GET" | "POST")
The HTTP method we should use to call status_callback. Can be: GET or POST and defaults to POST.
boolean
Whether to lookup the caller’s name from the CNAM database and post it to your app. Can be: true or false and defaults to false.

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: TWILIO_UPDATE_KEYUpdate Key using the Twilio api_v2010 REST API.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Key resource to update.
string
required
The SID of the Account that created the Key resources to update.
string
A descriptive string that you create to describe the resource. It can be up to 64 characters long.

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: TWILIO_UPDATE_MEMBERDequeue a member from a queue and have the member’s call begin executing the TwiML document at that URL

Input Parameters

string
required
The absolute URL of the Queue resource.
string ("GET" | "POST")
How to pass the update request data. Can be GET or POST and the default is POST. POST sends the data as encoded form data and GET sends the data as query parameters.
string
required
The Call SID of the resource(s) to update.
string
required
The SID of the Queue in which to find the members to update.
string
required
The SID of the Account that created the Member resource(s) 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
Slug: TWILIO_UPDATE_MESSAGEUpdate a Message resource (used to redact Message body text and to cancel not-yet-sent messages)

Input Parameters

string
required
The SID of the Message resource to be updated
string
The new body of the Message resource. To redact the text content of a Message, this parameter’s value must be an empty string
string
Twilio Status request value.
string
required
The SID of the Account that created the Message resources 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
Slug: TWILIO_UPDATE_OUTGOING_CALLER_IDUpdates the caller-id

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to update.
string
required
The SID of the Account that created the OutgoingCallerId resources to update.
string
A descriptive string that you create to describe the resource. It can be up to 64 characters long.

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: TWILIO_UPDATE_PARTICIPANTUpdate the properties of the participant

Input Parameters

boolean
Whether the participant should be on hold. Can be: true or false. true puts the participant on hold, and false lets them rejoin the conference.
boolean
Whether the participant should be muted. Can be true or false. true will mute the participant, and false will un-mute them. Anything value other than true or false is interpreted as false.
string
required
The Call SID or label of the participant to update. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20.
boolean
Whether the participant is coaching another call. Can be: true or false. If not present, defaults to false unless call_sid_to_coach is defined. If true, call_sid_to_coach must be defined.
string
The URL we call using the hold_method for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains <Play>, <Say>, <Pause>, or <Redirect> verbs.
string
The URL that Twilio calls using the wait_method before the conference has started. The URL may return an MP3 file, a WAV file, or a TwiML document. The default value is the URL of our standard hold music. If you do not want anything to play while waiting for the conference to start, specify an empty string by setting wait_url to ''. For more details on the allowable verbs within the waitUrl, see the waitUrl attribute in the <Conference> TwiML instruction.
string
required
The SID of the Account that created the Participant resources to update.
string ("GET" | "POST")
The HTTP method we should use to call hold_url. Can be: GET or POST and the default is GET.
string ("GET" | "POST")
The HTTP method we should use to call wait_url. Can be GET or POST and the default is POST. When using a static audio file, this should be GET so that we can cache the file.
string
The URL we call using the announce_method for an announcement to the participant. The URL may return an MP3 file, a WAV file, or a TwiML document that contains <Play>, <Say>, <Pause>, or <Redirect> verbs.
boolean
Whether to play a notification beep to the conference when the participant exits. Can be: true or false.
string
required
The SID of the conference with the participant to update.
string ("GET" | "POST")
The HTTP method we should use to call announce_url. Can be: GET or POST and defaults to POST.
string
The SID of the participant who is being coached. The participant being coached is the only participant who can hear the participant who is coaching.
boolean
Whether to end the conference when the participant leaves. Can be: true or false and defaults to false.

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: TWILIO_UPDATE_PAYMENTSupdate an instance of payments with different phases of payment flows.

Input Parameters

string
required
The SID of Payments session that needs to be updated.
string ("complete" | "cancel")
Indicates whether the current payment session should be cancelled or completed. When cancel the payment session is cancelled. When complete, Twilio sends the payment information to the selected Pay Connector for processing.
string ("payment-card-number" | "expiration-date" | "security-code" | "postal-code" | "bank-routing-number" | "bank-account-number" | "payment-card-number-matcher" | "expiration-date-matcher" | "security-code-matcher" | "postal-code-matcher")
The piece of payment information that you wish the caller to enter. Must be one of payment-card-number, expiration-date, security-code, postal-code, bank-routing-number, bank-account-number, or their -matcher variants for input confirmation when RequireMatchingInputs is enabled.
string
required
The SID of the call that will update the resource. This should be the same call sid that was used to create payments resource.
string
required
The SID of the Account that will update the resource.
string
required
A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions. This should be a unique string value per API call and can be a randomly generated.
string
required
Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the Update and Complete/Cancel POST requests.

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: TWILIO_UPDATE_QUEUEUpdate the queue with the new parameters

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Queue resource to update
integer
The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000.
string
required
The SID of the Account that created the Queue resource to update.
string
A descriptive string that you created to describe this resource. It can be up to 64 characters long.

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: TWILIO_UPDATE_REALTIME_TRANSCRIPTIONStop a Transcription using either the SID of the Transcription resource or the name used when creating the resource

Input Parameters

string
required
The SID of the Transcription resource, or the name used when creating the resource
string
required
Twilio Status request value.
string
required
The SID of the Call the Transcription resource is associated with.
string
required
The SID of the Account that created this Transcription resource.

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: TWILIO_UPDATE_SHORT_CODEUpdate a short code with the following parameters

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the ShortCode resource to update
string
The URL we should call when receiving an incoming SMS message to this short code.
string ("GET" | "POST")
The HTTP method we should use when calling the sms_url. Can be: GET or POST.
string
required
The SID of the Account that created the ShortCode resource(s) to update.
string
The API version to use to start a new TwiML session. Can be: 2010-04-01 or 2008-08-01.
string
A descriptive string that you created to describe this resource. It can be up to 64 characters long. By default, the FriendlyName is the short code.
string
The URL that we should call if an error occurs while retrieving or executing the TwiML from sms_url.
string ("GET" | "POST")
The HTTP method that we should use to call the sms_fallback_url. Can be: GET or POST.

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: TWILIO_UPDATE_SIGNING_KEYUpdate Signing Key using the Twilio api_v2010 REST API.

Input Parameters

string
required
Twilio Sid parameter.
string
required
Twilio AccountSid parameter.
string
Twilio FriendlyName request value.

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: TWILIO_UPDATE_SIP_CREDENTIALUpdate a credential resource.

Input Parameters

string
required
The unique id that identifies the resource to update.
string
The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg IWasAtSignal2018)
string
required
The unique id of the Account that is responsible for this resource.
string
required
The unique id that identifies the credential list that includes this credential.

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: TWILIO_UPDATE_SIP_CREDENTIAL_LISTUpdate a Credential List

Input Parameters

string
required
The credential list Sid that uniquely identifies this resource
string
required
The unique id of the Account that is responsible for this resource.
string
required
A human readable descriptive text for a CredentialList, up to 64 characters long.

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: TWILIO_UPDATE_SIP_DOMAINUpdate the attributes of a domain

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the SipDomain resource to update.
boolean
Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain.
string
The URL we should call when the domain receives a call.
string
required
The SID of the Account that created the SipDomain resource to update.
string
The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and ”-” and must end with sip.twilio.com.
string ("GET" | "POST")
The HTTP method we should use to call voice_url
string
A descriptive string that you created to describe the resource. It can be up to 64 characters long.
string
The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with.
boolean
Whether to allow SIP Endpoints to register with the domain to receive calls. Can be true or false. true allows SIP Endpoints to register with the domain to receive calls, false does not.
string
The URL that we should call when an error occurs while retrieving or executing the TwiML requested by voice_url.
string
Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call.
string ("GET" | "POST")
The HTTP method we should use to call voice_fallback_url. Can be: GET or POST.
boolean
Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.
string
The URL that we should call to pass status parameters (such as call ended) to your application.
string ("GET" | "POST")
The HTTP method we should use to call voice_status_callback_url. Can be: GET or POST.

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: TWILIO_UPDATE_SIP_IP_ACCESS_CONTROL_LISTRename an IpAccessControlList

Input Parameters

string
required
A 34 character string that uniquely identifies the resource to udpate.
string
required
The unique id of the Account responsible for this resource.
string
required
A human readable descriptive text, up to 255 characters long.

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: TWILIO_UPDATE_SIP_IP_ADDRESSUpdate an IpAddress resource.

Input Parameters

string
required
A 34 character string that identifies the IpAddress resource to update.
string
An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today.
string
required
The unique id of the Account responsible for this resource.
string
A human readable descriptive text for this resource, up to 255 characters long.
integer
An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used.
string
required
The IpAccessControlList Sid that identifies the IpAddress resources 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
Slug: TWILIO_UPDATE_SIPRECStop a Siprec using either the SID of the Siprec resource or the name used when creating the resource

Input Parameters

string
required
The SID of the Siprec resource, or the name used when creating the resource
string
required
Twilio Status request value.
string
required
The SID of the Call the Siprec resource is associated with.
string
required
The SID of the Account that created this Siprec resource.

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: TWILIO_UPDATE_STREAMStop a Stream using either the SID of the Stream resource or the name used when creating the resource

Input Parameters

string
required
The SID or the name of the Stream resource to be stopped
string
required
Twilio Status request value.
string
required
The SID of the Call the Stream resource is associated with.
string
required
The SID of the Account that created this Stream resource.

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: TWILIO_UPDATE_USAGE_TRIGGERUpdate an instance of a usage trigger

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the UsageTrigger resource to update.
string
required
The SID of the Account that created the UsageTrigger resources to update.
string
The URL we should call using callback_method when the trigger fires.
string
A descriptive string that you create to describe the resource. It can be up to 64 characters long.
string ("GET" | "POST")
The HTTP method we should use to call callback_url. Can be: GET or POST and the default is POST.

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: TWILIO_VERIFY_CREATE_ACCESS_TOKENCreate a new enrollment Access Token for the Entity

Input Parameters

integer
How long, in seconds, the access token is valid. Can be an integer between 60 and 300. Default is 60.
string
required
The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, and generated by your external system, such as your user’s UUID, GUID, or SID.
string
required
The Type of the Factor. Currently only push is supported.
string
required
The unique SID identifier of the Service.
string
The friendly name of the factor that is going to be created with this access token

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: TWILIO_VERIFY_CREATE_BUCKETCreate a new Bucket for a Rate Limit

Input Parameters

integer
required
Maximum number of requests permitted in during the interval.
integer
required
Number of seconds that the rate limit will be enforced over.
string
required
The SID of the Service the resource is associated with.
string
required
The Twilio-provided string that uniquely identifies the Rate Limit resource.

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: TWILIO_VERIFY_CREATE_CHALLENGECreate a new Challenge for the Factor

Input Parameters

string
required
Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user’s UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
string
required
The unique SID identifier of the Factor.
string
required
The unique SID identifier of the Service.
string
Optional payload used to verify the Challenge upon creation. Only used with a Factor of type totp to carry the TOTP code that needs to be verified. For TOTP this value must be between 3 and 8 characters long.
array
A list of objects that describe the Fields included in the Challenge. Each object contains the label and value of the field, the label can be up to 36 characters in length and the value can be up to 128 characters in length. Used when factor_type is push. There can be up to 20 details fields.
string
Details provided to give context about the Challenge. Not shown to the end user. It must be a stringified JSON with only strings values eg. {"ip": "172.168.1.234"}. Can be up to 1024 characters in length
string
Shown to the user when the push notification arrives. Required when factor_type is push. Can be up to 256 characters in length
string
The date-time when this Challenge expires, given in ISO 8601 format. The default value is five (5) minutes after Challenge creation. The max value is sixty (60) minutes after creation.

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: TWILIO_VERIFY_CREATE_CHALLENGE_PASSKEYSCreate a Passkeys Challenge

Input Parameters

string
Twilio identity request value.
string
Twilio factor_sid request value.
string
required
The unique SID identifier of the Service.

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: TWILIO_VERIFY_CREATE_ENTITYCreate a new Entity for the Service

Input Parameters

string
required
The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user’s UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
string
required
The unique SID identifier of the Service.

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: TWILIO_VERIFY_CREATE_MESSAGING_CONFIGURATIONCreate a new MessagingConfiguration for a service.

Input Parameters

string
required
The ISO-3166-1 country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value all.
string
required
The SID of the Service that the resource is associated with.
string
required
The SID of the Messaging Service to be used to send SMS to the country of this configuration.

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: TWILIO_VERIFY_CREATE_NEW_FACTORCreate a new Factor for the Entity

Input Parameters

string
required
Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user’s UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
string
Custom metadata associated with the factor. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. {"os": "Android"}. Can be up to 1024 characters in length.
string ("sha1" | "sha256" | "sha512")
Twilio Config.Alg request value.
string
The algorithm used when factor_type is push. Algorithm supported: ES256
integer
The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive. The default value is defined at the service level in the property totp.skew. If not configured defaults to 1. Used when factor_type is totp
string ("push" | "totp" | "passkeys")
required
The Type of this Factor. Currently push and totp are supported.
string
required
The unique SID identifier of the Service.
string
The ID that uniquely identifies your app in the Google or Apple store, such as com.example.myapp. It can be up to 100 characters long. Required when factor_type is push.
string
required
The friendly name of this Factor. This can be any string up to 64 characters, meant for humans to distinguish between Factors. For factor_type push, this could be a device name. For factor_type totp, this value is used as the “account name” in constructing the binding.uri property. At the same time, we recommend avoiding providing PII.
string
The shared secret for TOTP factors encoded in Base32. This can be provided when creating the Factor, otherwise it will be generated. Used when factor_type is totp
integer
Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is generated every time_step seconds. Must be between 20 and 60 seconds, inclusive. The default value is defined at the service level in the property totp.time_step. Defaults to 30 seconds if not configured. Used when factor_type is totp
string
The Ecdsa public key in PKIX, ASN.1 DER format encoded in Base64. Required when factor_type is push
integer
Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive. The default value is defined at the service level in the property totp.code_length. If not configured defaults to 6. Used when factor_type is totp
string
The Verify Push SDK version used to configure the factor Required when factor_type is push
string
For APN, the device token. For FCM, the registration token. It is used to send the push notifications. Must be between 32 and 255 characters long. Required when factor_type is push.
string ("apn" | "fcm" | "none")
Twilio Config.NotificationPlatform request value.

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: TWILIO_VERIFY_CREATE_NEW_FACTOR_PASSKEYCreate a new Passkeys Factor for the Entity

Input Parameters

object
Twilio config request value.
string
required
Twilio identity request value.
string
required
The unique SID identifier of the Service.
string
required
Twilio friendly_name request value.

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: TWILIO_VERIFY_CREATE_NOTIFICATIONCreate a new Notification for the corresponding Challenge

Input Parameters

integer
How long, in seconds, the notification is valid. Can be an integer between 0 and 300. Default is 300. Delivery is attempted until the TTL elapses, even if the device is offline. 0 means that the notification delivery is attempted immediately, only once, and is not stored for future delivery.
string
required
Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user’s UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
string
required
The unique SID identifier of the Service.
string
required
The unique SID identifier of the Challenge.

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: TWILIO_VERIFY_CREATE_RATE_LIMITCreate a new Rate Limit for a Service

Input Parameters

string
Description of this Rate Limit
string
required
The SID of the Service the resource is associated with.
string
required
Provides a unique and addressable name to be assigned to this Rate Limit, assigned by the developer, to be optionally used in addition to SID. This value should not contain PII.

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: TWILIO_VERIFY_CREATE_SAFELISTAdd a new phone number to SafeList.

Input Parameters

string
required
The phone number to be added in SafeList. Phone numbers must be in E.164 format.

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: TWILIO_VERIFY_CREATE_SERVICECreate a new Verification Service.

Input Parameters

string
The name of an alternative text-to-speech service to use in phone calls. Applies only to TTS languages.
integer
Optional configuration for the TOTP factors. The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive. Defaults to 1
integer
The length of the verification code to generate. Must be an integer value between 4 and 10, inclusive.
string
Optional configuration for the TOTP factors. Set TOTP Issuer for this service. This will allow to configure the issuer of the TOTP URI. Defaults to the service friendly name if not provided.
boolean
Whether to pass PSD2 transaction parameters when starting a verification.
string
required
A descriptive string that you create to describe the verification service. It can be up to 32 characters long. This value should not contain PII.
string
The number to use as the WhatsApp Sender that Verify will use to send WhatsApp messages to your users.This WhatsApp Sender must be associated with a Messaging Service SID.
boolean
Whether to perform a lookup with each verification started and return info about the phone number.
integer
Optional configuration for the TOTP factors. Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is generated every time_step seconds. Must be between 20 and 60 seconds, inclusive. Defaults to 30 seconds
integer
Optional configuration for the TOTP factors. Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive. Defaults to 6
boolean
Optional configuration for the Push factors. If true, include the date in the Challenge’s response. Otherwise, the date is omitted from the response. See Challenge resource’s details parameter for more info. Default: false. Deprecated do not use this parameter. This timestamp value is the same one as the one found in date_created, please use that one instead.
boolean
Whether to allow sending verifications with a custom code instead of a randomly generated one.
boolean
Whether to ask the user to press a number before delivering the verify code in a phone call.
string
The default message template. Will be used for all SMS verifications unless explicitly overriden. SMS channel only.
boolean
Whether to skip sending SMS verifications to landlines. Requires lookup_enabled.
string
Optional configuration for the Push factors. Set the APN Credential for this service. This will allow to send push notifications to iOS devices. See Credential Resource
string
Optional configuration for the Push factors. Set the FCM Credential for this service. This will allow to send push notifications to Android devices. See Credential Resource
string
The SID of the Messaging Service containing WhatsApp Sender(s) that Verify will use to send WhatsApp messages to your users.
string
The Relying Party ID for Passkeys. This is the domain of your application, e.g. example.com. It is used to identify your application when creating Passkeys.
string
The User Verification for Passkeys. This is the type of user verification that will be used to create Passkeys. It can be empty or it can have the values required, preferred or discouraged.
string
The Relying Party Name for Passkeys. This is the name of your application, e.g. Example App. It is used to identify your application when creating Passkeys.
boolean
Whether to add a security warning at the end of an SMS verification body. Disabled by default and applies only to SMS. Example SMS body: Your AppName verification code is: 1234. Don’t share this code with anyone; our employees will never ask for the code
string
The Relying Party Origins for Passkeys. This is the origin of your application, e.g. login.example.com,www.example.com. It is used to identify your application when creating Passkeys, it can have multiple origins split by ,.
string
The Authenticator Attachment for Passkeys. This is the type of authenticator that will be used to create Passkeys. It can be empty or it can have the values platform, cross-platform or any.
string
Indicates whether credentials must be discoverable by the authenticator. It can be empty or it can have the values required, preferred or discouraged.
boolean
Whether to allow verifications from the service to reach the stream-events sinks if configured

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: TWILIO_VERIFY_CREATE_VERIFICATIONCreate a new Verification using a Service

Input Parameters

string
required
The phone number or email to verify. Phone numbers must be in E.164 format.
string
A string containing a JSON map of key value pairs of tags to be recorded as metadata for the message. The tags will also be included as part of the verification and message status event type payloads. The object may contain up to 10 tags. Keys and values can each be up to 128 characters in length. This value should not contain PII.
string
The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
string
The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
string
Locale will automatically resolve based on phone number country code for SMS, WhatsApp, and call channel verifications. It will fallback to English or the template’s default translation if the selected translation is not available. This parameter will override the automatic locale resolution. See supported languages and more information here.
string
required
The verification method to use. One of: email, sms, whatsapp, call, sna or auto.
string
Your App Hash to be appended at the end of your verification SMS body. Applies only to SMS. Example SMS body: <#> Your AppName verification code is: 1234 He42w354ol9.
string
Strongly encouraged if using the auto channel. The IP address of the client’s device. If provided, it has to be a valid IPv4 or IPv6 address.
string
A stringified JSON array of template entries, ordered by preference. Each entry is an object with the following fields: sid (string, required, matching ^HJ[0-9a-fA-F]{32}$) — the SID of the message template to apply; and substitutions (object, optional) — a key-value map in which the keys are the template’s special variables and the values are their substitution values. The array may contain up to 10 entries. If provided, Templates takes precedence over TemplateSid and TemplateCustomSubstitutions.
string ("enable" | "disable")
Risk_check overrides Fraud Prevention measures like Fraud Guard, Geo Permissions etc per verification attempt basis, allowing Verify to block traffic considered fraudulent if enabled or bypass active protections if disabled. Can be: enable(default) or disable. For SMS channel only.
string
A pre-generated code to use for verification. The code can be between 4 and 10 characters, inclusive.
string
The custom key-value pairs of Programmable Rate Limits. Keys correspond to unique_name fields defined when creating your Rate Limit. Associated value pairs represent values in the request that you are rate limiting on. You may include multiple Rate Limit values in each request.
string
The digits to send after a phone call is answered, for example, to dial an extension. For more information, see the Programmable Voice documentation of sendDigits.
string
required
The SID of the verification Service to create the resource under.
string
The message template. If provided, will override the default template for the Service. SMS and Voice channels only. If the Templates parameter is also provided, Templates takes precedence over this parameter.
string
The text of a custom message to use for the verification [DEPRECATED].
string
A custom user defined friendly name that overwrites the existing one in the verification message
string
email channel configuration in json format. The fields ‘from’ and ‘from_name’ are optional but if included the ‘from’ field must have a valid email address.
boolean
An optional Boolean value to indicate the requirement of sna client token in the SNA URL invocation response for added security. This token must match in the Verification Check request to confirm phone number verification.
string
A stringified JSON object in which the keys are the template’s special variables and the values are the variables substitutions.

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: TWILIO_VERIFY_CREATE_VERIFICATION_CHECKchallenge a specific Verification Check.

Input Parameters

string
The phone number or email to verify. Either this parameter or the verification_sid must be specified. Phone numbers must be in E.164 format.
string
The 4-10 character string being verified.
string
The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
string
The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
string
required
The SID of the verification Service to create the resource under.
string
A sna client token received in sna url invocation response needs to be passed in Verification Check request and should match to get successful response.
string
A SID that uniquely identifies the Verification Check. Either this parameter or the to phone number/email must be specified.

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: TWILIO_VERIFY_CREATE_WEBHOOKCreate a new Webhook for the Service

Input Parameters

string ("enabled" | "disabled")
The webhook status. Default value is enabled. One of: enabled or disabled
string ("v1" | "v2")
The webhook version. Default value is v2 which includes all the latest fields. Version v1 is legacy and may be removed in the future.
array
required
The array of events that this Webhook is subscribed to. Possible event types: *, factor.deleted, factor.created, factor.verified, challenge.approved, challenge.denied
string
required
The unique SID identifier of the Service.
string
required
The URL associated with this Webhook.
string
required
The string that you assigned to describe the webhook. This value should not contain PII.

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: TWILIO_VERIFY_DELETE_BUCKETDelete a specific Bucket.

Input Parameters

string
required
A 34 character string that uniquely identifies this Bucket.
string
required
The SID of the Service the resource is associated with.
string
required
The Twilio-provided string that uniquely identifies the Rate Limit resource.

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: TWILIO_VERIFY_DELETE_ENTITYDelete a specific Entity.

Input Parameters

string
required
The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user’s UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
string
required
The unique SID identifier of the Service.

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: TWILIO_VERIFY_DELETE_FACTORDelete a specific Factor.

Input Parameters

string
required
A 34 character string that uniquely identifies this Factor.
string
required
Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user’s UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
string
required
The unique SID identifier of the Service.

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: TWILIO_VERIFY_DELETE_MESSAGING_CONFIGURATIONDelete a specific MessagingConfiguration.

Input Parameters

string
required
The ISO-3166-1 country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value all.
string
required
The SID of the Service that the resource is associated with.

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: TWILIO_VERIFY_DELETE_RATE_LIMITDelete a specific Rate Limit.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Rate Limit resource to fetch.
string
required
The SID of the Service the resource is associated with.

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: TWILIO_VERIFY_DELETE_SAFELISTRemove a phone number from SafeList.

Input Parameters

string
required
The phone number to be removed from SafeList. Phone numbers must be in E.164 format.

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: TWILIO_VERIFY_DELETE_SERVICEDelete a specific Verification Service Instance.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Verification Service resource 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: TWILIO_VERIFY_DELETE_WEBHOOKDelete a specific Webhook.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Webhook resource to delete.
string
required
The unique SID identifier of the Service.

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: TWILIO_VERIFY_FETCH_ACCESS_TOKENFetch an Access Token for the Entity

Input Parameters

string
required
A 34 character string that uniquely identifies this Access Token.
string
required
The unique SID identifier of the Service.

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: TWILIO_VERIFY_FETCH_BUCKETFetch a specific Bucket.

Input Parameters

string
required
A 34 character string that uniquely identifies this Bucket.
string
required
The SID of the Service the resource is associated with.
string
required
The Twilio-provided string that uniquely identifies the Rate Limit resource.

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: TWILIO_VERIFY_FETCH_CHALLENGEFetch a specific Challenge.

Input Parameters

string
required
A 34 character string that uniquely identifies this Challenge.
string
required
Customer unique identity for the Entity owner of the Challenges. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user’s UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
string
required
The unique SID identifier of the Service.

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: TWILIO_VERIFY_FETCH_ENTITYFetch a specific Entity.

Input Parameters

string
required
The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user’s UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
string
required
The unique SID identifier of the Service.

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: TWILIO_VERIFY_FETCH_FACTORFetch a specific Factor.

Input Parameters

string
required
A 34 character string that uniquely identifies this Factor.
string
required
Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user’s UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
string
required
The unique SID identifier of the Service.

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: TWILIO_VERIFY_FETCH_FORMFetch the forms for a specific Form Type.

Input Parameters

string
required
The Type of this Form. Currently only form-push is supported.

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: TWILIO_VERIFY_FETCH_MESSAGING_CONFIGURATIONFetch a specific MessagingConfiguration.

Input Parameters

string
required
The ISO-3166-1 country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value all.
string
required
The SID of the Service that the resource is associated with.

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: TWILIO_VERIFY_FETCH_RATE_LIMITFetch a specific Rate Limit.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Rate Limit resource to fetch.
string
required
The SID of the Service the resource is associated with.

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: TWILIO_VERIFY_FETCH_SAFELISTCheck if a phone number exists in SafeList.

Input Parameters

string
required
The phone number to be fetched from SafeList. Phone numbers must be in E.164 format.

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: TWILIO_VERIFY_FETCH_SERVICEFetch specific Verification Service Instance.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Verification Service resource to fetch.

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: TWILIO_VERIFY_FETCH_VERIFICATIONFetch a specific Verification

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Verification resource to fetch.
string
required
The SID of the verification Service to fetch the resource from.

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: TWILIO_VERIFY_FETCH_VERIFICATION_ATTEMPTFetch a specific verification attempt.

Input Parameters

string
required
The unique SID identifier of a Verification Attempt

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: TWILIO_VERIFY_FETCH_VERIFICATION_ATTEMPTS_SUMMARYGet a summary of how many attempts were made and how many were converted.

Input Parameters

string ("sms" | "call" | "email" | "whatsapp" | "rbm")
Filter Verification Attempts considered on the summary aggregation by communication channel.
string
Filter used to consider only Verification Attempts sent to the specified destination country on the summary aggregation.
string
Datetime filter used to consider only Verification Attempts created after this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd’T’HH:mm:ss’Z.
string
Filter the Verification Attempts considered on the summary aggregation by Destination prefix. It is the prefix of a phone number in E.164 format.
string
Filter used to consider only Verification Attempts of the given verify service on the summary aggregation.
string
Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd’T’HH:mm:ss’Z.

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: TWILIO_VERIFY_FETCH_WEBHOOKFetch a specific Webhook.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Webhook resource to fetch.
string
required
The unique SID identifier of the Service.

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: TWILIO_VERIFY_LIST_BUCKETRetrieve a list of all Buckets for a Rate Limit.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the Service the resource is associated with.
string
required
The Twilio-provided string that uniquely identifies the Rate Limit resource.

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: TWILIO_VERIFY_LIST_CHALLENGERetrieve a list of all Challenges for a Factor.

Input Parameters

integer
The page index. This value is simply for client state.
string ("asc" | "desc")
The desired sort order of the Challenges list. One of asc or desc for ascending and descending respectively. Defaults to asc.
string ("pending" | "expired" | "approved" | "denied")
The Status of the Challenges to fetch. One of pending, expired, approved or denied.
string
required
Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user’s UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The unique SID identifier of the Factor.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The unique SID identifier of the Service.

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: TWILIO_VERIFY_LIST_ENTITYRetrieve a list of all Entities for a Service.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The unique SID identifier of the Service.

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: TWILIO_VERIFY_LIST_FACTORRetrieve a list of all Factors for an Entity.

Input Parameters

integer
The page index. This value is simply for client state.
string
required
Customer unique identity for the Entity owner of the Factors. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user’s UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The unique SID identifier of the Service.

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: TWILIO_VERIFY_LIST_MESSAGING_CONFIGURATIONRetrieve a list of all Messaging Configurations for a Service.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the Service that the resource is associated with.

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: TWILIO_VERIFY_LIST_RATE_LIMITRetrieve a list of all Rate Limits for a service.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The SID of the Service the resource is associated with.

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: TWILIO_VERIFY_LIST_SERVICERetrieve a list of all Verification Services for an account.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.

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: TWILIO_VERIFY_LIST_VERIFICATION_ATTEMPTList all the verification attempts for a given Account.

Input Parameters

integer
The page index. This value is simply for client state.
string ("converted" | "unconverted")
Filter used to query Verification Attempts by conversion status. Valid values are UNCONVERTED, for attempts that were not converted, and CONVERTED, for attempts that were confirmed.
string ("sms" | "call" | "email" | "whatsapp" | "rbm")
Filter used to query Verification Attempts by communication channel.
string
Filter used to query Verification Attempts sent to the specified destination country.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
Destination of a verification. It is phone number in E.164 format.
string
Filter used to return all the Verification Attempts of a single verification. Only attempts of the provided verification SID will be returned.
string
Datetime filter used to consider only Verification Attempts created after this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd’T’HH:mm:ss’Z.
string
Filter used to query Verification Attempts by verify service. Only attempts of the provided SID will be returned.
string
Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd’T’HH:mm:ss’Z.

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: TWILIO_VERIFY_LIST_VERIFICATION_TEMPLATEList all the available templates for a given Account.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
String filter used to query templates with a given friendly 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: TWILIO_VERIFY_LIST_WEBHOOKRetrieve a list of all Webhooks for a Service.

Input Parameters

integer
The page index. This value is simply for client state.
integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
string
The page token. This is provided by the API.
string
Cursor returned by the previous call; resend required path fields with it.
string
required
The unique SID identifier of the Service.

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: TWILIO_VERIFY_UPDATE_BUCKETUpdate a specific Bucket.

Input Parameters

integer
Maximum number of requests permitted in during the interval.
string
required
A 34 character string that uniquely identifies this Bucket.
integer
Number of seconds that the rate limit will be enforced over.
string
required
The SID of the Service the resource is associated with.
string
required
The Twilio-provided string that uniquely identifies the Rate Limit resource.

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: TWILIO_VERIFY_UPDATE_CHALLENGEVerify a specific Challenge.

Input Parameters

string
required
A 34 character string that uniquely identifies this Challenge.
string
required
Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user’s UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
string
Custom metadata associated with the challenge. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. {"os": "Android"}. Can be up to 1024 characters in length.
string
required
The unique SID identifier of the Service.
string
The optional payload needed to verify the Challenge. E.g., a TOTP would use the numeric code. For TOTP this value must be between 3 and 8 characters long. For Push this value can be up to 5456 characters in length

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: TWILIO_VERIFY_UPDATE_CHALLENGE_PASSKEYSApprove a Passkeys challenge

Input Parameters

string
required
A base64url encoded representation of rawId.
string
The valid credential types supported by the API. The values of this enumeration are used for versioning the AuthenticatorAssertion and AuthenticatorAttestation structures according to the type of the authenticator.
string
required
The globally unique identifier for this PublicKeyCredential.
object
required
The result of a WebAuthn authentication via a navigator.credentials.get() request, as specified in AuthenticatorAttestationResponse.
string
required
The unique SID identifier of the Service.
string ("platform" | "cross-platform")
required
A string that indicates the mechanism by which the WebAuthn implementation is attached to the authenticator at the time the associated navigator.credentials.create() or navigator.credentials.get() call completes.

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: TWILIO_VERIFY_UPDATE_FACTORUpdate a specific Factor. This endpoint can be used to Verify a Factor if passed an AuthPayload param.

Input Parameters

string
required
A 34 character string that uniquely identifies this Factor.
string
required
Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user’s UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
string ("sha1" | "sha256" | "sha512")
Twilio Config.Alg request value.
integer
The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive
string
required
The unique SID identifier of the Service.
string
The optional payload needed to verify the Factor for the first time. E.g. for a TOTP, the numeric code.
string
The new friendly name of this Factor. It can be up to 64 characters.
integer
Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is generated every time_step seconds. Must be between 20 and 60 seconds, inclusive
integer
Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive
string
The Verify Push SDK version used to configure the factor
string
For APN, the device token. For FCM, the registration token. It is used to send the push notifications. Required when factor_type is push. If specified, this value must be between 32 and 255 characters long.
string
The transport technology used to generate the Notification Token. Can be apn, fcm or none. Required when factor_type is push.

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: TWILIO_VERIFY_UPDATE_MESSAGING_CONFIGURATIONUpdate a specific MessagingConfiguration

Input Parameters

string
required
The ISO-3166-1 country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value all.
string
required
The SID of the Service that the resource is associated with.
string
required
The SID of the Messaging Service to be used to send SMS to the country of this configuration.

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: TWILIO_VERIFY_UPDATE_PASSKEYS_FACTORVerify a Passkeys Factor

Input Parameters

string
A base64url encoded representation of rawId.
string
The valid credential types supported by the API. The values of this enumeration are used for versioning the AuthenticatorAssertion and AuthenticatorAttestation structures according to the type of the authenticator.
string
The globally unique identifier for this PublicKeyCredential.
object
required
The result of a WebAuthn credential registration via navigator.credentials.create(), as specified in AuthenticatorAttestationResponse.
string
required
The unique SID identifier of the Service.
string ("platform" | "cross-platform")
A string that indicates the mechanism by which the WebAuthn implementation is attached to the authenticator at the time the associated navigator.credentials.create() or navigator.credentials.get() call completes.

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: TWILIO_VERIFY_UPDATE_RATE_LIMITUpdate a specific Rate Limit.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Rate Limit resource to fetch.
string
Description of this Rate Limit
string
required
The SID of the Service the resource is associated with.

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: TWILIO_VERIFY_UPDATE_SERVICEUpdate a specific Verification Service.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Service resource to update.
string
The name of an alternative text-to-speech service to use in phone calls. Applies only to TTS languages.
integer
Optional configuration for the TOTP factors. The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive. Defaults to 1
integer
The length of the verification code to generate. Must be an integer value between 4 and 10, inclusive.
string
Optional configuration for the TOTP factors. Set TOTP Issuer for this service. This will allow to configure the issuer of the TOTP URI.
boolean
Whether to pass PSD2 transaction parameters when starting a verification.
string
A descriptive string that you create to describe the verification service. It can be up to 32 characters long. This value should not contain PII.
string
The WhatsApp number to use as the sender of the verification messages. This number must be associated with the WhatsApp Message Service.
boolean
Whether to perform a lookup with each verification started and return info about the phone number.
integer
Optional configuration for the TOTP factors. Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is generated every time_step seconds. Must be between 20 and 60 seconds, inclusive. Defaults to 30 seconds
integer
Optional configuration for the TOTP factors. Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive. Defaults to 6
boolean
Optional configuration for the Push factors. If true, include the date in the Challenge’s response. Otherwise, the date is omitted from the response. See Challenge resource’s details parameter for more info. Default: false. Deprecated do not use this parameter.
boolean
Whether to allow sending verifications with a custom code instead of a randomly generated one.
boolean
Whether to ask the user to press a number before delivering the verify code in a phone call.
string
The default message template. Will be used for all SMS verifications unless explicitly overriden. SMS channel only.
boolean
Whether to skip sending SMS verifications to landlines. Requires lookup_enabled.
string
Optional configuration for the Push factors. Set the APN Credential for this service. This will allow to send push notifications to iOS devices. See Credential Resource
string
Optional configuration for the Push factors. Set the FCM Credential for this service. This will allow to send push notifications to Android devices. See Credential Resource
string
The SID of the Messaging Service to associate with the Verification Service.
string
The Relying Party ID for Passkeys. This is the domain of your application, e.g. example.com. It is used to identify your application when creating Passkeys.
string
The User Verification for Passkeys. This is the type of user verification that will be used to create Passkeys. It can be empty or it can have the values required, preferred or discouraged.
string
The Relying Party Name for Passkeys. This is the name of your application, e.g. Example App. It is used to identify your application when creating Passkeys.
boolean
Whether to add a privacy warning at the end of an SMS. Disabled by default and applies only for SMS.
string
The Relying Party Origins for Passkeys. This is the origin of your application, e.g. login.example.com,www.example.com. It is used to identify your application when creating Passkeys, it can have multiple origins split by ,.
string
The Authenticator Attachment for Passkeys. This is the type of authenticator that will be used to create Passkeys. It can be empty or it can have the values platform, cross-platform or any.
string
Indicates whether credentials must be discoverable by the authenticator. It can be empty or it can have the values required, preferred or discouraged.
boolean
Whether to allow verifications from the service to reach the stream-events sinks if configured

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: TWILIO_VERIFY_UPDATE_VERIFICATIONUpdate a Verification status

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Verification resource to update.
string ("canceled" | "approved")
required
The status of the verification. Can be: pending, approved, canceled, max_attempts_reached, deleted, failed or expired.
string
required
The SID of the verification Service to update the resource from.

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: TWILIO_VERIFY_UPDATE_WEBHOOKUpdate Webhook using the Twilio verify_v2 REST API.

Input Parameters

string
required
The Twilio-provided string that uniquely identifies the Webhook resource to update.
string ("enabled" | "disabled")
The webhook status. Default value is enabled. One of: enabled or disabled
string ("v1" | "v2")
The webhook version. Default value is v2 which includes all the latest fields. Version v1 is legacy and may be removed in the future.
array
The array of events that this Webhook is subscribed to. Possible event types: *, factor.deleted, factor.created, factor.verified, challenge.approved, challenge.denied
string
required
The unique SID identifier of the Service.
string
The URL associated with this Webhook.
string
The string that you assigned to describe the webhook. This value should not contain PII.

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

Triggers

Slug: TWILIO_CALL_ANSWEREDType: webhookTriggers when a call is answered and goes in progress. Only fires for calls whose own API request, TwiML or phone-number configuration supplies a StatusCallback URL; Twilio publishes nothing for calls that do not.

Configuration

string
Only deliver events for calls in this direction: ‘inbound’, ‘outbound-api’ or ‘outbound-dial’. Leave unset for both.

Payload

object
The callback request Twilio made when this call event happened.
string
When Twilio made the callback request, in RFC 2822.
object
What the endpoint Twilio called answered with.
string
required
SID of the call this event is about (CA…). The only identifier present on every voice event — request.parameters.CallSid is absent on some.
string
When the event happened, in ISO 8601.
Slug: TWILIO_CALL_ANSWERING_MACHINE_DETECTEDType: webhookTriggers when Twilio’s Answering Machine Detection classifies who picked up a call — human, machine_start, fax or unknown. Only fires for calls created with machine detection enabled.

Payload

object
The callback request Twilio made when this call event happened.
string
When Twilio made the callback request, in RFC 2822.
object
What the endpoint Twilio called answered with.
string
required
SID of the call this event is about (CA…). The only identifier present on every voice event — request.parameters.CallSid is absent on some.
string
When the event happened, in ISO 8601.
Slug: TWILIO_CALL_COMPLETEDType: webhookTriggers when a call ends. Carries the final call status, duration, SIP response code and, for recorded calls, the recording SID and URL. Only fires for calls whose own API request, TwiML or phone-number configuration supplies a StatusCallback URL; Twilio publishes nothing for calls that do not.

Configuration

string
Only deliver events for calls in this direction: ‘inbound’, ‘outbound-api’ or ‘outbound-dial’. Leave unset for both.

Payload

object
The callback request Twilio made when this call event happened.
string
When Twilio made the callback request, in RFC 2822.
object
What the endpoint Twilio called answered with.
string
required
SID of the call this event is about (CA…). The only identifier present on every voice event — request.parameters.CallSid is absent on some.
string
When the event happened, in ISO 8601.
Slug: TWILIO_CALL_CREATED_VIA_APIType: webhookTriggers when an outbound call is created through the Twilio REST API. Records the API request that placed it, which is what an audit of who called whom is built on.

Payload

object
The callback request Twilio made when this call event happened.
string
When Twilio made the callback request, in RFC 2822.
object
What the endpoint Twilio called answered with.
string
required
SID of the call this event is about (CA…). The only identifier present on every voice event — request.parameters.CallSid is absent on some.
string
When the event happened, in ISO 8601.
Slug: TWILIO_CALL_INITIATEDType: webhookTriggers when Twilio begins placing or answering a call. Only fires for calls whose own API request, TwiML or phone-number configuration supplies a StatusCallback URL; Twilio publishes nothing for calls that do not.

Configuration

string
Only deliver events for calls in this direction: ‘inbound’, ‘outbound-api’ or ‘outbound-dial’. Leave unset for both.

Payload

object
The callback request Twilio made when this call event happened.
string
When Twilio made the callback request, in RFC 2822.
object
What the endpoint Twilio called answered with.
string
required
SID of the call this event is about (CA…). The only identifier present on every voice event — request.parameters.CallSid is absent on some.
string
When the event happened, in ISO 8601.
Slug: TWILIO_CALL_MODIFIED_VIA_APIType: webhookTriggers when a live call is redirected or hung up through the Twilio REST API.

Payload

object
The callback request Twilio made when this call event happened.
string
When Twilio made the callback request, in RFC 2822.
object
What the endpoint Twilio called answered with.
string
required
SID of the call this event is about (CA…). The only identifier present on every voice event — request.parameters.CallSid is absent on some.
string
When the event happened, in ISO 8601.
Slug: TWILIO_CALL_QUALITY_METRICS_RECEIVEDType: webhookTriggers when Voice Insights publishes network-quality metrics — jitter, packet loss, MOS, codec — for one leg of a call. edge says which leg. High volume: Twilio samples every ten seconds, so a single call produces several.

Payload

string
required
SID of the Twilio account.
string
required
SID of the call these metrics belong to (CA…).
object
Metrics and metadata for one media edge of the call.
object
Metrics and metadata for one media edge of the call.
string
required
Direction of the media stream from Twilio’s point of view: inbound or outbound.
string
required
Which leg the sample came from: carrier_edge, sip_edge, client_edge or sdk_edge.
object
Metrics and metadata for one media edge of the call.
object
Metrics and metadata for one media edge of the call.
string
required
When the sample was taken, in ISO 8601. Twilio samples every ten seconds.
Slug: TWILIO_CALL_RECORDING_READYType: webhookTriggers when a call recording finishes processing and its media URL can be fetched. Only fires for calls created with a recording status callback.

Payload

object
The callback request Twilio made when this call event happened.
string
When Twilio made the callback request, in RFC 2822.
object
What the endpoint Twilio called answered with.
string
required
SID of the call this event is about (CA…). The only identifier present on every voice event — request.parameters.CallSid is absent on some.
string
When the event happened, in ISO 8601.
Slug: TWILIO_CALL_RINGINGType: webhookTriggers when the far end of a call starts ringing. Only fires for calls whose own API request, TwiML or phone-number configuration supplies a StatusCallback URL; Twilio publishes nothing for calls that do not.

Configuration

string
Only deliver events for calls in this direction: ‘inbound’, ‘outbound-api’ or ‘outbound-dial’. Leave unset for both.

Payload

object
The callback request Twilio made when this call event happened.
string
When Twilio made the callback request, in RFC 2822.
object
What the endpoint Twilio called answered with.
string
required
SID of the call this event is about (CA…). The only identifier present on every voice event — request.parameters.CallSid is absent on some.
string
When the event happened, in ISO 8601.
Slug: TWILIO_CONVERSATION_CREATEDType: webhookTriggers when a new Conversation is created on the account.

Payload

string
SID of the Twilio account.
object
Your own JSON attributes, as stored on the resource.
string
Display name of whoever opened the conversation.
object
Per-channel addressing configured on the conversation.
string
SID of the conversation (CH…).
string
When the conversation was created, in ISO 8601.
string
Human-readable name of the conversation.
array
Media attached to the message that opened the conversation.
string
Body of the message that opened the conversation.
string
Subject of the message that opened the conversation.
object
How a participant is reached on their channel.
string
SID of the Messaging Service the conversation sends through (MG…).
string
Conversation state: active, inactive or closed.
string
Your own unique key for the conversation.
Slug: TWILIO_CONVERSATION_MESSAGE_ADDEDType: webhookTriggers when a message is posted into a Conversation, by a participant or through the API.

Payload

string
SID of the Twilio account.
object
Your own JSON attributes, as stored on the resource.
string
Identity of whoever wrote the message.
string
SID of the Content template the message was rendered from (HX…).
string
SID of the conversation it was posted into (CH…).
string
When the message was posted, in ISO 8601.
integer
Position of the message in the conversation, counting from zero.
array
Media files attached to the message.
string
Text of the message.
string
SID of the message (IM…).
string
Subject line, on channels that carry one.
string
SID of the Messaging Service the message went through (MG…).
string
SID of the participant who posted it (MB…).
Slug: TWILIO_CONVERSATION_MESSAGE_REMOVEDType: webhookTriggers when a Conversation message is deleted.

Payload

string
SID of the Twilio account.
object
Your own JSON attributes, as stored on the resource.
string
Identity of whoever wrote the message.
string
SID of the conversation it belonged to (CH…).
string
When the message was posted, in ISO 8601.
string
When the message was deleted, in ISO 8601.
string
When the message was last edited, in ISO 8601.
integer
Position the message held in the conversation.
array
Media files that were attached to the message.
string
Text of the deleted message.
string
SID of the message (IM…).
string
Subject line, on channels that carry one.
string
SID of the participant who posted it (MB…).
Slug: TWILIO_CONVERSATION_MESSAGE_UPDATEDType: webhookTriggers when a Conversation message’s body, media or attributes are edited.

Payload

string
SID of the Twilio account.
object
Your own JSON attributes, as stored on the resource.
string
Identity of whoever wrote the message.
string
SID of the conversation it belongs to (CH…).
string
When the message was posted, in ISO 8601.
string
When the message was edited, in ISO 8601.
integer
Position of the message in the conversation, counting from zero.
array
Media files attached to the message.
string
Text of the message after the edit.
string
SID of the message (IM…).
string
Subject line, on channels that carry one.
string
SID of the participant who posted it (MB…).
Slug: TWILIO_CONVERSATION_PARTICIPANT_ADDEDType: webhookTriggers when a participant joins a Conversation.

Payload

string
SID of the Twilio account.
object
Your own JSON attributes, as stored on the resource.
string
SID of the conversation they joined (CH…).
string
When they joined, in ISO 8601.
string
Chat identity of the participant, for participants that have one.
object
How a participant is reached on their channel.
string
SID of the participant (MB…).
string
SID of the role they hold in the conversation (RL…).
Slug: TWILIO_CONVERSATION_PARTICIPANT_REMOVEDType: webhookTriggers when a participant leaves or is removed from a Conversation.

Payload

string
SID of the Twilio account.
object
Your own JSON attributes, as stored on the resource.
string
SID of the conversation they left (CH…).
string
When they joined, in ISO 8601.
string
When they left, in ISO 8601.
string
When they were last changed, in ISO 8601.
string
Chat identity of the participant, for participants that had one.
object
How a participant is reached on their channel.
string
SID of the participant (MB…).
string
SID of the role they held (RL…).
Slug: TWILIO_CONVERSATION_PARTICIPANT_UPDATEDType: webhookTriggers when a participant’s attributes or role in a Conversation change.

Payload

string
SID of the Twilio account.
object
Your own JSON attributes, as stored on the resource.
string
SID of the conversation (CH…).
string
When they joined, in ISO 8601.
string
When they were last changed, in ISO 8601.
string
Chat identity of the participant, for participants that have one.
object
How a participant is reached on their channel.
string
SID of the participant (MB…).
string
SID of the role they hold now (RL…).
Slug: TWILIO_CONVERSATION_REMOVEDType: webhookTriggers when a Conversation is deleted.

Payload

string
SID of the Twilio account.
object
Your own JSON attributes, as stored on the resource.
string
SID of the conversation (CH…).
string
When the conversation was created, in ISO 8601.
string
When the conversation was deleted, in ISO 8601.
string
When the conversation was last changed, in ISO 8601.
string
Human-readable name of the conversation.
string
SID of the Messaging Service the conversation sent through (MG…).
string
State the conversation was in when it was deleted.
string
Your own unique key for the conversation.
Slug: TWILIO_CONVERSATION_STATE_CHANGEDType: webhookTriggers when a Conversation moves between active, inactive and closed. Carries the state it came from, the state it is in now and the reason — a transition rather than the snapshot Conversation Updated carries.

Payload

string
SID of the Twilio account.
string
SID of the conversation (CH…).
string
SID of the Messaging Service the conversation sends through (MG…).
string
Why the state changed, e.g. a timer elapsing or an API call.
string
State the conversation was in before the change.
string
State the conversation is in now.
string
When the state changed, in ISO 8601.
Slug: TWILIO_CONVERSATION_UPDATEDType: webhookTriggers when a Conversation’s friendly name, attributes or state are changed. For the state transition on its own, use Conversation State Changed.

Payload

string
SID of the Twilio account.
object
Your own JSON attributes, as stored on the resource.
string
SID of the conversation (CH…).
string
When the conversation was created, in ISO 8601.
string
When the conversation was last changed, in ISO 8601.
string
Human-readable name of the conversation.
string
SID of the Messaging Service the conversation sends through (MG…).
string
Conversation state: active, inactive or closed.
string
Your own unique key for the conversation.
Slug: TWILIO_CONVERSATION_USER_CREATEDType: webhookTriggers when a Conversations user identity is created on the account.

Payload

string
SID of the Twilio account.
object
Your own JSON attributes, as stored on the resource.
string
When the user was created, in ISO 8601.
string
Display name of the user.
string
The identity string that names this user in Conversations.
string
SID of the service-level role they hold (RL…).
string
SID of the user (US…).
Slug: TWILIO_CONVERSATION_USER_UPDATEDType: webhookTriggers when a Conversations user’s friendly name, role or online state change.

Payload

string
SID of the Twilio account.
object
Your own JSON attributes, as stored on the resource.
string
When the user was created, in ISO 8601.
string
When the user was last changed, in ISO 8601.
string
Display name of the user.
string
The identity string that names this user in Conversations.
boolean
Whether push notifications can be delivered to the user.
boolean
Whether the user has a live Conversations connection.
string
SID of the service-level role they hold (RL…).
string
SID of the user (US…).
Slug: TWILIO_ERROR_LOGGEDType: webhookTriggers when Twilio writes an entry to the account’s error log — the feed behind the Console Debugger. Undeliverable messages, failed TwiML fetches and Twilio’s own failures to deliver these webhooks all land here. Despite the name it is not errors-only: INFO entries arrive too and carry no error code, so set the level filter to ‘ERROR’ if you only want failures.

Configuration

string
Only deliver logs at this severity: ‘ERROR’, ‘WARNING’ or ‘NOTICE’. Leave unset for all.
string
Only deliver errors from this Twilio product, exactly as Twilio labels it - e.g. ‘Programmable Messaging’, ‘Programmable Voice’, ‘Event Streams’. Leave unset for all.

Payload

string
required
SID of the Twilio account the entry belongs to.
string
SID of the resource the entry is about — for an Event Streams delivery failure this is the sink’s own SID.
string
required
When Twilio logged the entry, in ISO 8601.
string
Twilio error code, as a string. Absent on entries that are not errors.
string
Severity of the entry: ERROR, WARNING or NOTICE. INFO entries also appear on this stream.
string
SID of the parent account, when the entry is on a subaccount.
string
The entry’s own detail, as the JSON string Twilio logged — the error code and message, plus whatever context that product records.
string
The Twilio product that logged the entry, e.g. Messaging, Studio, Event Streams.
string
SID of the request that produced the entry (RQ…).
string
SID of the service the entry came from, for products that have services.
string
required
SID of the log entry (NO…).
Slug: TWILIO_MESSAGE_DELIVEREDType: webhookTriggers when the carrier confirms an outbound message reached the handset.

Configuration

string
Only deliver status events for messages sent FROM this Twilio number, in E.164 (e.g. ‘+18312727498’). Leave unset for every number on the account.

Payload

string
required
SID of the Twilio account that sent the message.
string
required
The Twilio API version the message was sent with.
string
Text of the message. Twilio omits it on most status events.
string
When the message resource was last updated, in ISO 8601.
integer
Twilio error code explaining a FAILED or UNDELIVERED status.
string
required
Twilio’s own name for this event, e.g. com.twilio.messaging.message.delivered.
string
Identifier for the recipient in the channel’s own system, e.g. a WhatsApp BSUID.
string
required
The Twilio number, short code or channel address the message was sent from.
string
Mobile Country Code of the sending number’s carrier.
string
required
SID of the message this status belongs to (SM… or MM…).
string
required
The status reached: QUEUED, SENT, DELIVERED, READ, FAILED or UNDELIVERED.
string
SID of the Messaging Service the message was sent through (MG…), when one was used.
string
Mobile Network Code of the sending number’s carrier.
integer
How many SMS segments the message was split into.
string
Identifier for the recipient’s parent entity in the channel’s own system, e.g. a WhatsApp parent BSUID.
string
Carrier delivery-receipt timestamp, in the carrier’s own YYMMDDHHMM form. Present on DELIVERED and carrier-rejected statuses.
string
The status callback URL configured on the message, if any.
object
Your own key-value tags, as set on the message.
string
required
When the status transition happened, in ISO 8601.
string
required
The number or channel address the message was sent to.
Slug: TWILIO_MESSAGE_DELIVERY_FAILEDType: webhookTriggers when an outbound message does not reach the recipient. Covers both Twilio-side failure and carrier rejection; message_status says which and error_code says why.

Configuration

string
Only deliver status events for messages sent FROM this Twilio number, in E.164 (e.g. ‘+18312727498’). Leave unset for every number on the account.

Payload

string
required
SID of the Twilio account that sent the message.
string
required
The Twilio API version the message was sent with.
string
Text of the message. Twilio omits it on most status events.
string
When the message resource was last updated, in ISO 8601.
integer
Twilio error code explaining a FAILED or UNDELIVERED status.
string
required
Twilio’s own name for this event, e.g. com.twilio.messaging.message.delivered.
string
Identifier for the recipient in the channel’s own system, e.g. a WhatsApp BSUID.
string
required
The Twilio number, short code or channel address the message was sent from.
string
Mobile Country Code of the sending number’s carrier.
string
required
SID of the message this status belongs to (SM… or MM…).
string
required
The status reached: QUEUED, SENT, DELIVERED, READ, FAILED or UNDELIVERED.
string
SID of the Messaging Service the message was sent through (MG…), when one was used.
string
Mobile Network Code of the sending number’s carrier.
integer
How many SMS segments the message was split into.
string
Identifier for the recipient’s parent entity in the channel’s own system, e.g. a WhatsApp parent BSUID.
string
Carrier delivery-receipt timestamp, in the carrier’s own YYMMDDHHMM form. Present on DELIVERED and carrier-rejected statuses.
string
The status callback URL configured on the message, if any.
object
Your own key-value tags, as set on the message.
string
required
When the status transition happened, in ISO 8601.
string
required
The number or channel address the message was sent to.
Slug: TWILIO_MESSAGE_QUEUEDType: webhookTriggers when an outbound message is accepted by Twilio and queued for sending.

Configuration

string
Only deliver status events for messages sent FROM this Twilio number, in E.164 (e.g. ‘+18312727498’). Leave unset for every number on the account.

Payload

string
required
SID of the Twilio account that sent the message.
string
required
The Twilio API version the message was sent with.
string
Text of the message. Twilio omits it on most status events.
string
When the message resource was last updated, in ISO 8601.
integer
Twilio error code explaining a FAILED or UNDELIVERED status.
string
required
Twilio’s own name for this event, e.g. com.twilio.messaging.message.delivered.
string
Identifier for the recipient in the channel’s own system, e.g. a WhatsApp BSUID.
string
required
The Twilio number, short code or channel address the message was sent from.
string
Mobile Country Code of the sending number’s carrier.
string
required
SID of the message this status belongs to (SM… or MM…).
string
required
The status reached: QUEUED, SENT, DELIVERED, READ, FAILED or UNDELIVERED.
string
SID of the Messaging Service the message was sent through (MG…), when one was used.
string
Mobile Network Code of the sending number’s carrier.
integer
How many SMS segments the message was split into.
string
Identifier for the recipient’s parent entity in the channel’s own system, e.g. a WhatsApp parent BSUID.
string
Carrier delivery-receipt timestamp, in the carrier’s own YYMMDDHHMM form. Present on DELIVERED and carrier-rejected statuses.
string
The status callback URL configured on the message, if any.
object
Your own key-value tags, as set on the message.
string
required
When the status transition happened, in ISO 8601.
string
required
The number or channel address the message was sent to.
Slug: TWILIO_MESSAGE_READType: webhookTriggers when the recipient opens an outbound message. Only channels that report read receipts fire this — WhatsApp and RCS; SMS never does.

Configuration

string
Only deliver status events for messages sent FROM this Twilio number, in E.164 (e.g. ‘+18312727498’). Leave unset for every number on the account.

Payload

string
required
SID of the Twilio account that sent the message.
string
required
The Twilio API version the message was sent with.
string
Text of the message. Twilio omits it on most status events.
string
When the message resource was last updated, in ISO 8601.
integer
Twilio error code explaining a FAILED or UNDELIVERED status.
string
required
Twilio’s own name for this event, e.g. com.twilio.messaging.message.delivered.
string
Identifier for the recipient in the channel’s own system, e.g. a WhatsApp BSUID.
string
required
The Twilio number, short code or channel address the message was sent from.
string
Mobile Country Code of the sending number’s carrier.
string
required
SID of the message this status belongs to (SM… or MM…).
string
required
The status reached: QUEUED, SENT, DELIVERED, READ, FAILED or UNDELIVERED.
string
SID of the Messaging Service the message was sent through (MG…), when one was used.
string
Mobile Network Code of the sending number’s carrier.
integer
How many SMS segments the message was split into.
string
Identifier for the recipient’s parent entity in the channel’s own system, e.g. a WhatsApp parent BSUID.
string
Carrier delivery-receipt timestamp, in the carrier’s own YYMMDDHHMM form. Present on DELIVERED and carrier-rejected statuses.
string
The status callback URL configured on the message, if any.
object
Your own key-value tags, as set on the message.
string
required
When the status transition happened, in ISO 8601.
string
required
The number or channel address the message was sent to.
Slug: TWILIO_MESSAGE_RECEIVEDType: webhookTriggers when an SMS, MMS or WhatsApp message arrives on one of the account’s Twilio numbers. Carries the message body, both numbers, the media count and the sender’s geography.

Configuration

string
Only deliver messages addressed to this Twilio number, in E.164 (e.g. ‘+18312727498’). For WhatsApp use the ‘whatsapp:+1831…’ form. Leave unset to receive messages on every number on the account.

Payload

string
required
SID of the Twilio account that received the message.
string
Text of the message.
string
required
Twilio’s own name for this event, com.twilio.messaging.inbound-message.received.
string
Identifier for the sender in the channel’s own system, e.g. a WhatsApp BSUID.
string
required
The sender’s number or channel address, e.g. +18312727498 or whatsapp:+18312727498.
string
City Twilio resolved for the sender’s number.
string
ISO country code Twilio resolved for the sender’s number.
string
State or province Twilio resolved for the sender’s number.
string
Postal code Twilio resolved for the sender’s number.
string
Mobile Country Code of the sender’s carrier.
string
required
SID of the inbound message (SM… or MM…).
string
SID of the Messaging Service the receiving number belongs to (MG…), when it belongs to one.
string
Mobile Network Code of the sender’s carrier.
integer
How many media attachments the message carries.
integer
How many SMS segments the message arrived in.
string
Set when the message is an opt-out keyword, e.g. STOP.
string
Identifier for the sender’s parent entity in the channel’s own system, e.g. a WhatsApp parent BSUID.
array
Every recipient of a group MMS.
string
Click ID of the WhatsApp advertisement the sender came from.
string
required
When the message arrived, in ISO 8601.
string
required
The Twilio number or channel address the message arrived on.
string
City Twilio resolved for the receiving number.
string
ISO country code Twilio resolved for the receiving number.
string
State or province Twilio resolved for the receiving number.
string
Postal code Twilio resolved for the receiving number.
string
The sender’s WhatsApp profile name or handle.
Slug: TWILIO_MESSAGE_SENTType: webhookTriggers when an outbound message leaves Twilio and is handed to the carrier.

Configuration

string
Only deliver status events for messages sent FROM this Twilio number, in E.164 (e.g. ‘+18312727498’). Leave unset for every number on the account.

Payload

string
required
SID of the Twilio account that sent the message.
string
required
The Twilio API version the message was sent with.
string
Text of the message. Twilio omits it on most status events.
string
When the message resource was last updated, in ISO 8601.
integer
Twilio error code explaining a FAILED or UNDELIVERED status.
string
required
Twilio’s own name for this event, e.g. com.twilio.messaging.message.delivered.
string
Identifier for the recipient in the channel’s own system, e.g. a WhatsApp BSUID.
string
required
The Twilio number, short code or channel address the message was sent from.
string
Mobile Country Code of the sending number’s carrier.
string
required
SID of the message this status belongs to (SM… or MM…).
string
required
The status reached: QUEUED, SENT, DELIVERED, READ, FAILED or UNDELIVERED.
string
SID of the Messaging Service the message was sent through (MG…), when one was used.
string
Mobile Network Code of the sending number’s carrier.
integer
How many SMS segments the message was split into.
string
Identifier for the recipient’s parent entity in the channel’s own system, e.g. a WhatsApp parent BSUID.
string
Carrier delivery-receipt timestamp, in the carrier’s own YYMMDDHHMM form. Present on DELIVERED and carrier-rejected statuses.
string
The status callback URL configured on the message, if any.
object
Your own key-value tags, as set on the message.
string
required
When the status transition happened, in ISO 8601.
string
required
The number or channel address the message was sent to.
Slug: TWILIO_STUDIO_FLOW_EXECUTION_ENDEDType: webhookTriggers when a Studio Flow execution finishes; ended_reason says whether it completed or was ended early.

Configuration

string
Only deliver events for this Studio Flow (FW…). Leave unset for every flow on the account. No Composio action lists Twilio Studio flows yet; read it from GET https://studio.twilio.com/v2/Flows.

Payload

string
required
SID of the Twilio account the flow belongs to.
string
required
The contact’s address on the channel that entered the flow, e.g. their phone number.
string
required
When the execution started, in ISO 8601.
string
When the execution last changed, in ISO 8601.
string
Why the execution ended, when it has ended.
string
required
SID of this flow execution (FN…).
integer
required
Revision of the flow this execution is running.
string
required
SID of the Studio Flow being run (FW…).
string
required
SID of the request or resource that started the execution.
string
required
Where the execution stands: active or ended.
Slug: TWILIO_STUDIO_FLOW_EXECUTION_STARTEDType: webhookTriggers when a Studio Flow execution begins for a contact.

Configuration

string
Only deliver events for this Studio Flow (FW…). Leave unset for every flow on the account. No Composio action lists Twilio Studio flows yet; read it from GET https://studio.twilio.com/v2/Flows.

Payload

string
required
SID of the Twilio account the flow belongs to.
string
required
The contact’s address on the channel that entered the flow, e.g. their phone number.
string
required
When the execution started, in ISO 8601.
string
When the execution last changed, in ISO 8601.
string
Why the execution ended, when it has ended.
string
required
SID of this flow execution (FN…).
integer
required
Revision of the flow this execution is running.
string
required
SID of the Studio Flow being run (FW…).
string
required
SID of the request or resource that started the execution.
string
required
Where the execution stands: active or ended.
Slug: TWILIO_STUDIO_FLOW_STEP_ENDEDType: webhookTriggers when a single widget in a Studio Flow finishes, naming the widget and the transition it took. High volume: one event per widget per execution.

Configuration

string
Only deliver events for this Studio Flow (FW…). Leave unset for every flow on the account. No Composio action lists Twilio Studio flows yet; read it from GET https://studio.twilio.com/v2/Flows.

Payload

string
required
SID of the Twilio account the flow belongs to.
string
required
When the step finished, in ISO 8601.
string
required
SID of the flow execution this step belongs to (FN…).
string
required
SID of the Studio Flow being run (FW…).
string
required
Name of the widget that just finished.
string
SID of the step that led to this one (FT…).
string
required
SID of this step (FT…).
string
required
Widget the flow came from.
string
required
Widget the flow moved to next.
Slug: TWILIO_TASKROUTER_API_RATE_LIMIT_EVALUATEDType: webhookTriggers when Twilio evaluates a TaskRouter API rate limit. Very high volume by default — roughly one event per TaskRouter API call, throttled or not — so set the rate_limited filter to true unless you want the raw usage stream.

Configuration

boolean
Set true to receive only the evaluations where Twilio actually throttled the request. Leave unset and you receive one event for every rate-limit evaluation, throttled or not - which is roughly one per TaskRouter API call.

Payload

string
required
SID of the Twilio account that made the request.
number
required
Measured request rate at the moment of evaluation.
boolean
Whether the ceiling is Twilio’s default rather than one raised for your account.
string
required
What the limit is counted against — the account SID for account-scoped limits.
string
required
The Twilio product the limit belongs to, e.g. taskrouter.
integer
required
The configured ceiling, in requests per second.
boolean
Whether Twilio actually throttled this request.
string
required
SID of the API request that was evaluated (RQ…).
string
required
Which API operation the limit applies to, e.g. Workspace-Read.
string
required
When the evaluation happened, in ISO 8601.
Slug: TWILIO_TASKROUTER_RESERVATION_ACCEPTEDType: webhookTriggers when a worker accepts an offered task.

Configuration

string
Only deliver events from this TaskRouter Workspace (WS…). An account may run several (e.g. production and staging). Leave unset for all of them. No Composio action lists Twilio TaskRouter workspaces yet; read it from GET https://taskrouter.twilio.com/v1/Workspaces.

Payload

string
Friendly name of the Twilio account.
string
required
SID of the Twilio account the workspace belongs to.
string
required
Which family of TaskRouter object the event belongs to, e.g. task, worker, task-queue.
string
required
Severity TaskRouter logged the event at, e.g. INFO or WARNING.
string
required
Twilio’s name for the event class, e.g. TasksCreated.
string
SID of the parent account, when this is a subaccount.
string
Friendly name of the parent account, when this is a subaccount.
object
required
The event’s own detail — which task, worker, queue or workflow changed and how.
string
required
Content type of payload, always application/json.
string
required
The Twilio product that emitted the event — always TaskRouter.
string
required
Who published the event; the workspace’s own name for workspace events.
string
Extra publisher detail TaskRouter attaches, as a JSON string.
string
required
SID of this TaskRouter event record (EV…).
string
required
When the event happened, in ISO 8601.
Slug: TWILIO_TASKROUTER_RESERVATION_CREATEDType: webhookTriggers when a task is offered to a worker. This is the event a contact-centre automation acts on to put work in front of an agent.

Configuration

string
Only deliver events from this TaskRouter Workspace (WS…). An account may run several (e.g. production and staging). Leave unset for all of them. No Composio action lists Twilio TaskRouter workspaces yet; read it from GET https://taskrouter.twilio.com/v1/Workspaces.

Payload

string
Friendly name of the Twilio account.
string
required
SID of the Twilio account the workspace belongs to.
string
required
Which family of TaskRouter object the event belongs to, e.g. task, worker, task-queue.
string
required
Severity TaskRouter logged the event at, e.g. INFO or WARNING.
string
required
Twilio’s name for the event class, e.g. TasksCreated.
string
SID of the parent account, when this is a subaccount.
string
Friendly name of the parent account, when this is a subaccount.
object
required
The event’s own detail — which task, worker, queue or workflow changed and how.
string
required
Content type of payload, always application/json.
string
required
The Twilio product that emitted the event — always TaskRouter.
string
required
Who published the event; the workspace’s own name for workspace events.
string
Extra publisher detail TaskRouter attaches, as a JSON string.
string
required
SID of this TaskRouter event record (EV…).
string
required
When the event happened, in ISO 8601.
Slug: TWILIO_TASKROUTER_TASK_COMPLETEDType: webhookTriggers when a task is completed; payload.task_completed_reason carries the wrap-up reason.

Configuration

string
Only deliver events from this TaskRouter Workspace (WS…). An account may run several (e.g. production and staging). Leave unset for all of them. No Composio action lists Twilio TaskRouter workspaces yet; read it from GET https://taskrouter.twilio.com/v1/Workspaces.

Payload

string
Friendly name of the Twilio account.
string
required
SID of the Twilio account the workspace belongs to.
string
required
Which family of TaskRouter object the event belongs to, e.g. task, worker, task-queue.
string
required
Severity TaskRouter logged the event at, e.g. INFO or WARNING.
string
required
Twilio’s name for the event class, e.g. TasksCreated.
string
SID of the parent account, when this is a subaccount.
string
Friendly name of the parent account, when this is a subaccount.
object
required
The event’s own detail — which task, worker, queue or workflow changed and how.
string
required
Content type of payload, always application/json.
string
required
The Twilio product that emitted the event — always TaskRouter.
string
required
Who published the event; the workspace’s own name for workspace events.
string
Extra publisher detail TaskRouter attaches, as a JSON string.
string
required
SID of this TaskRouter event record (EV…).
string
required
When the event happened, in ISO 8601.
Slug: TWILIO_TASKROUTER_TASK_CREATEDType: webhookTriggers when a new TaskRouter task enters a workflow.

Configuration

string
Only deliver events from this TaskRouter Workspace (WS…). An account may run several (e.g. production and staging). Leave unset for all of them. No Composio action lists Twilio TaskRouter workspaces yet; read it from GET https://taskrouter.twilio.com/v1/Workspaces.

Payload

string
Friendly name of the Twilio account.
string
required
SID of the Twilio account the workspace belongs to.
string
required
Which family of TaskRouter object the event belongs to, e.g. task, worker, task-queue.
string
required
Severity TaskRouter logged the event at, e.g. INFO or WARNING.
string
required
Twilio’s name for the event class, e.g. TasksCreated.
string
SID of the parent account, when this is a subaccount.
string
Friendly name of the parent account, when this is a subaccount.
object
required
The event’s own detail — which task, worker, queue or workflow changed and how.
string
required
Content type of payload, always application/json.
string
required
The Twilio product that emitted the event — always TaskRouter.
string
required
Who published the event; the workspace’s own name for workspace events.
string
Extra publisher detail TaskRouter attaches, as a JSON string.
string
required
SID of this TaskRouter event record (EV…).
string
required
When the event happened, in ISO 8601.
Slug: TWILIO_VERIFICATION_APPROVEDType: webhookTriggers when the end user enters the correct verification code.

Configuration

string
Only deliver events for this Verify Service (VA…). Leave unset for every Verify service on the account. No Composio action lists Twilio Verify services yet; read it from GET https://verify.twilio.com/v2/Services.

Payload

string
required
SID of the Twilio account the service belongs to.
object
required
Every attempt the end user made at entering the code.
integer
How many digits the code has.
string
required
ISO 3166-1 alpha-2 country code of the destination.
string
required
When the verification was started, in ISO 8601.
boolean
required
Whether the service lets you supply your own code instead of a generated one.
string
Your own override for the service name shown to the end user.
string
When the verification expires, in ISO 8601.
string
required
Name of the Verify Service, as shown to the end user.
object
required
Every attempt Verify made at delivering the code.
string
required
SID of the Verify Service that issued it (VA…).
string
required
Who is being verified — a phone number in E.164, or the address on whichever channel was used.
string
required
SID of the verification (VE…).
string
required
Where the verification stands: PENDING, APPROVED, EXPIRED, CANCELED or MAX_ATTEMPTS_REACHED.
string
When the correct code was entered, in ISO 8601.
Slug: TWILIO_VERIFICATION_CANCELEDType: webhookTriggers when a verification is canceled through the API.

Configuration

string
Only deliver events for this Verify Service (VA…). Leave unset for every Verify service on the account. No Composio action lists Twilio Verify services yet; read it from GET https://verify.twilio.com/v2/Services.

Payload

string
required
SID of the Twilio account the service belongs to.
object
required
Every attempt the end user made at entering the code.
integer
How many digits the code has.
string
required
ISO 3166-1 alpha-2 country code of the destination.
string
required
When the verification was started, in ISO 8601.
boolean
required
Whether the service lets you supply your own code instead of a generated one.
string
Your own override for the service name shown to the end user.
string
When the verification expires, in ISO 8601.
string
required
Name of the Verify Service, as shown to the end user.
object
required
Every attempt Verify made at delivering the code.
string
required
SID of the Verify Service that issued it (VA…).
string
required
Who is being verified — a phone number in E.164, or the address on whichever channel was used.
string
required
SID of the verification (VE…).
string
required
Where the verification stands: PENDING, APPROVED, EXPIRED, CANCELED or MAX_ATTEMPTS_REACHED.
string
When the correct code was entered, in ISO 8601.
Slug: TWILIO_VERIFICATION_EXPIREDType: webhookTriggers when a verification expires before the user enters the code.

Configuration

string
Only deliver events for this Verify Service (VA…). Leave unset for every Verify service on the account. No Composio action lists Twilio Verify services yet; read it from GET https://verify.twilio.com/v2/Services.

Payload

string
required
SID of the Twilio account the service belongs to.
object
required
Every attempt the end user made at entering the code.
integer
How many digits the code has.
string
required
ISO 3166-1 alpha-2 country code of the destination.
string
required
When the verification was started, in ISO 8601.
boolean
required
Whether the service lets you supply your own code instead of a generated one.
string
Your own override for the service name shown to the end user.
string
When the verification expires, in ISO 8601.
string
required
Name of the Verify Service, as shown to the end user.
object
required
Every attempt Verify made at delivering the code.
string
required
SID of the Verify Service that issued it (VA…).
string
required
Who is being verified — a phone number in E.164, or the address on whichever channel was used.
string
required
SID of the verification (VE…).
string
required
Where the verification stands: PENDING, APPROVED, EXPIRED, CANCELED or MAX_ATTEMPTS_REACHED.
string
When the correct code was entered, in ISO 8601.
Slug: TWILIO_VERIFICATION_MAX_ATTEMPTS_REACHEDType: webhookTriggers when a verification hits its maximum check attempts — the fraud and abuse signal.

Configuration

string
Only deliver events for this Verify Service (VA…). Leave unset for every Verify service on the account. No Composio action lists Twilio Verify services yet; read it from GET https://verify.twilio.com/v2/Services.

Payload

string
required
SID of the Twilio account the service belongs to.
object
required
Every attempt the end user made at entering the code.
integer
How many digits the code has.
string
required
ISO 3166-1 alpha-2 country code of the destination.
string
required
When the verification was started, in ISO 8601.
boolean
required
Whether the service lets you supply your own code instead of a generated one.
string
Your own override for the service name shown to the end user.
string
When the verification expires, in ISO 8601.
string
required
Name of the Verify Service, as shown to the end user.
object
required
Every attempt Verify made at delivering the code.
string
required
SID of the Verify Service that issued it (VA…).
string
required
Who is being verified — a phone number in E.164, or the address on whichever channel was used.
string
required
SID of the verification (VE…).
string
required
Where the verification stands: PENDING, APPROVED, EXPIRED, CANCELED or MAX_ATTEMPTS_REACHED.
string
When the correct code was entered, in ISO 8601.
Slug: TWILIO_VERIFICATION_MESSAGE_DELIVEREDType: webhookTriggers when the carrier confirms a verification code message reached the handset.

Configuration

string
Only deliver events for this Verify Service (VA…). Leave unset for every Verify service on the account. No Composio action lists Twilio Verify services yet; read it from GET https://verify.twilio.com/v2/Services.

Payload

string
required
SID of the Twilio account the service belongs to.
string
required
SID of the delivery attempt this status is for (VL…).
string
required
Channel the code was sent over, e.g. sms, call, whatsapp.
string
required
When the delivery attempt was created, in ISO 8601.
string
Twilio error code explaining a failed delivery; empty when it succeeded.
boolean
Whether a fallback channel is configured for this verification.
boolean
Whether this attempt is itself the fallback.
string
Mobile Country Code of the destination carrier.
string
required
Status the message reached: SENT, DELIVERED, READ, FAILED or UNDELIVERED.
string
Mobile Network Code of the destination carrier.
integer
How many SMS segments the message took.
string
required
SID of the Verify Service that issued the verification (VA…).
object
Your own key-value tags, as set on the verification.
string
required
Destination the code was sent to, in E.164.
string
required
SID of the verification the message belongs to (VE…).
Slug: TWILIO_VERIFICATION_MESSAGE_DELIVERY_FAILEDType: webhookTriggers when a verification code message does not reach the end user. message_status separates Twilio-side failure from carrier rejection; this is the signal that a user is stuck at the OTP step.

Configuration

string
Only deliver events for this Verify Service (VA…). Leave unset for every Verify service on the account. No Composio action lists Twilio Verify services yet; read it from GET https://verify.twilio.com/v2/Services.

Payload

string
required
SID of the Twilio account the service belongs to.
string
required
SID of the delivery attempt this status is for (VL…).
string
required
Channel the code was sent over, e.g. sms, call, whatsapp.
string
required
When the delivery attempt was created, in ISO 8601.
string
Twilio error code explaining a failed delivery; empty when it succeeded.
boolean
Whether a fallback channel is configured for this verification.
boolean
Whether this attempt is itself the fallback.
string
Mobile Country Code of the destination carrier.
string
required
Status the message reached: SENT, DELIVERED, READ, FAILED or UNDELIVERED.
string
Mobile Network Code of the destination carrier.
integer
How many SMS segments the message took.
string
required
SID of the Verify Service that issued the verification (VA…).
object
Your own key-value tags, as set on the verification.
string
required
Destination the code was sent to, in E.164.
string
required
SID of the verification the message belongs to (VE…).
Slug: TWILIO_VERIFICATION_MESSAGE_READType: webhookTriggers when the end user opens a verification code message. Read- receipt channels only — WhatsApp and RCS.

Configuration

string
Only deliver events for this Verify Service (VA…). Leave unset for every Verify service on the account. No Composio action lists Twilio Verify services yet; read it from GET https://verify.twilio.com/v2/Services.

Payload

string
required
SID of the Twilio account the service belongs to.
string
required
SID of the delivery attempt this status is for (VL…).
string
required
Channel the code was sent over, e.g. sms, call, whatsapp.
string
required
When the delivery attempt was created, in ISO 8601.
string
Twilio error code explaining a failed delivery; empty when it succeeded.
boolean
Whether a fallback channel is configured for this verification.
boolean
Whether this attempt is itself the fallback.
string
Mobile Country Code of the destination carrier.
string
required
Status the message reached: SENT, DELIVERED, READ, FAILED or UNDELIVERED.
string
Mobile Network Code of the destination carrier.
integer
How many SMS segments the message took.
string
required
SID of the Verify Service that issued the verification (VA…).
object
Your own key-value tags, as set on the verification.
string
required
Destination the code was sent to, in E.164.
string
required
SID of the verification the message belongs to (VE…).
Slug: TWILIO_VERIFICATION_MESSAGE_SENTType: webhookTriggers when the SMS, WhatsApp or voice message carrying a verification code leaves Twilio. Watch code delivery here rather than on Verification Started, whose per-attempt delivery status is pinned to SENT for accounts onboarded recently.

Configuration

string
Only deliver events for this Verify Service (VA…). Leave unset for every Verify service on the account. No Composio action lists Twilio Verify services yet; read it from GET https://verify.twilio.com/v2/Services.

Payload

string
required
SID of the Twilio account the service belongs to.
string
required
SID of the delivery attempt this status is for (VL…).
string
required
Channel the code was sent over, e.g. sms, call, whatsapp.
string
required
When the delivery attempt was created, in ISO 8601.
string
Twilio error code explaining a failed delivery; empty when it succeeded.
boolean
Whether a fallback channel is configured for this verification.
boolean
Whether this attempt is itself the fallback.
string
Mobile Country Code of the destination carrier.
string
required
Status the message reached: SENT, DELIVERED, READ, FAILED or UNDELIVERED.
string
Mobile Network Code of the destination carrier.
integer
How many SMS segments the message took.
string
required
SID of the Verify Service that issued the verification (VA…).
object
Your own key-value tags, as set on the verification.
string
required
Destination the code was sent to, in E.164.
string
required
SID of the verification the message belongs to (VE…).
Slug: TWILIO_VERIFICATION_STARTEDType: webhookTriggers when a Verify verification is started and a code is sent. Carries every send attempt with its channel, and the destination country.

Configuration

string
Only deliver events for this Verify Service (VA…). Leave unset for every Verify service on the account. No Composio action lists Twilio Verify services yet; read it from GET https://verify.twilio.com/v2/Services.

Payload

string
required
SID of the Twilio account the service belongs to.
object
required
Every attempt the end user made at entering the code.
integer
How many digits the code has.
string
required
ISO 3166-1 alpha-2 country code of the destination.
string
required
When the verification was started, in ISO 8601.
boolean
required
Whether the service lets you supply your own code instead of a generated one.
string
Your own override for the service name shown to the end user.
string
When the verification expires, in ISO 8601.
string
required
Name of the Verify Service, as shown to the end user.
object
required
Every attempt Verify made at delivering the code.
string
required
SID of the Verify Service that issued it (VA…).
string
required
Who is being verified — a phone number in E.164, or the address on whichever channel was used.
string
required
SID of the verification (VE…).
string
required
Where the verification stands: PENDING, APPROVED, EXPIRED, CANCELED or MAX_ATTEMPTS_REACHED.
string
When the correct code was entered, in ISO 8601.