Overview
Add Twilio to any ModuleX agent or workflow. Cloud communications platform for SMS messaging, voice calls, phone number lookup, and phone verification via the Twilio REST API (api.twilio.com).
Categories: Communication · SMS · Voice · Verification · Auth: Twilio Account Credentials · Actions: 17
Authentication
Twilio Account Credentials
Authenticate using your Twilio Account SID and Auth Token (HTTP Basic Auth).1
Step 1
Log in to the Twilio Console at https://console.twilio.com
2
Step 2
Your Account SID and Auth Token are on the dashboard home page.
Required Credentials
| Field | Description | Required | Format |
|---|---|---|---|
| Account SID | Your Twilio Account SID (starts with ‘AC’). | Yes | ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
| Auth Token | Your Twilio Auth Token from the Console dashboard. | Yes | - |
Available Actions
send_message — Send an SMS or MMS message with optional media files.
send_message — Send an SMS or MMS message with optional media files.
Parameters
string
required
The sender’s Twilio phone number in E.164 format (e.g., +15551234567).
string
required
The destination phone number in E.164 format (e.g., +16175551212).
string
required
The text of the message, limited to 1600 characters.
array
Array of URLs of media to include. Up to 10 URLs, max 5 MB each.
Response
{
"$defs": {
"MessageResource": {
"additionalProperties": false,
"properties": {
"sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sid"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"date_updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Updated"
},
"date_sent": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Sent"
},
"account_sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Sid"
},
"to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "To"
},
"from_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "From Number"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Body"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"num_segments": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Num Segments"
},
"num_media": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Num Media"
},
"direction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Direction"
},
"price": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Price"
},
"price_unit": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Price Unit"
},
"error_code": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Error Code"
},
"error_message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error Message"
},
"uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Uri"
}
},
"title": "MessageResource",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"message": {
"anyOf": [
{
"$ref": "#/$defs/MessageResource"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "SendMessageOutput",
"type": "object"
}
make_phone_call — Initiate a phone call using text-to-speech, a TwiML URL, or an application SID.
make_phone_call — Initiate a phone call using text-to-speech, a TwiML URL, or an application SID.
Parameters
string
required
The caller’s Twilio phone number in E.164 format.
string
required
The destination phone number in E.164 format.
string
required
How to handle the call. Allowed values: text, url, application.
string
Text for Twilio to speak when answered. Required when call_type is ‘text’.
string
URL returning TwiML instructions. Required when call_type is ‘url’.
string
SID of the Application resource. Required when call_type is ‘application’.
integer
Seconds to ring before assuming no answer (default 60, max 600).
boolean
Whether to record the call.
Response
{
"$defs": {
"CallResource": {
"additionalProperties": false,
"properties": {
"sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sid"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"date_updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Updated"
},
"account_sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Sid"
},
"to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "To"
},
"to_formatted": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "To Formatted"
},
"from_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "From Number"
},
"from_formatted": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "From Formatted"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"start_time": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Time"
},
"end_time": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "End Time"
},
"duration": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Duration"
},
"price": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Price"
},
"price_unit": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Price Unit"
},
"direction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Direction"
},
"uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Uri"
}
},
"title": "CallResource",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"call": {
"anyOf": [
{
"$ref": "#/$defs/CallResource"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "MakePhoneCallOutput",
"type": "object"
}
get_message — Retrieve details of a specific message by SID.
get_message — Retrieve details of a specific message by SID.
Parameters
string
required
The SID of the message to retrieve.
Response
{
"$defs": {
"MessageResource": {
"additionalProperties": false,
"properties": {
"sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sid"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"date_updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Updated"
},
"date_sent": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Sent"
},
"account_sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Sid"
},
"to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "To"
},
"from_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "From Number"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Body"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"num_segments": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Num Segments"
},
"num_media": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Num Media"
},
"direction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Direction"
},
"price": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Price"
},
"price_unit": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Price Unit"
},
"error_code": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Error Code"
},
"error_message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error Message"
},
"uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Uri"
}
},
"title": "MessageResource",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"message": {
"anyOf": [
{
"$ref": "#/$defs/MessageResource"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "GetMessageOutput",
"type": "object"
}
delete_message — Delete a message record from your account.
delete_message — Delete a message record from your account.
Parameters
string
required
The SID of the message to delete.
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
}
},
"required": [
"success"
],
"title": "DeleteMessageOutput",
"type": "object"
}
list_messages — List messages associated with your account, optionally filtered by sender or recipient.
list_messages — List messages associated with your account, optionally filtered by sender or recipient.
Parameters
string
Only return messages sent from this phone number in E.164 format.
string
Only return messages sent to this phone number in E.164 format.
integer
Maximum number of messages to return. (Default:
50)Response
{
"$defs": {
"MessageResource": {
"additionalProperties": false,
"properties": {
"sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sid"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"date_updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Updated"
},
"date_sent": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Sent"
},
"account_sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Sid"
},
"to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "To"
},
"from_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "From Number"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Body"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"num_segments": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Num Segments"
},
"num_media": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Num Media"
},
"direction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Direction"
},
"price": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Price"
},
"price_unit": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Price Unit"
},
"error_code": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Error Code"
},
"error_message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error Message"
},
"uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Uri"
}
},
"title": "MessageResource",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"messages": {
"items": {
"$ref": "#/$defs/MessageResource"
},
"title": "Messages",
"type": "array"
}
},
"required": [
"success"
],
"title": "ListMessagesOutput",
"type": "object"
}
list_message_media — List media resources associated with a message.
list_message_media — List media resources associated with a message.
Parameters
string
required
The SID of the message.
integer
Maximum number of media items to return. (Default:
50)Response
{
"$defs": {
"MediaResource": {
"additionalProperties": false,
"properties": {
"sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sid"
},
"content_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Content Type"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"date_updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Updated"
},
"uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Uri"
}
},
"title": "MediaResource",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"media": {
"items": {
"$ref": "#/$defs/MediaResource"
},
"title": "Media",
"type": "array"
}
},
"required": [
"success"
],
"title": "ListMessageMediaOutput",
"type": "object"
}
get_call — Retrieve details of a specific call by SID.
get_call — Retrieve details of a specific call by SID.
Parameters
string
required
The SID of the call to retrieve.
Response
{
"$defs": {
"CallResource": {
"additionalProperties": false,
"properties": {
"sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sid"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"date_updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Updated"
},
"account_sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Sid"
},
"to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "To"
},
"to_formatted": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "To Formatted"
},
"from_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "From Number"
},
"from_formatted": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "From Formatted"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"start_time": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Time"
},
"end_time": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "End Time"
},
"duration": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Duration"
},
"price": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Price"
},
"price_unit": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Price Unit"
},
"direction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Direction"
},
"uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Uri"
}
},
"title": "CallResource",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"call": {
"anyOf": [
{
"$ref": "#/$defs/CallResource"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "GetCallOutput",
"type": "object"
}
delete_call — Delete a call record from your account.
delete_call — Delete a call record from your account.
Parameters
string
required
The SID of the call to delete.
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
}
},
"required": [
"success"
],
"title": "DeleteCallOutput",
"type": "object"
}
list_calls — List calls associated with your account, optionally filtered by number, status, or parent call.
list_calls — List calls associated with your account, optionally filtered by number, status, or parent call.
Parameters
string
Only include calls from this phone number in E.164 format.
string
Only include calls to this phone number in E.164 format.
string
Only include calls spawned by the call with this SID.
string
Filter by status: queued, ringing, in-progress, canceled, completed, failed, busy, no-answer.
integer
Maximum number of calls to return. (Default:
50)Response
{
"$defs": {
"CallResource": {
"additionalProperties": false,
"properties": {
"sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sid"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"date_updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Updated"
},
"account_sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Sid"
},
"to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "To"
},
"to_formatted": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "To Formatted"
},
"from_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "From Number"
},
"from_formatted": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "From Formatted"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"start_time": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Time"
},
"end_time": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "End Time"
},
"duration": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Duration"
},
"price": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Price"
},
"price_unit": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Price Unit"
},
"direction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Direction"
},
"uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Uri"
}
},
"title": "CallResource",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"calls": {
"items": {
"$ref": "#/$defs/CallResource"
},
"title": "Calls",
"type": "array"
}
},
"required": [
"success"
],
"title": "ListCallsOutput",
"type": "object"
}
download_recording_media — Get the download URL for a call recording in the specified format.
download_recording_media — Get the download URL for a call recording in the specified format.
Parameters
string
required
The SID of the recording.
string
Audio format: .mp3 or .wav. (Default:
.wav)Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"download_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Download Url"
},
"recording_sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Recording Sid"
},
"format": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Format"
}
},
"required": [
"success"
],
"title": "DownloadRecordingMediaOutput",
"type": "object"
}
phone_number_lookup — Look up information about a phone number including line type intelligence.
phone_number_lookup — Look up information about a phone number including line type intelligence.
Parameters
string
required
The phone number to look up.
Response
{
"$defs": {
"LookupResult": {
"additionalProperties": false,
"properties": {
"phone_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Phone Number"
},
"country_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Country Code"
},
"calling_country_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Calling Country Code"
},
"national_format": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "National Format"
},
"valid": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Valid"
},
"validation_errors": {
"items": {
"type": "string"
},
"title": "Validation Errors",
"type": "array"
},
"line_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Line Type"
},
"carrier_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Carrier Name"
}
},
"title": "LookupResult",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"lookup": {
"anyOf": [
{
"$ref": "#/$defs/LookupResult"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "PhoneNumberLookupOutput",
"type": "object"
}
send_sms_verification — Send an SMS verification code to a phone number via Twilio Verify.
send_sms_verification — Send an SMS verification code to a phone number via Twilio Verify.
Parameters
string
required
The SID of the Verify service.
string
required
The destination phone number in E.164 format.
Response
{
"$defs": {
"VerificationResource": {
"additionalProperties": false,
"properties": {
"sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sid"
},
"service_sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Service Sid"
},
"account_sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Sid"
},
"to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "To"
},
"channel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Channel"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"valid": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Valid"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"date_updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Updated"
}
},
"title": "VerificationResource",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"verification": {
"anyOf": [
{
"$ref": "#/$defs/VerificationResource"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "SendSmsVerificationOutput",
"type": "object"
}
check_verification_token — Check if a user-provided verification code is correct.
check_verification_token — Check if a user-provided verification code is correct.
Parameters
string
required
The SID of the Verify service.
string
required
The phone number that received the verification code in E.164 format.
string
required
The verification code to check.
Response
{
"$defs": {
"VerificationResource": {
"additionalProperties": false,
"properties": {
"sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sid"
},
"service_sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Service Sid"
},
"account_sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Sid"
},
"to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "To"
},
"channel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Channel"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"valid": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Valid"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"date_updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Updated"
}
},
"title": "VerificationResource",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"verification": {
"anyOf": [
{
"$ref": "#/$defs/VerificationResource"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "CheckVerificationTokenOutput",
"type": "object"
}
create_verification_service — Create a new Twilio Verify service for sending SMS verifications.
create_verification_service — Create a new Twilio Verify service for sending SMS verifications.
Parameters
string
required
A human-readable name for the new verification service.
Response
{
"$defs": {
"VerificationServiceResource": {
"additionalProperties": false,
"properties": {
"sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sid"
},
"account_sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Sid"
},
"friendly_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Friendly Name"
},
"code_length": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Code Length"
},
"lookup_enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Lookup Enabled"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"date_updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Updated"
}
},
"title": "VerificationServiceResource",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"service": {
"anyOf": [
{
"$ref": "#/$defs/VerificationServiceResource"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "CreateVerificationServiceOutput",
"type": "object"
}
list_transcripts — List voice intelligence transcripts, optionally including transcript text.
list_transcripts — List voice intelligence transcripts, optionally including transcript text.
Parameters
boolean
Set to true to include transcript sentences in the response.
integer
Maximum number of transcripts to return. (Default:
50)Response
{
"$defs": {
"TranscriptResource": {
"additionalProperties": false,
"properties": {
"sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sid"
},
"account_sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Sid"
},
"service_sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Service Sid"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"date_updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Updated"
},
"duration": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Duration"
},
"channel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Channel"
},
"sentences": {
"items": {
"$ref": "#/$defs/TranscriptSentence"
},
"title": "Sentences",
"type": "array"
},
"transcript_text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Transcript Text"
}
},
"title": "TranscriptResource",
"type": "object"
},
"TranscriptSentence": {
"additionalProperties": false,
"properties": {
"media_channel": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Media Channel"
},
"sentence_index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Sentence Index"
},
"start_time": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Time"
},
"end_time": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "End Time"
},
"transcript": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Transcript"
},
"confidence": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Confidence"
}
},
"title": "TranscriptSentence",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"transcripts": {
"items": {
"$ref": "#/$defs/TranscriptResource"
},
"title": "Transcripts",
"type": "array"
}
},
"required": [
"success"
],
"title": "ListTranscriptsOutput",
"type": "object"
}
get_transcripts — Retrieve full transcripts with sentences for the specified transcript SIDs.
get_transcripts — Retrieve full transcripts with sentences for the specified transcript SIDs.
Parameters
array
required
Array of transcript SID strings to retrieve.
Response
{
"$defs": {
"TranscriptResource": {
"additionalProperties": false,
"properties": {
"sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sid"
},
"account_sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Sid"
},
"service_sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Service Sid"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"date_updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Updated"
},
"duration": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Duration"
},
"channel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Channel"
},
"sentences": {
"items": {
"$ref": "#/$defs/TranscriptSentence"
},
"title": "Sentences",
"type": "array"
},
"transcript_text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Transcript Text"
}
},
"title": "TranscriptResource",
"type": "object"
},
"TranscriptSentence": {
"additionalProperties": false,
"properties": {
"media_channel": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Media Channel"
},
"sentence_index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Sentence Index"
},
"start_time": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Time"
},
"end_time": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "End Time"
},
"transcript": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Transcript"
},
"confidence": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Confidence"
}
},
"title": "TranscriptSentence",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"transcripts": {
"items": {
"$ref": "#/$defs/TranscriptResource"
},
"title": "Transcripts",
"type": "array"
}
},
"required": [
"success"
],
"title": "GetTranscriptsOutput",
"type": "object"
}
list_phone_numbers — List incoming phone numbers on your Twilio account.
list_phone_numbers — List incoming phone numbers on your Twilio account.
Response
{
"$defs": {
"PhoneNumberInfo": {
"additionalProperties": false,
"properties": {
"sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sid"
},
"phone_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Phone Number"
},
"friendly_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Friendly Name"
}
},
"title": "PhoneNumberInfo",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"phone_numbers": {
"items": {
"$ref": "#/$defs/PhoneNumberInfo"
},
"title": "Phone Numbers",
"type": "array"
}
},
"required": [
"success"
],
"title": "ListPhoneNumbersOutput",
"type": "object"
}
Limits & Quotas
- SMS: Throughput varies by number type. Long codes: 1 SMS/sec (US/Canada). Toll-free: 3 SMS/sec. Short codes: 30+ SMS/sec.
- Voice: Concurrent call limits depend on your account type and phone numbers provisioned.
- Lookup: Charged per lookup. Standard rate lookup is included in the monthly fee; carrier/line-type lookups are billed per query.
- Verify: Each verification attempt is billed. See Twilio Verify pricing.
- Voice Intelligence: Charged per minute of audio transcribed.
- Error model: Non-2xx responses and timeouts are caught and returned as
success=False+errorrather than raising.