- Category: communication
- Auth: API_KEY, BASIC, S2S_OAUTH2
- Composio-managed OAuth available? No
- Tools: 454
- Triggers: 45
- Slug:
TWILIO - Version: 00000000_00
Tools
Create Configuration Address
Create Configuration Address
TWILIO_CONVERSATIONS_CREATE_CONFIGURATION_ADDRESSCreate a new address configurationInput Parameters
whatsapp or sms.onMessageAdded, onMessageUpdated, onMessageRemoved, onConversationUpdated, onConversationStateUpdated, onConversationRemoved, onParticipantAdded, onParticipantUpdated, onParticipantRemoved, onDeliveryUpdatedOutput
Create Conversation
Create Conversation
TWILIO_CONVERSATIONS_CREATE_CONVERSATIONCreate a new conversation in your account’s default serviceInput Parameters
initializing, active, inactive or closed and defaults to activesid in the URL.closed state. Minimum value for this timer is 10 minutes.inactive state. Minimum value for this timer is 1 minute.Output
Create Conversation Message
Create Conversation Message
TWILIO_CONVERSATIONS_CREATE_CONVERSATION_MESSAGEAdd a new message to the conversationInput Parameters
Body and MediaSid parameters are ignored.null if the message has not been edited. If you set this parameter, Twilio ignores any milliseconds in the timestamp.Output
Create Conversation Participant
Create Conversation Participant
TWILIO_CONVERSATIONS_CREATE_CONVERSATION_PARTICIPANTAdd a new participant to the conversationInput Parameters
Output
Create Conversation Scoped Webhook
Create Conversation Scoped Webhook
Create Conversation With Participants
Create Conversation With Participants
TWILIO_CONVERSATIONS_CREATE_CONVERSATION_WITH_PARTICIPANTSCreate a new conversation with the list of participants in your account’s default serviceInput Parameters
initializing, active, inactive or closed and defaults to activesid in the URL.closed state. Minimum value for this timer is 10 minutes.inactive state. Minimum value for this timer is 1 minute.Output
Create Credential
Create Credential
TWILIO_CONVERSATIONS_CREATE_CREDENTIALAdd a new push notification credential to your accountInput Parameters
fcm, gcm, or apn.true to send to sandbox APNs or false to send to production.Output
Create Role
Create Role
TWILIO_CONVERSATIONS_CREATE_ROLECreate a new user role in your account’s default serviceInput Parameters
conversation for Conversation roles or service for Conversation Service roles.type.Output
Create Service
Create Service
Create Service Conversation
Create Service Conversation
TWILIO_CONVERSATIONS_CREATE_SERVICE_CONVERSATIONCreate a new conversation in your serviceInput Parameters
initializing, active, inactive or closed and defaults to activesid in the URL.closed state. Minimum value for this timer is 10 minutes.inactive state. Minimum value for this timer is 1 minute.Output
Create Service Conversation Message
Create Service Conversation Message
TWILIO_CONVERSATIONS_CREATE_SERVICE_CONVERSATION_MESSAGEAdd a new message to the conversation in a specific serviceInput Parameters
Body and MediaSid parameters are ignored.null if the message has not been edited. If you set this parameter, Twilio ignores any milliseconds in the timestamp.Output
Create Service Conversation Participant
Create Service Conversation Participant
TWILIO_CONVERSATIONS_CREATE_SERVICE_CONVERSATION_PARTICIPANTAdd a new participant to the conversation in a specific serviceInput Parameters
{} will be returned.proxy_address) is only null when the participant is interacting from an SDK endpoint (see the identity field).identity field).Output
Create Service Conversation Scoped Webhook
Create Service Conversation Scoped Webhook
TWILIO_CONVERSATIONS_CREATE_SERVICE_CONVERSATION_SCOPED_WEBHOOKCreate a new webhook scoped to the conversation in a specific serviceInput Parameters
webhook, studio, triggerOutput
Create Service Conversation With Participants
Create Service Conversation With Participants
TWILIO_CONVERSATIONS_CREATE_SERVICE_CONVERSATION_WITH_PARTICIPANTSCreate a new conversation with the list of participants in your account’s default serviceInput Parameters
initializing, active, inactive or closed and defaults to activesid in the URL.closed state. Minimum value for this timer is 10 minutes.inactive state. Minimum value for this timer is 1 minute.Output
Create Service Role
Create Service Role
TWILIO_CONVERSATIONS_CREATE_SERVICE_ROLECreate a new user role in your serviceInput Parameters
conversation for Conversation roles or service for Conversation Service roles.type.Output
Create Service User
Create Service User
TWILIO_CONVERSATIONS_CREATE_SERVICE_USERAdd a new conversation user to your serviceInput Parameters
{} is returned.Output
Create User
Create User
TWILIO_CONVERSATIONS_CREATE_USERAdd a new conversation user to your account’s default serviceInput Parameters
{} is returned.Output
Delete Configuration Address
Delete Configuration Address
Delete Conversation
Delete Conversation
Delete Conversation Message
Delete Conversation Message
Delete Conversation Participant
Delete Conversation Participant
Delete Conversation Scoped Webhook
Delete Conversation Scoped Webhook
Delete Credential
Delete Credential
Delete Role
Delete Role
Delete Service
Delete Service
Delete Service Binding
Delete Service Binding
Delete Service Conversation
Delete Service Conversation
Delete Service Conversation Message
Delete Service Conversation Message
Delete Service Conversation Participant
Delete Service Conversation Participant
Delete Service Conversation Scoped Webhook
Delete Service Conversation Scoped Webhook
Delete Service Role
Delete Service Role
Delete Service User
Delete Service User
Delete Service User Conversation
Delete Service User Conversation
TWILIO_CONVERSATIONS_DELETE_SERVICE_USER_CONVERSATIONDelete a specific User Conversation.Input Parameters
sid or the identity of the User resource.sid or the unique_name of the Conversation resource.Output
Delete User
Delete User
Delete User Conversation
Delete User Conversation
TWILIO_CONVERSATIONS_DELETE_USER_CONVERSATIONDelete a specific User Conversation.Input Parameters
sid or the identity of the User resource.sid or the unique_name of the Conversation resource.Output
Fetch Configuration
Fetch Configuration
Fetch Configuration Address
Fetch Configuration Address
Fetch Configuration Webhook
Fetch Configuration Webhook
Fetch Conversation
Fetch Conversation
Fetch Conversation Message
Fetch Conversation Message
Fetch Conversation Message Receipt
Fetch Conversation Message Receipt
Fetch Conversation Participant
Fetch Conversation Participant
Fetch Conversation Scoped Webhook
Fetch Conversation Scoped Webhook
Fetch Credential
Fetch Credential
Fetch Role
Fetch Role
Fetch Service
Fetch Service
Fetch Service Binding
Fetch Service Binding
Fetch Service Configuration
Fetch Service Configuration
Fetch Service Conversation
Fetch Service Conversation
Fetch Service Conversation Message
Fetch Service Conversation Message
Fetch Service Conversation Message Receipt
Fetch Service Conversation Message Receipt
Fetch Service Conversation Participant
Fetch Service Conversation Participant
Fetch Service Conversation Scoped Webhook
Fetch Service Conversation Scoped Webhook
Fetch Service Notification
Fetch Service Notification
Fetch Service Role
Fetch Service Role
Fetch Service User
Fetch Service User
Fetch Service User Conversation
Fetch Service User Conversation
TWILIO_CONVERSATIONS_FETCH_SERVICE_USER_CONVERSATIONFetch a specific User Conversation.Input Parameters
sid or the identity of the User resource.sid or the unique_name of the Conversation resource.Output
Fetch Service Webhook Configuration
Fetch Service Webhook Configuration
Fetch User
Fetch User
Fetch User Conversation
Fetch User Conversation
TWILIO_CONVERSATIONS_FETCH_USER_CONVERSATIONFetch a specific User Conversation.Input Parameters
sid or the identity of the User resource.sid or the unique_name of the Conversation resource.Output
List Configuration Address
List Configuration Address
List Conversation
List Conversation
TWILIO_CONVERSATIONS_LIST_CONVERSATIONRetrieve a list of conversations in your account’s default serviceInput Parameters
active, inactive or closedOutput
List Conversation Message
List Conversation Message
List Conversation Message Receipt
List Conversation Message Receipt
List Conversation Participant
List Conversation Participant
List Conversation Scoped Webhook
List Conversation Scoped Webhook
List Credential
List Credential
List Participant Conversation
List Participant Conversation
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
Output
List Role
List Role
List Service
List Service
List Service Binding
List Service Binding
TWILIO_CONVERSATIONS_LIST_SERVICE_BINDINGRetrieve a list of all push notification bindings in the conversation serviceInput Parameters
apn, gcm, fcm, or twilsock. See push notification configuration for more info.Output
List Service Conversation
List Service Conversation
TWILIO_CONVERSATIONS_LIST_SERVICE_CONVERSATIONRetrieve a list of conversations in your serviceInput Parameters
active, inactive or closedOutput
List Service Conversation Message
List Service Conversation Message
List Service Conversation Message Receipt
List Service Conversation Message Receipt
List Service Conversation Participant
List Service Conversation Participant
List Service Conversation Scoped Webhook
List Service Conversation Scoped Webhook
List Service Participant Conversation
List Service Participant Conversation
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
Output
List Service Role
List Service Role
List Service User
List Service User
List Service User Conversation
List Service User Conversation
List User
List User
List User Conversation
List User Conversation
Update Configuration
Update Configuration
TWILIO_CONVERSATIONS_UPDATE_CONFIGURATIONUpdate the global configuration of conversations on your accountInput Parameters
closed state. Minimum value for this timer is 10 minutes.inactive state. Minimum value for this timer is 1 minute.Output
Update Configuration Address
Update Configuration Address
TWILIO_CONVERSATIONS_UPDATE_CONFIGURATION_ADDRESSUpdate an existing address configurationInput Parameters
sid or the address of the configurationonMessageAdded, onMessageUpdated, onMessageRemoved, onConversationUpdated, onConversationStateUpdated, onConversationRemoved, onParticipantAdded, onParticipantUpdated, onParticipantRemoved, onDeliveryUpdatedOutput
Update Configuration Webhook
Update Configuration Webhook
TWILIO_CONVERSATIONS_UPDATE_CONFIGURATION_WEBHOOKUpdate Configuration Webhook using the Twilio conversations_v1 REST API.Input Parameters
onMessageAdded, onMessageUpdated, onMessageRemoved, onMessageAdd, onMessageUpdate, onMessageRemove, onConversationUpdated, onConversationRemoved, onConversationAdd, onConversationAdded, onConversationRemove, onConversationUpdate, onConversationStateUpdated, onParticipantAdded, onParticipantUpdated, onParticipantRemoved, onParticipantAdd, onParticipantRemove, onParticipantUpdate, onDeliveryUpdated, onUserAdded, onUserUpdate, onUserUpdatedOutput
Update Conversation
Update Conversation
TWILIO_CONVERSATIONS_UPDATE_CONVERSATIONUpdate an existing conversation in your account’s default serviceInput Parameters
unique_name of the Conversation.initializing, active, inactive or closed and defaults to activesid in the URL.closed state. Minimum value for this timer is 10 minutes.inactive state. Minimum value for this timer is 1 minute.Output
Update Conversation Message
Update Conversation Message
TWILIO_CONVERSATIONS_UPDATE_CONVERSATION_MESSAGEUpdate an existing message in the conversationInput Parameters
null if the message has not been edited. If you set this parameter, Twilio ignores any milliseconds in the timestamp.Output
Update Conversation Participant
Update Conversation Participant
TWILIO_CONVERSATIONS_UPDATE_CONVERSATION_PARTICIPANTUpdate an existing participant in the conversationInput Parameters
Output
Update Conversation Scoped Webhook
Update Conversation Scoped Webhook
Update Credential
Update Credential
TWILIO_CONVERSATIONS_UPDATE_CREDENTIALUpdate an existing push notification credential on your accountInput Parameters
fcm, gcm, or apn.true to send to sandbox APNs or false to send to production.Output
Update Role
Update Role
TWILIO_CONVERSATIONS_UPDATE_ROLEUpdate an existing user role in your account’s default serviceInput Parameters
type.Output
Update Service Configuration
Update Service Configuration
TWILIO_CONVERSATIONS_UPDATE_SERVICE_CONFIGURATIONUpdate configuration settings of a conversation serviceInput Parameters
false.Output
Update Service Conversation
Update Service Conversation
TWILIO_CONVERSATIONS_UPDATE_SERVICE_CONVERSATIONUpdate an existing conversation in your serviceInput Parameters
unique_name of the Conversation.initializing, active, inactive or closed and defaults to activesid in the URL.closed state. Minimum value for this timer is 10 minutes.inactive state. Minimum value for this timer is 1 minute.Output
Update Service Conversation Message
Update Service Conversation Message
TWILIO_CONVERSATIONS_UPDATE_SERVICE_CONVERSATION_MESSAGEUpdate an existing message in the conversationInput Parameters
null if the message has not been edited. If you set this parameter, Twilio ignores any milliseconds in the timestamp.Output
Update Service Conversation Participant
Update Service Conversation Participant
TWILIO_CONVERSATIONS_UPDATE_SERVICE_CONVERSATION_PARTICIPANTUpdate an existing participant in the conversationInput Parameters
{} will be returned.Output
Update Service Conversation Scoped Webhook
Update Service Conversation Scoped Webhook
Update Service Notification
Update Service Notification
TWILIO_CONVERSATIONS_UPDATE_SERVICE_NOTIFICATIONUpdate push notification service settingsInput Parameters
new_message.enabled is true.false.new_message.enabled is true.added_to_conversation.enabled is true.false.added_to_conversation.enabled is true.false.new_message.attachments.enabled is true.removed_from_conversation.enabled is true.false.removed_from_conversation.enabled is true.Output
Update Service Role
Update Service Role
TWILIO_CONVERSATIONS_UPDATE_SERVICE_ROLEUpdate an existing user role in your serviceInput Parameters
type.Output
Update Service User
Update Service User
TWILIO_CONVERSATIONS_UPDATE_SERVICE_USERUpdate an existing conversation user in your serviceInput Parameters
sid or the identity of the User resource to update.{} is returned.Output
Update Service User Conversation
Update Service User Conversation
TWILIO_CONVERSATIONS_UPDATE_SERVICE_USER_CONVERSATIONUpdate a specific User Conversation.Input Parameters
sid or the identity of the User resource.sid or the unique_name of the Conversation resource.default or muted.Output
Update Service Webhook Configuration
Update Service Webhook Configuration
TWILIO_CONVERSATIONS_UPDATE_SERVICE_WEBHOOK_CONFIGURATIONUpdate a specific Webhook.Input Parameters
onParticipantAdd, onParticipantAdded, onDeliveryUpdated, onConversationUpdated, onConversationRemove, onParticipantRemove, onConversationUpdate, onMessageAdd, onMessageRemoved, onParticipantUpdated, onConversationAdded, onMessageAdded, onConversationAdd, onConversationRemoved, onParticipantUpdate, onMessageRemove, onMessageUpdated, onParticipantRemoved, onMessageUpdate or onConversationStateUpdated.Output
Update User
Update User
TWILIO_CONVERSATIONS_UPDATE_USERUpdate an existing conversation user in your account’s default serviceInput Parameters
sid or the identity of the User resource to update.{} is returned.Output
Update User Conversation
Update User Conversation
TWILIO_CONVERSATIONS_UPDATE_USER_CONVERSATIONUpdate a specific User Conversation.Input Parameters
sid or the identity of the User resource.sid or the unique_name of the Conversation resource.default or muted.Output
Create Account
Create Account
Create Address
Create Address
TWILIO_CREATE_ADDRESSCreate Address using the Twilio api_v2010 REST API.Input Parameters
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
Create Application
Create Application
TWILIO_CREATE_APPLICATIONCreate a new application within your accountInput Parameters
2010-04-01 or 2008-08-01. The default value is the account’s default API version.status_callback_method to send status information to your application.sms_url.url.voice_fallback_url. Can be: GET or POST.true or false.true or false.Output
Create Call
Create Call
TWILIO_CREATE_CALLCreate a new outgoing call to phones, SIP-enabled endpoints or Twilio Client connectionsInput Parameters
method when the call connects. For more information, see the Url Parameter section in Making Calls.byoc is only meaningful when to is a phone number; it will otherwise be ignored. (Beta)trim-silence or do-not-trim and the default is trim-silence.to parameter is a phone number, From must also be a phone number.twiml and url are provided then twiml parameter will be ignored. Max 4000 characters.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.true to record the phone call, or false to not. The default is false. The recording_url is sent to the status_callback URL.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.true or false.name@company.com.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.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.fallback_url. Can be: GET or POST and the default is POST. If an application_sid parameter is present, this parameter is ignored.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.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).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.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.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.status_callback URL. Can be: GET or POST and the default is POST. If an application_sid parameter is present, this parameter is ignored.async_amd_status_callback_method to notify customer application whether the call was answered by human, machine or fax.AnsweredBy of unknown. The default timeout is 30 seconds.recording_status_callback. Can be: in-progress, completed and absent. Defaults to completed. Separate multiple values with a space.async_amd_status_callback URL. Can be: GET or POST and the default is POST.recording_status_callback URL. Can be: GET or POST and the default is POST.unknown AnsweredBy result will be returned. Possible Values: 2000-10000. Default: 5000.Output
Create Call Recording
Create Call Recording
TWILIO_CREATE_CALL_RECORDINGCreate a recording for the callInput Parameters
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.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.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.recording_status_callback_method on each recording event specified in recording_status_callback_event. For more information, see RecordingStatusCallback parameters.recording_status_callback URL. Can be: in-progress, completed and absent and the default is completed. Separate multiple event values with a space.recording_status_callback. Can be: GET or POST and the default is POST.Output
Create Incoming Phone Number
Create Incoming Phone Number
TWILIO_CREATE_INCOMING_PHONE_NUMBERPurchase a phone-number for the account.Input Parameters
area_code or a phone_number. (US and Canada only).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.voice_url will not be called if a voice_application_sid or a trunk_sid is set.sms_url. Can be: GET or POST and defaults to POST.2010-04-01.voice_url. Can be: GET or POST and defaults to POST.status_callback_method to send status information to your application.sms_url.url.sms_application_sid is present, we ignore all of the sms_*_url urls and use those set on the application.sms_fallback_url. Can be: GET or POST and defaults to POST.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.voice_fallback_url. Can be: GET or POST and defaults to POST.status_callback. Can be: GET or POST and defaults to POST.true or false and defaults to false.Output
Create Incoming Phone Number Assigned Add On
Create Incoming Phone Number Assigned Add On
Create Incoming Phone Number Local
Create Incoming Phone Number Local
TWILIO_CREATE_INCOMING_PHONE_NUMBER_LOCALCreate Incoming Phone Number Local using the Twilio api_v2010 REST API.Input Parameters
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.voice_url will not be called if a voice_application_sid or a trunk_sid is set.sms_url. Can be: GET or POST and defaults to POST.2010-04-01.voice_url. Can be: GET or POST and defaults to POST.status_callback_method to send status information to your application.sms_url.url.sms_application_sid is present, we ignore all of the sms_*_url urls and use those set on the application.sms_fallback_url. Can be: GET or POST and defaults to POST.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.voice_fallback_url. Can be: GET or POST and defaults to POST.status_callback. Can be: GET or POST and defaults to POST.true or false and defaults to false.Output
Create Incoming Phone Number Mobile
Create Incoming Phone Number Mobile
TWILIO_CREATE_INCOMING_PHONE_NUMBER_MOBILECreate Incoming Phone Number Mobile using the Twilio api_v2010 REST API.Input Parameters
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.voice_url will not be called if a voice_application_sid or a trunk_sid is set.sms_url. Can be: GET or POST and defaults to POST.2010-04-01.voice_url. Can be: GET or POST and defaults to POST.status_callback_method to send status information to your application.sms_url.url.sms_application_sid is present, we ignore all of the sms_*_url urls and use those of the application.sms_fallback_url. Can be: GET or POST and defaults to POST.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.voice_fallback_url. Can be: GET or POST and defaults to POST.status_callback. Can be: GET or POST and defaults to POST.true or false and defaults to false.Output
Create Incoming Phone Number Toll Free
Create Incoming Phone Number Toll Free
TWILIO_CREATE_INCOMING_PHONE_NUMBER_TOLL_FREECreate Incoming Phone Number Toll Free using the Twilio api_v2010 REST API.Input Parameters
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.voice_url will not be called if a voice_application_sid or a trunk_sid is set.sms_url. Can be: GET or POST and defaults to POST.2010-04-01.voice_url. Can be: GET or POST and defaults to POST.status_callback_method to send status information to your application.sms_url.url.sms_application_sid is present, we ignore all sms_*_url values and use those of the application.sms_fallback_url. Can be: GET or POST and defaults to POST.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.voice_fallback_url. Can be: GET or POST and defaults to POST.status_callback. Can be: GET or POST and defaults to POST.true or false and defaults to false.Output
Create Message
Create Message
TWILIO_CREATE_MESSAGESend a messageInput Parameters
whatsapp:+15552229999.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.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.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.disable to skip any kind of risk check on the respective message request.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.true, Twilio delivers the message as a single MMS message, regardless of the presence of media.body of the Message. Default value is false. If true, the messaging_service_sid parameter must also be provided.fixed in conjuction with the send_time parameter in order to schedule a Message.true or false.otp, notifications, marketing, fraud, security, customercare, delivery, education, polling, announcements, and events.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.messaging_service_sid, Twilio uses this URL instead of the Status Callback URL of the Messaging Service.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 periodfalse.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.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
Create Message Feedback
Create Message Feedback
TWILIO_CREATE_MESSAGE_FEEDBACKCreate Message Feedback to confirm a tracked user action was performed by the recipient of the associated MessageInput Parameters
unconfirmed or confirmed. For more details see How to Optimize Message Deliverability with Message Feedback.Output
Create New Key
Create New Key
Create New Signing Key
Create New Signing Key
Create Participant
Create Participant
TWILIO_CREATE_PARTICIPANTCreate Participant using the Twilio api_v2010 REST API.Input Parameters
sip:name@company.com. Client identifiers are formatted client:name. TwiML App identifiers are formatted app:<APP_SID>. Custom parameters may also be specified.true, false, onEnter, or onExit. The default value is true.byoc is only meaningful when to is a phone number; it will otherwise be ignored. (Beta)trim-silence or do-not-trim and the default is trim-silence.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.true or false and the default is false.us1, us2, ie1, de1, sg1, br1, au1, or jp1.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.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.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.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.true or false and defaults to true.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.trim-silence or do-not-trim and defaults to trim-silence.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.status_callback_method to send status information to your application.2 to 250. The default value is 250.coached. The participant being coached is the only participant who can hear the participant who is coaching.true, false, record-from-start, and do-not-record. The default value is false.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.off, small, medium, and large. Default to large.amd_status_callback_method to notify customer application whether the call was answered by human, machine or fax.status_callback. Can be: initiated, ringing, answered, and completed. Separate multiple values with a space. The default value is completed.true or false and defaults to false.status_callback. Can be: GET and POST and defaults to POST.AnsweredBy of unknown. The default timeout is 30 seconds.recording_status_callback_method when the recording status changes.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.amd_status_callback URL. Can be: GET or POST and the default is POST.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.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'.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.recording_status_callback. Can be: GET or POST and defaults to POST.conference_status_callback. Can be: GET or POST and defaults to POST.unknown AnsweredBy result will be returned. Possible Values: 2000-10000. Default: 5000.conference_recording_status_callback_method when the conference recording is available.conference_recording_status_callback. Can be: in-progress, completed, failed, and absent. Separate multiple values with a space, ex: 'in-progress completed failed'conference_recording_status_callback. Can be: GET or POST and defaults to POST.Output
Create Payments
Create Payments
TWILIO_CREATE_PAYMENTScreate an instance of payments. This will start a new payments sessionInput Parameters
dtmf is supported. All digits captured during a pay session are redacted from the logs.5, maximum is 600.charge_amount, formatted as ISO 4127 format. The default value is USD and all values allowed from the Pay Connector are accepted.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.true.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.currency field. Leave blank or set to 0 to tokenize.true.credit-card or ach-debit. The default value is credit-card.visa mastercard amexconsumer-checking, consumer-savings, or commercial-checking. The default value is consumer-checking.Default.PostalCode inputted by the user. User must enter this many digits.payment-card-number, expiration-date, security-code, and postal-code.Output
Create Queue
Create Queue
Create Realtime Transcription
Create Realtime Transcription
TWILIO_CREATE_REALTIME_TRANSCRIPTIONCreate a TranscriptionInput Parameters
inbound_track, outbound_track, both_tracks.Output
Create Sip Auth Calls Credential List Mapping
Create Sip Auth Calls Credential List Mapping
Create Sip Auth Calls Ip Access Control List Mapping
Create Sip Auth Calls Ip Access Control List Mapping
Create Sip Auth Registrations Credential List Mapping
Create Sip Auth Registrations Credential List Mapping
Create Sip Credential
Create Sip Credential
TWILIO_CREATE_SIP_CREDENTIALCreate a new credential resource.Input Parameters
IWasAtSignal2018)Output
Create Sip Credential List
Create Sip Credential List
Create Sip Credential List Mapping
Create Sip Credential List Mapping
TWILIO_CREATE_SIP_CREDENTIAL_LIST_MAPPINGCreate a CredentialListMapping resource for an account.Input Parameters
Output
Create Sip Domain
Create Sip Domain
TWILIO_CREATE_SIP_DOMAINCreate a new DomainInput Parameters
sip.twilio.com.true or false. true allows SIP Endpoints to register with the domain to receive calls, false does not.voice_url.voice_fallback_url. Can be: GET or POST.voice_status_callback_url. Can be: GET or POST.Output
Create Sip Ip Access Control List
Create Sip Ip Access Control List
Create Sip Ip Access Control List Mapping
Create Sip Ip Access Control List Mapping
Create Sip Ip Address
Create Sip Ip Address
TWILIO_CREATE_SIP_IP_ADDRESSCreate a new IpAddress resource.Input Parameters
Output
Create Siprec
Create Siprec
Create Stream
Create Stream
TWILIO_CREATE_STREAMCreate a StreamInput Parameters
inbound_track, outbound_track, both_tracks. Default value is inbound_track.status_callback requests. Possible values are GET and POST. Default is POST.Output
Create Token
Create Token
Create Usage Trigger
Create Usage Trigger
TWILIO_CREATE_USAGE_TRIGGERCreate a new UsageTriggerInput Parameters
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.count, usage, or price, as described in the UsageRecords documentation.+30 to specify a trigger_value that is 30 units more than the current usage value. Be sure to urlencode a + as %2B.callback_url. Can be: GET or POST and the default is POST.Output
Create User Defined Message
Create User Defined Message
Create User Defined Message Subscription
Create User Defined Message Subscription
TWILIO_CREATE_USER_DEFINED_MESSAGE_SUBSCRIPTIONSubscribe to User Defined Messages for a given Call SID.Input Parameters
Url. Either GET or POST. Default is POST.method to send user defined events to your application. URLs must contain a valid hostname (underscores are not permitted).Output
Create Validation Request
Create Validation Request
TWILIO_CREATE_VALIDATION_REQUESTCreate Validation Request using the Twilio api_v2010 REST API.Input Parameters
0 and 60, inclusive. The default is 0.status_callback_method to send status information about the verification process to your application.status_callback. Can be: GET or POST, and the default is POST.Output
Delete Address
Delete Address
Delete Application
Delete Application
Delete Call
Delete Call
Delete Call Recording
Delete Call Recording
Delete Conference Recording
Delete Conference Recording
Delete Incoming Phone Number
Delete Incoming Phone Number
Delete Incoming Phone Number Assigned Add On
Delete Incoming Phone Number Assigned Add On
Delete Key
Delete Key
Delete Message
Delete Message
Delete Outgoing Caller Id
Delete Outgoing Caller Id
Delete Participant
Delete Participant
Delete Recording
Delete Recording
Delete Recording Add On Result
Delete Recording Add On Result
Delete Recording Add On Result Payload
Delete Recording Add On Result Payload
TWILIO_DELETE_RECORDING_ADD_ON_RESULT_PAYLOADDelete a payload from the result along with all associated DataInput Parameters
Output
Delete Recording Transcription
Delete Recording Transcription
Delete Signing Key
Delete Signing Key
Delete Sip Auth Calls Credential List Mapping
Delete Sip Auth Calls Credential List Mapping
Delete Sip Auth Calls Ip Access Control List Mapping
Delete Sip Auth Calls Ip Access Control List Mapping
TWILIO_DELETE_SIP_AUTH_CALLS_IP_ACCESS_CONTROL_LIST_MAPPINGDelete an IP Access Control List mapping from the requested domainInput Parameters
Output
Delete Sip Auth Registrations Credential List Mapping
Delete Sip Auth Registrations Credential List Mapping
Delete Sip Credential
Delete Sip Credential
Delete Sip Credential List
Delete Sip Credential List
Delete Sip Credential List Mapping
Delete Sip Credential List Mapping
Delete Sip Ip Access Control List
Delete Sip Ip Access Control List
Delete Sip Ip Access Control List Mapping
Delete Sip Ip Access Control List Mapping
Delete Sip Ip Address
Delete Sip Ip Address
Delete Transcription
Delete Transcription
Delete Usage Trigger
Delete Usage Trigger
Delete User Defined Message Subscription
Delete User Defined Message Subscription
Fetch Account
Fetch Account
Fetch Address
Fetch Address
Fetch Application
Fetch Application
Fetch Available Phone Number Country
Fetch Available Phone Number Country
Fetch Balance
Fetch Balance
Fetch Call
Fetch Call
Fetch Call Notification
Fetch Call Notification
Fetch Call Recording
Fetch Call Recording
Fetch Conference
Fetch Conference
Fetch Conference Recording
Fetch Conference Recording
Fetch Connect App
Fetch Connect App
Fetch Incoming Phone Number
Fetch Incoming Phone Number
Fetch Incoming Phone Number Assigned Add On
Fetch Incoming Phone Number Assigned Add On
Fetch Incoming Phone Number Assigned Add On Extension
Fetch Incoming Phone Number Assigned Add On Extension
Fetch Media
Fetch Media
Fetch Notification
Fetch Notification
Fetch Outgoing Caller Id
Fetch Outgoing Caller Id
Fetch Participant
Fetch Participant
Fetch Queue
Fetch Queue
Fetch Recording
Fetch Recording
Fetch Recording Add On Result
Fetch Recording Add On Result
Fetch Recording Add On Result Payload
Fetch Recording Add On Result Payload
TWILIO_FETCH_RECORDING_ADD_ON_RESULT_PAYLOADFetch an instance of a result payloadInput Parameters
Output
Fetch Recording Add On Result Payload Data
Fetch Recording Add On Result Payload Data
TWILIO_FETCH_RECORDING_ADD_ON_RESULT_PAYLOAD_DATAFetch an instance of a result payloadInput Parameters
Output
Fetch Recording Transcription
Fetch Recording Transcription
Fetch Short Code
Fetch Short Code
Fetch Signing Key
Fetch Signing Key
Fetch Sip Auth Calls Credential List Mapping
Fetch Sip Auth Calls Credential List Mapping
Fetch Sip Auth Calls Ip Access Control List Mapping
Fetch Sip Auth Calls Ip Access Control List Mapping
Fetch Sip Auth Registrations Credential List Mapping
Fetch Sip Auth Registrations Credential List Mapping
Fetch Sip Credential
Fetch Sip Credential
Fetch Sip Credential List
Fetch Sip Credential List
Fetch Sip Credential List Mapping
Fetch Sip Credential List Mapping
Fetch Sip Ip Access Control List
Fetch Sip Ip Access Control List
Fetch Sip Ip Access Control List Mapping
Fetch Sip Ip Access Control List Mapping
Fetch Sip Ip Address
Fetch Sip Ip Address
Fetch Transcription
Fetch Transcription
Fetch Usage Trigger
Fetch Usage Trigger
List Account
List Account
List Address
List Address
List Application
List Application
List Available Phone Number Country
List Available Phone Number Country
List Available Phone Number Local
List Available Phone Number Local
TWILIO_LIST_AVAILABLE_PHONE_NUMBER_LOCALList Available Phone Number Local using the Twilio api_v2010 REST API.Input Parameters
true or false and the default is true.*, %, +, $. 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.near_ query. Can be up to 500 and the default is 25. Applies to only phone numbers in the US and Canada.distance miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.lat,long find geographically close numbers within distance miles. Applies to only phone numbers in the US and Canada.in_lata to be set as well. Applies to only phone numbers in the US and Canada.true or false and the default is false.true or false and the default is false.true or false and the default is false.Output
List Available Phone Number Machine To Machine
List Available Phone Number Machine To Machine
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
true or false and the default is true.*, %, +, $. 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.near_ query. Can be up to 500 and the default is 25. Applies to only phone numbers in the US and Canada.distance miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.lat,long find geographically close numbers within distance miles. Applies to only phone numbers in the US and Canada.in_lata to be set as well. Applies to only phone numbers in the US and Canada.true or false and the default is false.true or false and the default is false.true or false and the default is false.Output
List Available Phone Number Mobile
List Available Phone Number Mobile
TWILIO_LIST_AVAILABLE_PHONE_NUMBER_MOBILEList Available Phone Number Mobile using the Twilio api_v2010 REST API.Input Parameters
true or false and the default is true.*, %, +, $. 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.near_ query. Can be up to 500 and the default is 25. Applies to only phone numbers in the US and Canada.distance miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.lat,long find geographically close numbers within distance miles. Applies to only phone numbers in the US and Canada.in_lata to be set as well. Applies to only phone numbers in the US and Canada.true or false and the default is false.true or false and the default is false.true or false and the default is false.Output
List Available Phone Number National
List Available Phone Number National
TWILIO_LIST_AVAILABLE_PHONE_NUMBER_NATIONALList Available Phone Number National using the Twilio api_v2010 REST API.Input Parameters
true or false and the default is true.*, %, +, $. 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.near_ query. Can be up to 500 and the default is 25. Applies to only phone numbers in the US and Canada.distance miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.lat,long find geographically close numbers within distance miles. Applies to only phone numbers in the US and Canada.in_lata to be set as well. Applies to only phone numbers in the US and Canada.true or false and the default is false.true or false and the default is false.true or false and the default is false.Output
List Available Phone Number Toll Free
List Available Phone Number Toll Free
TWILIO_LIST_AVAILABLE_PHONE_NUMBER_TOLL_FREEList Available Phone Number Toll Free using the Twilio api_v2010 REST API.Input Parameters
true or false and the default is true.*, %, +, $. 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.near_ query. Can be up to 500 and the default is 25. Applies to only phone numbers in the US and Canada.distance miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.lat,long find geographically close numbers within distance miles. Applies to only phone numbers in the US and Canada.in_lata to be set as well. Applies to only phone numbers in the US and Canada.true or false and the default is false.true or false and the default is false.true or false and the default is false.Output
List Available Phone Number Voip
List Available Phone Number Voip
TWILIO_LIST_AVAILABLE_PHONE_NUMBER_VOIPList Available Phone Number Voip using the Twilio api_v2010 REST API.Input Parameters
true or false and the default is true.*, %, +, $. 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.near_ query. Can be up to 500 and the default is 25. Applies to only phone numbers in the US and Canada.distance miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.lat,long find geographically close numbers within distance miles. Applies to only phone numbers in the US and Canada.in_lata to be set as well. Applies to only phone numbers in the US and Canada.true or false and the default is false.true or false and the default is false.true or false and the default is false.Output
List Call
List Call
TWILIO_LIST_CALLRetrieves a collection of calls made to and from your accountInput Parameters
queued, ringing, in-progress, canceled, completed, failed, busy, or no-answer.YYYY-MM-DD in UTC, for example: 2009-07-06, to read only calls that ended on this date.YYYY-MM-DD in UTC, for example: 2009-07-06, to read only calls that started on this date.YYYY-MM-DD in UTC, for example: 2009-07-06, to read only calls that ended on or after this date.YYYY-MM-DD in UTC, for example: 2009-07-06, to read only calls that ended before this date.YYYY-MM-DD in UTC, for example: 2009-07-06, to read only calls that started on or after this date.YYYY-MM-DD in UTC, for example: 2009-07-06, to read only calls that started before this date.Output
List Call Event
List Call Event
List Call Notification
List Call Notification
TWILIO_LIST_CALL_NOTIFICATIONList Call Notification using the Twilio api_v2010 REST API.Input Parameters
0 to read only ERROR notifications or 1 to read only WARNING notifications. By default, all notifications are read.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.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.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
List Call Recording
List Call Recording
TWILIO_LIST_CALL_RECORDINGRetrieve a list of recordings belonging to the call used to make the requestInput Parameters
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.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.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
List Conference
List Conference
TWILIO_LIST_CONFERENCERetrieve a list of conferences belonging to the account used to make the requestInput Parameters
init, in-progress, or completed. Starting from September 30th, 2026, the default is in-progress. To read completed conferences, set Status to completed.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.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.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.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.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.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
List Conference Recording
List Conference Recording
TWILIO_LIST_CONFERENCE_RECORDINGRetrieve a list of recordings belonging to the call used to make the requestInput Parameters
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.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.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
List Connect App
List Connect App
List Dependent Phone Number
List Dependent Phone Number
List Incoming Phone Number
List Incoming Phone Number
TWILIO_LIST_INCOMING_PHONE_NUMBERRetrieve a list of incoming-phone-numbers belonging to the account used to make the request.Input Parameters
true or false and the default is true.twilio or hosted. By default, phone numbers of all origin are included.Output
List Incoming Phone Number Assigned Add On
List Incoming Phone Number Assigned Add On
List Incoming Phone Number Assigned Add On Extension
List Incoming Phone Number Assigned Add On Extension
List Incoming Phone Number Local
List Incoming Phone Number Local
TWILIO_LIST_INCOMING_PHONE_NUMBER_LOCALList Incoming Phone Number Local using the Twilio api_v2010 REST API.Input Parameters
true or false and the default is true.twilio or hosted. By default, phone numbers of all origin are included.Output
List Incoming Phone Number Mobile
List Incoming Phone Number Mobile
TWILIO_LIST_INCOMING_PHONE_NUMBER_MOBILEList Incoming Phone Number Mobile using the Twilio api_v2010 REST API.Input Parameters
true or false and the default is true.twilio or hosted. By default, phone numbers of all origin are included.Output
List Incoming Phone Number Toll Free
List Incoming Phone Number Toll Free
TWILIO_LIST_INCOMING_PHONE_NUMBER_TOLL_FREEList Incoming Phone Number Toll Free using the Twilio api_v2010 REST API.Input Parameters
true or false and the default is true.twilio or hosted. By default, phone numbers of all origin are included.Output
List Media
List Media
TWILIO_LIST_MEDIARead a list of Media resources associated with a specific Message resourceInput Parameters
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.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.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
List Message
List Message
TWILIO_LIST_MESSAGERetrieve a list of Message resources associated with a Twilio AccountInput Parameters
+15558881111 to retrieve a list of Message resources sent to +15558881111.+15552229999 to retrieve a list of Message resources sent by +15552229999.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).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).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
List Notification
List Notification
TWILIO_LIST_NOTIFICATIONTwilio retired the Notifications list endpoint. This deprecated compatibility action is retained only to return a clear error.Input Parameters
0 to read only ERROR notifications or 1 to read only WARNING notifications. By default, all notifications are read.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.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.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
List Outgoing Caller Id
List Outgoing Caller Id
List Participant
List Participant
List Queue
List Queue
List Recording
List Recording
TWILIO_LIST_RECORDINGRetrieve a list of recordings belonging to the account used to make the requestInput Parameters
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.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.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.Output
List Recording Add On Result
List Recording Add On Result
List Recording Add On Result Payload
List Recording Add On Result Payload
TWILIO_LIST_RECORDING_ADD_ON_RESULT_PAYLOADRetrieve a list of payloads belonging to the AddOnResultInput Parameters
Output
List Recording Transcription
List Recording Transcription
List Short Code
List Short Code
List Signing Key
List Signing Key
List Sip Auth Calls Credential List Mapping
List Sip Auth Calls Credential List Mapping
List Sip Auth Calls Ip Access Control List Mapping
List Sip Auth Calls Ip Access Control List Mapping
List Sip Auth Registrations Credential List Mapping
List Sip Auth Registrations Credential List Mapping
List Sip Credential
List Sip Credential
List Sip Credential List
List Sip Credential List
List Sip Credential List Mapping
List Sip Credential List Mapping
List Sip Domain
List Sip Domain
List Sip Ip Access Control List
List Sip Ip Access Control List
List Sip Ip Access Control List Mapping
List Sip Ip Access Control List Mapping
List Sip Ip Address
List Sip Ip Address
List Transcription
List Transcription
List Usage Record
List Usage Record
TWILIO_LIST_USAGE_RECORDRetrieve a list of usage-records belonging to the account used to make the requestInput Parameters
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.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.true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account.Output
List Usage Record All Time
List Usage Record All Time
TWILIO_LIST_USAGE_RECORD_ALL_TIMEList Usage Record All Time using the Twilio api_v2010 REST API.Input Parameters
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.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.true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account.Output
List Usage Record Daily
List Usage Record Daily
TWILIO_LIST_USAGE_RECORD_DAILYList Usage Record Daily using the Twilio api_v2010 REST API.Input Parameters
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.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.true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account.Output
List Usage Record Last Month
List Usage Record Last Month
TWILIO_LIST_USAGE_RECORD_LAST_MONTHList Usage Record Last Month using the Twilio api_v2010 REST API.Input Parameters
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.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.true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account.Output
List Usage Record Monthly
List Usage Record Monthly
TWILIO_LIST_USAGE_RECORD_MONTHLYList Usage Record Monthly using the Twilio api_v2010 REST API.Input Parameters
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.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.true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account.Output
List Usage Record This Month
List Usage Record This Month
TWILIO_LIST_USAGE_RECORD_THIS_MONTHList Usage Record This Month using the Twilio api_v2010 REST API.Input Parameters
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.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.true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account.Output
List Usage Record Today
List Usage Record Today
TWILIO_LIST_USAGE_RECORD_TODAYList Usage Record Today using the Twilio api_v2010 REST API.Input Parameters
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.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.true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account.Output
List Usage Record Yearly
List Usage Record Yearly
TWILIO_LIST_USAGE_RECORD_YEARLYList Usage Record Yearly using the Twilio api_v2010 REST API.Input Parameters
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.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.true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account.Output
List Usage Record Yesterday
List Usage Record Yesterday
TWILIO_LIST_USAGE_RECORD_YESTERDAYList Usage Record Yesterday using the Twilio api_v2010 REST API.Input Parameters
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.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.true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account.Output
List Usage Trigger
List Usage Trigger
TWILIO_LIST_USAGE_TRIGGERRetrieve a list of usage-triggers belonging to the account used to make the requestInput Parameters
daily, monthly, or yearly to read recurring UsageTriggers. An empty value or a value of alltime reads non-recurring UsageTriggers.count, usage, or price as described in the UsageRecords documentation.Output
Create Alpha Sender
Create Alpha Sender
TWILIO_MESSAGING_CREATE_ALPHA_SENDERCreate Alpha Sender using the Twilio messaging_v1 REST API.Input Parameters
-, plus +, underscore _ and ampersand &. This value cannot contain only numbers.Output
Create Brand Registration Otp
Create Brand Registration Otp
Create Brand Registrations
Create Brand Registrations
TWILIO_MESSAGING_CREATE_BRAND_REGISTRATIONSCreate Brand Registrations using the Twilio messaging_v1 REST API.Input Parameters
Output
Create Brand Vetting
Create Brand Vetting
Create Channel Sender
Create Channel Sender
Create Destination Alpha Sender
Create Destination Alpha Sender
TWILIO_MESSAGING_CREATE_DESTINATION_ALPHA_SENDERCreate Destination Alpha Sender using the Twilio messaging_v1 REST API.Input Parameters
-, plus +, underscore _ and ampersand &. This value cannot contain only numbers.Output
Create External Campaign
Create External Campaign
TWILIO_MESSAGING_CREATE_EXTERNAL_CAMPAIGNCreate External Campaign using the Twilio messaging_v1 REST API.Input Parameters
Output
Create Linkshortening Messaging Service
Create Linkshortening Messaging Service
TWILIO_MESSAGING_CREATE_LINKSHORTENING_MESSAGING_SERVICECreate Linkshortening Messaging Service using the Twilio messaging_v1 REST API.Input Parameters
Output
Create Phone Number
Create Phone Number
Create Service
Create Service
TWILIO_MESSAGING_CREATE_SERVICECreate Service using the Twilio messaging_v1 REST API.Input Parameters
notifications, marketing, verification, discussion, poll, undeclared.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.inbound_request_url. Can be GET or POST and the default is POST.1 to 36,000. Default value is 36,000.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.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
Create Short Code
Create Short Code
Create Tollfree Verification
Create Tollfree Verification
TWILIO_MESSAGING_CREATE_TOLLFREE_VERIFICATIONCreate a tollfree verificationInput Parameters
Output
Create Us App To Person
Create Us App To Person
TWILIO_MESSAGING_CREATE_US_APP_TO_PERSONCreate Us App To Person using the Twilio messaging_v1 REST API.Input Parameters
Output
Delete Alpha Sender
Delete Alpha Sender
Delete Channel Sender
Delete Channel Sender
Delete Destination Alpha Sender
Delete Destination Alpha Sender
Delete Domain Cert V4
Delete Domain Cert V4
Delete Linkshortening Messaging Service
Delete Linkshortening Messaging Service
TWILIO_MESSAGING_DELETE_LINKSHORTENING_MESSAGING_SERVICEDelete Linkshortening Messaging Service using the Twilio messaging_v1 REST API.Input Parameters
Output
Delete Phone Number
Delete Phone Number
Delete Service
Delete Service
Delete Short Code
Delete Short Code
Delete Tollfree Verification
Delete Tollfree Verification
Delete Us App To Person
Delete Us App To Person
Fetch Alpha Sender
Fetch Alpha Sender
Fetch Brand Registrations
Fetch Brand Registrations
Fetch Brand Vetting
Fetch Brand Vetting
Fetch Channel Sender
Fetch Channel Sender
Fetch Deactivation
Fetch Deactivation
TWILIO_MESSAGING_FETCH_DEACTIVATIONFetch a list of all United States numbers that have been deactivated on a specific date.Input Parameters
Output
Fetch Destination Alpha Sender
Fetch Destination Alpha Sender
Fetch Domain Cert V4
Fetch Domain Cert V4
Fetch Domain Config
Fetch Domain Config
Fetch Domain Config Messaging Service
Fetch Domain Config Messaging Service
Fetch Domain Dns Validation
Fetch Domain Dns Validation
Fetch Linkshortening Messaging Service Domain Association
Fetch Linkshortening Messaging Service Domain Association
Fetch Phone Number
Fetch Phone Number
Fetch Service
Fetch Service
Fetch Short Code
Fetch Short Code
Fetch Tollfree Verification
Fetch Tollfree Verification
Fetch Us App To Person
Fetch Us App To Person
Fetch Us App To Person Usecase
Fetch Us App To Person Usecase
Fetch Usecase
Fetch Usecase
List Alpha Sender
List Alpha Sender
List Brand Registrations
List Brand Registrations
List Brand Vetting
List Brand Vetting
List Channel Sender
List Channel Sender
List Destination Alpha Sender
List Destination Alpha Sender
List Phone Number
List Phone Number
List Service
List Service
List Short Code
List Short Code
List Tollfree Verification
List Tollfree Verification
List Us App To Person
List Us App To Person
Update Brand Registrations
Update Brand Registrations
Update Domain Cert V4
Update Domain Cert V4
TWILIO_MESSAGING_UPDATE_DOMAIN_CERT_V4Update Domain Cert V4 using the Twilio messaging_v1 REST API.Input Parameters
Output
Update Domain Config
Update Domain Config
TWILIO_MESSAGING_UPDATE_DOMAIN_CONFIGUpdate Domain Config using the Twilio messaging_v1 REST API.Input Parameters
Output
Update Request Managed Cert
Update Request Managed Cert
Update Service
Update Service
TWILIO_MESSAGING_UPDATE_SERVICEUpdate Service using the Twilio messaging_v1 REST API.Input Parameters
notifications, marketing, verification, discussion, poll, undeclared.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.inbound_request_url. Can be GET or POST and the default is POST.1 to 36,000. Default value is 36,000.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.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
Update Tollfree Verification
Update Tollfree Verification
TWILIO_MESSAGING_UPDATE_TOLLFREE_VERIFICATIONEdit a tollfree verificationInput Parameters
Output
Update Us App To Person
Update Us App To Person
TWILIO_MESSAGING_UPDATE_US_APP_TO_PERSONUpdate Us App To Person using the Twilio messaging_v1 REST API.Input Parameters
Output
Create Bulk Eligibility
Create Bulk Eligibility
Create Eligibility
Create Eligibility
Create Porting Port In
Create Porting Port In
TWILIO_NUMBERS_CREATE_PORTING_PORT_INAllows to create a new port in requestInput Parameters
Output
Create Porting Webhook Configuration
Create Porting Webhook Configuration
Create Sender Id Registration
Create Sender Id Registration
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
Output
Create Sender Id Registration Embedded Session
Create Sender Id Registration Embedded Session
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
Output
Create Signing Request Configuration
Create Signing Request Configuration
Create Sms Verification
Create Sms Verification
Create Sms Verification Check
Create Sms Verification Check
Create Voice Verification
Create Voice Verification
Delete Porting Port In
Delete Porting Port In
Delete Porting Port In Phone Number
Delete Porting Port In Phone Number
Delete Porting Webhook Configuration Delete
Delete Porting Webhook Configuration Delete
Fetch Bulk Eligibility
Fetch Bulk Eligibility
Fetch Porting Portability
Fetch Porting Portability
TWILIO_NUMBERS_FETCH_PORTING_PORTABILITYCheck if a single phone number can be ported to TwilioInput Parameters
Output
Fetch Porting Port In
Fetch Porting Port In
Fetch Porting Port In Phone Number
Fetch Porting Port In Phone Number
Fetch Porting Webhook Configuration Fetch
Fetch Porting Webhook Configuration Fetch
List Port In Requests
List Port In Requests
List Signing Request Configuration
List Signing Request Configuration
Send SMS
Send SMS
Create Execution
Create Execution
TWILIO_STUDIO_CREATE_EXECUTIONTriggers a new Execution for the FlowInput Parameters
{{contact.channel.address}}.{{flow.channel.address}}. For SMS, this can also be a Messaging Service SID.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
Delete Execution
Delete Execution
Fetch Execution Context
Fetch Execution Context
Fetch Execution Step Context
Fetch Execution Step Context
Fetch Flow Revision
Fetch Flow Revision
List Execution
List Execution
TWILIO_STUDIO_LIST_EXECUTIONRetrieve a list of all Executions for the Flow.Input Parameters
active or ended.YYYY-MM-DDThh:mm:ss-hh:mm.YYYY-MM-DDThh:mm:ss-hh:mm.Output
List Execution Step
List Execution Step
List Flow Revision
List Flow Revision
Update Execution
Update Execution
Update Flow Validate
Update Flow Validate
Update Account
Update Account
Update Address
Update Address
TWILIO_UPDATE_ADDRESSUpdate Address using the Twilio api_v2010 REST API.Input Parameters
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
Update Application
Update Application
TWILIO_UPDATE_APPLICATIONUpdates the application’s propertiesInput Parameters
2010-04-01 or 2008-08-01. The default value is your account’s default API version.status_callback_method to send status information to your application.sms_url.url.voice_fallback_url. Can be: GET or POST.true or false.true or false.Output
Update Call
Update Call
TWILIO_UPDATE_CALLInitiates a call redirect or terminates a callInput Parameters
method when the call connects. For more information, see the Url Parameter section in Making Calls.url. Can be: GET or POST and the default is POST. If an application_sid parameter is present, this parameter is ignored.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.fallback_url. Can be: GET or POST and the default is POST. If an application_sid parameter is present, this parameter is ignored.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).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
Update Call Recording
Update Call Recording
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
processing, completed and absent. For more detailed statuses on in-progress recordings, check out how to Update a Recording Resource.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
Update Conference
Update Conference
TWILIO_UPDATE_CONFERENCEUpdate Conference using the Twilio api_v2010 REST API.Input Parameters
<Play>, <Say>, <Pause>, or <Redirect> verbs.announce_url. Can be: GET or POST and the default is POSTOutput
Update Conference Recording
Update Conference Recording
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
Twilio.CURRENT to reference the current active recording.processing, completed and absent. For more detailed statuses on in-progress recordings, check out how to Update a Recording Resource.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
Update Connect App
Update Connect App
TWILIO_UPDATE_CONNECT_APPUpdate a connect-app with the specified parametersInput Parameters
get-all and post-all.Output
Update Incoming Phone Number
Update Incoming Phone Number
TWILIO_UPDATE_INCOMING_PHONE_NUMBERUpdate an incoming-phone-number instance.Input Parameters
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.voice_url will not be called if a voice_application_sid or a trunk_sid is set.sms_url. Can be: GET or POST and defaults to POST.2010-04-01.voice_url. Can be: GET or POST and defaults to POST.status_callback_method to send status information to your application.sms_url.url.sms_application_sid is present, we ignore all of the sms_*_url urls and use those set on the application.sms_fallback_url. Can be: GET or POST and defaults to POST.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.voice_fallback_url. Can be: GET or POST and defaults to POST.status_callback. Can be: GET or POST and defaults to POST.true or false and defaults to false.Output
Update Key
Update Key
Update Member
Update Member
TWILIO_UPDATE_MEMBERDequeue a member from a queue and have the member’s call begin executing the TwiML document at that URLInput Parameters
GET or POST and the default is POST. POST sends the data as encoded form data and GET sends the data as query parameters.Output
Update Message
Update Message
Update Outgoing Caller Id
Update Outgoing Caller Id
Update Participant
Update Participant
TWILIO_UPDATE_PARTICIPANTUpdate the properties of the participantInput Parameters
true or false. true puts the participant on hold, and false lets them rejoin the conference.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.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.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.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.hold_url. Can be: GET or POST and the default is GET.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.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.true or false.announce_url. Can be: GET or POST and defaults to POST.coached. The participant being coached is the only participant who can hear the participant who is coaching.true or false and defaults to false.Output
Update Payments
Update Payments
TWILIO_UPDATE_PAYMENTSupdate an instance of payments with different phases of payment flows.Input Parameters
cancel the payment session is cancelled. When complete, Twilio sends the payment information to the selected Pay Connector for processing.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.Output
Update Queue
Update Queue
Update Realtime Transcription
Update Realtime Transcription
Update Short Code
Update Short Code
TWILIO_UPDATE_SHORT_CODEUpdate a short code with the following parametersInput Parameters
FriendlyName is the short code.sms_url.sms_fallback_url. Can be: GET or POST.Output
Update Signing Key
Update Signing Key
Update Sip Credential
Update Sip Credential
Update Sip Credential List
Update Sip Credential List
Update Sip Domain
Update Sip Domain
TWILIO_UPDATE_SIP_DOMAINUpdate the attributes of a domainInput Parameters
sip.twilio.com.true or false. true allows SIP Endpoints to register with the domain to receive calls, false does not.voice_url.voice_fallback_url. Can be: GET or POST.voice_status_callback_url. Can be: GET or POST.Output
Update Sip Ip Access Control List
Update Sip Ip Access Control List
Update Sip Ip Address
Update Sip Ip Address
TWILIO_UPDATE_SIP_IP_ADDRESSUpdate an IpAddress resource.Input Parameters
Output
Update Siprec
Update Siprec
Update Stream
Update Stream
Update Usage Trigger
Update Usage Trigger
TWILIO_UPDATE_USAGE_TRIGGERUpdate an instance of a usage triggerInput Parameters
callback_url. Can be: GET or POST and the default is POST.Output
Create Access Token
Create Access Token
TWILIO_VERIFY_CREATE_ACCESS_TOKENCreate a new enrollment Access Token for the EntityInput Parameters
Output
Create Bucket
Create Bucket
Create Challenge
Create Challenge
TWILIO_VERIFY_CREATE_CHALLENGECreate a new Challenge for the FactorInput Parameters
totp to carry the TOTP code that needs to be verified. For TOTP this value must be between 3 and 8 characters long.factor_type is push. There can be up to 20 details fields.{"ip": "172.168.1.234"}. Can be up to 1024 characters in lengthfactor_type is push. Can be up to 256 characters in lengthOutput
Create Challenge Passkeys
Create Challenge Passkeys
Create Entity
Create Entity
TWILIO_VERIFY_CREATE_ENTITYCreate a new Entity for the ServiceInput Parameters
Output
Create Messaging Configuration
Create Messaging Configuration
TWILIO_VERIFY_CREATE_MESSAGING_CONFIGURATIONCreate a new MessagingConfiguration for a service.Input Parameters
all.Output
Create New Factor
Create New Factor
TWILIO_VERIFY_CREATE_NEW_FACTORCreate a new Factor for the EntityInput Parameters
{"os": "Android"}. Can be up to 1024 characters in length.totp.skew. If not configured defaults to 1. Used when factor_type is totppush and totp are supported.com.example.myapp. It can be up to 100 characters long. Required when factor_type is push.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.factor_type is totptotp.time_step. Defaults to 30 seconds if not configured. Used when factor_type is totpfactor_type is pushtotp.code_length. If not configured defaults to 6. Used when factor_type is totpfactor_type is push.Output
Create New Factor Passkey
Create New Factor Passkey
Create Notification
Create Notification
TWILIO_VERIFY_CREATE_NOTIFICATIONCreate a new Notification for the corresponding ChallengeInput Parameters
Output
Create Rate Limit
Create Rate Limit
Create Safelist
Create Safelist
Create Service
Create Service
TWILIO_VERIFY_CREATE_SERVICECreate a new Verification Service.Input Parameters
date_created, please use that one instead.example.com. It is used to identify your application when creating Passkeys.required, preferred or discouraged.Example App. It is used to identify your application when creating Passkeys.Your AppName verification code is: 1234. Don’t share this code with anyone; our employees will never ask for the codelogin.example.com,www.example.com. It is used to identify your application when creating Passkeys, it can have multiple origins split by ,.platform, cross-platform or any.required, preferred or discouraged.Output
Create Verification
Create Verification
TWILIO_VERIFY_CREATE_VERIFICATIONCreate a new Verification using a ServiceInput Parameters
<#> Your AppName verification code is: 1234 He42w354ol9.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.enable(default) or disable. For SMS channel only.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.Templates parameter is also provided, Templates takes precedence over this parameter.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.Output
Create Verification Check
Create Verification Check
TWILIO_VERIFY_CREATE_VERIFICATION_CHECKchallenge a specific Verification Check.Input Parameters
verification_sid must be specified. Phone numbers must be in E.164 format.to phone number/email must be specified.Output
Create Webhook
Create Webhook
TWILIO_VERIFY_CREATE_WEBHOOKCreate a new Webhook for the ServiceInput Parameters
enabled. One of: enabled or disabledv2 which includes all the latest fields. Version v1 is legacy and may be removed in the future.*, factor.deleted, factor.created, factor.verified, challenge.approved, challenge.deniedOutput
Delete Entity
Delete Entity
TWILIO_VERIFY_DELETE_ENTITYDelete a specific Entity.Input Parameters
Output
Delete Factor
Delete Factor
TWILIO_VERIFY_DELETE_FACTORDelete a specific Factor.Input Parameters
Output
Delete Messaging Configuration
Delete Messaging Configuration
Delete Rate Limit
Delete Rate Limit
Delete Safelist
Delete Safelist
Delete Service
Delete Service
Fetch Access Token
Fetch Access Token
Fetch Challenge
Fetch Challenge
TWILIO_VERIFY_FETCH_CHALLENGEFetch a specific Challenge.Input Parameters
Output
Fetch Entity
Fetch Entity
TWILIO_VERIFY_FETCH_ENTITYFetch a specific Entity.Input Parameters
Output
Fetch Factor
Fetch Factor
TWILIO_VERIFY_FETCH_FACTORFetch a specific Factor.Input Parameters
Output
Fetch Form
Fetch Form
Fetch Messaging Configuration
Fetch Messaging Configuration
Fetch Rate Limit
Fetch Rate Limit
Fetch Safelist
Fetch Safelist
Fetch Service
Fetch Service
Fetch Verification
Fetch Verification
Fetch Verification Attempt
Fetch Verification Attempt
Fetch Verification Attempts Summary
Fetch Verification Attempts Summary
TWILIO_VERIFY_FETCH_VERIFICATION_ATTEMPTS_SUMMARYGet a summary of how many attempts were made and how many were converted.Input Parameters
Output
List Bucket
List Bucket
List Challenge
List Challenge
TWILIO_VERIFY_LIST_CHALLENGERetrieve a list of all Challenges for a Factor.Input Parameters
asc or desc for ascending and descending respectively. Defaults to asc.pending, expired, approved or denied.Output
List Entity
List Entity
List Factor
List Factor
TWILIO_VERIFY_LIST_FACTORRetrieve a list of all Factors for an Entity.Input Parameters
Output
List Messaging Configuration
List Messaging Configuration
List Rate Limit
List Rate Limit
List Service
List Service
List Verification Attempt
List Verification Attempt
TWILIO_VERIFY_LIST_VERIFICATION_ATTEMPTList all the verification attempts for a given Account.Input Parameters
UNCONVERTED, for attempts that were not converted, and CONVERTED, for attempts that were confirmed.Output
List Verification Template
List Verification Template
List Webhook
List Webhook
Update Challenge
Update Challenge
TWILIO_VERIFY_UPDATE_CHALLENGEVerify a specific Challenge.Input Parameters
{"os": "Android"}. Can be up to 1024 characters in length.TOTP this value must be between 3 and 8 characters long. For Push this value can be up to 5456 characters in lengthOutput
Update Challenge Passkeys
Update Challenge Passkeys
TWILIO_VERIFY_UPDATE_CHALLENGE_PASSKEYSApprove a Passkeys challengeInput Parameters
AuthenticatorAssertion and AuthenticatorAttestation structures according to the type of the authenticator.navigator.credentials.get() request, as specified in AuthenticatorAttestationResponse.navigator.credentials.create() or navigator.credentials.get() call completes.Output
Update Factor
Update Factor
TWILIO_VERIFY_UPDATE_FACTORUpdate a specific Factor. This endpoint can be used to Verify a Factor if passed an AuthPayload param.Input Parameters
factor_type is push. If specified, this value must be between 32 and 255 characters long.apn, fcm or none. Required when factor_type is push.Output
Update Messaging Configuration
Update Messaging Configuration
TWILIO_VERIFY_UPDATE_MESSAGING_CONFIGURATIONUpdate a specific MessagingConfigurationInput Parameters
all.Output
Update Passkeys Factor
Update Passkeys Factor
TWILIO_VERIFY_UPDATE_PASSKEYS_FACTORVerify a Passkeys FactorInput Parameters
AuthenticatorAssertion and AuthenticatorAttestation structures according to the type of the authenticator.navigator.credentials.create(), as specified in AuthenticatorAttestationResponse.navigator.credentials.create() or navigator.credentials.get() call completes.Output
Update Rate Limit
Update Rate Limit
Update Service
Update Service
TWILIO_VERIFY_UPDATE_SERVICEUpdate a specific Verification Service.Input Parameters
example.com. It is used to identify your application when creating Passkeys.required, preferred or discouraged.Example App. It is used to identify your application when creating Passkeys.login.example.com,www.example.com. It is used to identify your application when creating Passkeys, it can have multiple origins split by ,.platform, cross-platform or any.required, preferred or discouraged.Output
Update Verification
Update Verification
Update Webhook
Update Webhook
TWILIO_VERIFY_UPDATE_WEBHOOKUpdate Webhook using the Twilio verify_v2 REST API.Input Parameters
enabled. One of: enabled or disabledv2 which includes all the latest fields. Version v1 is legacy and may be removed in the future.*, factor.deleted, factor.created, factor.verified, challenge.approved, challenge.deniedOutput
Triggers
Call Answered
Call Answered
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
Payload
request.parameters.CallSid is absent on some.Call Answering Machine Detected
Call Answering Machine Detected
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
request.parameters.CallSid is absent on some.Call Completed
Call Completed
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
Payload
request.parameters.CallSid is absent on some.Call Created Via API
Call Created Via API
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
request.parameters.CallSid is absent on some.Call Initiated
Call Initiated
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
Payload
request.parameters.CallSid is absent on some.Call Modified Via API
Call Modified Via API
Call Quality Metrics Received
Call Quality Metrics Received
Call Recording Ready
Call Recording Ready
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
request.parameters.CallSid is absent on some.Call Ringing
Call Ringing
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
Payload
request.parameters.CallSid is absent on some.Conversation Created
Conversation Created
Conversation Message Added
Conversation Message Added
Conversation Message Removed
Conversation Message Removed
Conversation Message Updated
Conversation Message Updated
Conversation Participant Added
Conversation Participant Added
Conversation Participant Removed
Conversation Participant Removed
Conversation Participant Updated
Conversation Participant Updated
Conversation Removed
Conversation Removed
Conversation State Changed
Conversation State Changed
Conversation Updated
Conversation Updated
Conversation User Created
Conversation User Created
Conversation User Updated
Conversation User Updated
Error Logged
Error Logged
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
Payload
Message Delivered
Message Delivered
TWILIO_MESSAGE_DELIVEREDType: webhookTriggers when the carrier confirms an outbound message reached the handset.Configuration
Payload
Message Delivery Failed
Message Delivery Failed
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
Payload
Message Queued
Message Queued
TWILIO_MESSAGE_QUEUEDType: webhookTriggers when an outbound message is accepted by Twilio and queued for sending.Configuration
Payload
Message Read
Message Read
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
Payload
Message Received
Message Received
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
Payload
Message Sent
Message Sent
TWILIO_MESSAGE_SENTType: webhookTriggers when an outbound message leaves Twilio and is handed to the carrier.Configuration
Payload
Studio Flow Execution Ended
Studio Flow Execution Ended
TWILIO_STUDIO_FLOW_EXECUTION_ENDEDType: webhookTriggers when a Studio Flow execution finishes; ended_reason says whether it completed or was ended early.Configuration
Payload
Studio Flow Execution Started
Studio Flow Execution Started
TWILIO_STUDIO_FLOW_EXECUTION_STARTEDType: webhookTriggers when a Studio Flow execution begins for a contact.Configuration
Payload
Studio Flow Step Ended
Studio Flow Step Ended
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
Payload
TaskRouter API Rate Limit Evaluated
TaskRouter API Rate Limit Evaluated
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
Payload
TaskRouter Reservation Accepted
TaskRouter Reservation Accepted
TWILIO_TASKROUTER_RESERVATION_ACCEPTEDType: webhookTriggers when a worker accepts an offered task.Configuration
Payload
task, worker, task-queue.TaskRouter Reservation Created
TaskRouter Reservation Created
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
Payload
task, worker, task-queue.TaskRouter Task Completed
TaskRouter Task Completed
TWILIO_TASKROUTER_TASK_COMPLETEDType: webhookTriggers when a task is completed; payload.task_completed_reason carries the wrap-up reason.Configuration
Payload
task, worker, task-queue.TaskRouter Task Created
TaskRouter Task Created
TWILIO_TASKROUTER_TASK_CREATEDType: webhookTriggers when a new TaskRouter task enters a workflow.Configuration
Payload
task, worker, task-queue.Verification Approved
Verification Approved
TWILIO_VERIFICATION_APPROVEDType: webhookTriggers when the end user enters the correct verification code.Configuration
Payload
PENDING, APPROVED, EXPIRED, CANCELED or MAX_ATTEMPTS_REACHED.Verification Canceled
Verification Canceled
TWILIO_VERIFICATION_CANCELEDType: webhookTriggers when a verification is canceled through the API.Configuration
Payload
PENDING, APPROVED, EXPIRED, CANCELED or MAX_ATTEMPTS_REACHED.Verification Expired
Verification Expired
TWILIO_VERIFICATION_EXPIREDType: webhookTriggers when a verification expires before the user enters the code.Configuration
Payload
PENDING, APPROVED, EXPIRED, CANCELED or MAX_ATTEMPTS_REACHED.Verification Max Attempts Reached
Verification Max Attempts Reached
TWILIO_VERIFICATION_MAX_ATTEMPTS_REACHEDType: webhookTriggers when a verification hits its maximum check attempts — the fraud and abuse signal.Configuration
Payload
PENDING, APPROVED, EXPIRED, CANCELED or MAX_ATTEMPTS_REACHED.Verification Message Delivered
Verification Message Delivered
TWILIO_VERIFICATION_MESSAGE_DELIVEREDType: webhookTriggers when the carrier confirms a verification code message reached the handset.Configuration
Payload
Verification Message Delivery Failed
Verification Message Delivery Failed
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
Payload
Verification Message Read
Verification Message Read
TWILIO_VERIFICATION_MESSAGE_READType: webhookTriggers when the end user opens a verification code message. Read- receipt channels only — WhatsApp and RCS.Configuration
Payload
Verification Message Sent
Verification Message Sent
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
Payload
Verification Started
Verification Started
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
Payload
PENDING, APPROVED, EXPIRED, CANCELED or MAX_ATTEMPTS_REACHED.