Twilio is currently in beta. The info in this guide is subject to change.
This integration is powered by Singer's Twilio tap and certified by Stitch. Check out and contribute to the repo on GitHub.
For support, contact Stitch support.
Twilio integration summary
Stitch’s Twilio integration replicates data using the Twilio REST API . Refer to the Schema section for a list of objects available for replication.
Twilio feature snapshot
A high-level look at Stitch's Twilio (v1) integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release status |
Beta |
Supported by | |
Stitch plan |
Standard |
API availability |
Available |
Singer GitHub repository | |||
REPLICATION SETTINGS | |||
Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
DATA SELECTION | |||
Table selection |
Supported |
Column selection |
Supported |
Select all |
Supported |
||
TRANSPARENCY | |||
Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Twilio
Step 1: Retrieve Auth token and Account SID
- Log into your Twilio account.
- Click on Console.
- Copy your Account SID and Auth Token and have it ready for the next step.
Step 2: Add Twilio as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Twilio icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch Twilio” would create a schema called
stitch_twilio
in the destination. Note: Schema names cannot be changed after you save the integration. - In the Account Sid field, paste the Account SID you copied in step 1.
- In the Auth Token field, paste the Auth Token you copied in step 1.
- In the Date Window Days field, enter a value. This parameter should be set to an optimum value to improve historical sync performance. Setting this value too low will take longer to complete historical sync and setting it larger may result in request timeouts or memory overflow issues. The default value is
30
.
Step 3: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Twilio integration. This means that:
- For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
- For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.
Change this setting if you want to replicate data beyond Twilio’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 4: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Twilio integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 5: Set objects to replicate
The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
For Twilio integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
Initial and historical replication jobs
After you finish setting up Twilio, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
Twilio table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
This is the latest version of the Twilio integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs
> customers
), while case is maintained in PostgreSQL destinations (CusTomERs
> CusTomERs
). Refer to the Loading Guide for your destination for more info.
accounts
Replication Method : |
Full Table |
Primary Key |
sid |
API endpoint : |
The accounts table returns a list of accounts in your Twilio account.
sid
A 34 character string that uniquely identifies this resource. |
||
auth_token
The authorization token for this account. This token should be kept a secret, so no sharing. |
||
date_created
The date that this account was created, in GMT in RFC 2822 format |
||
date_updated
The date that this account was last updated, in GMT in RFC 2822 format. |
||
friendly_name
A human readable description of this account, up to 64 characters long. By default the FriendlyName is your email address. |
||
owner_account_sid
The unique 34 character id that represents the parent of this account. The OwnerAccountSid of a parent account is it’s own sid. |
||
status
The status of this account. Usually active, but can be suspended or closed. |
||
subresource_uris
Various subresources available for the given Account Instance
|
||
type
The type of this account. Either Trial or Full if it’s been upgraded |
||
uri
The URI for this resource, relative to https://api.twilio.com |
account_balance
Replication Method : |
Full Table |
Primary Key |
account_sid |
API endpoint : |
The account_balance returns your Twilio acocunt balance.
account_sid
A 34 character string that uniquely identifies the account |
balance
Remaining account balance |
currency
Currency type |
addresses
Replication Method : |
Key-based Incremental |
Replication Key |
date_updated |
Primary Key |
sid |
API endpoint : |
The addresses table returns a list of address resource representations, each representing an address within your Twilio account.
sid
The unique string that that we created to identify the Address resource. |
date_updated
The date and time in GMT that the resource was last updated specified in RFC 2822 format. |
account_sid
The SID of the Account that is responsible for the Address resource |
city
The city in which the address is located. |
customer_name
The name associated with the address.This property has a maximum length of 16 4-byte characters, or 21 3-byte characters. |
date_created
The date and time in GMT that the resource was created specified in RFC 2822 format. |
emergency_enabled
Whether emergency calling has been enabled on this number. |
friendly_name
The string that you assigned to describe the resource. |
iso_country
The ISO country code of the address. |
postal_code
The postal code of the address. |
region
The state or region of the address. |
street
The number and street address of the address. |
uri
The URI of the resource, relative to https://api.twilio.com |
validated
Whether the address has been validated to comply with local regulation. In countries that require valid addresses, an invalid address will not be accepted. true indicates the Address has been validated. false indicate the country doesn’t require validation or the Address is not valid. |
verified
Whether the address has been verified to comply with regulation. In countries that require valid addresses, an invalid address will not be accepted. true indicates the Address has been verified. false indicate the country doesn’t require verified or the Address is not valid. |
alerts
Replication Method : |
Key-based Incremental |
Replication Key |
date_updated |
Primary Key |
sid |
API endpoint : |
The alerts returns a list of alerts generated for an account within your Twilio account.
sid
The unique string that we created to identify the Alert resource. |
date_updated
The date and time in GMT when the resource was last updated specified in ISO 8601 format. |
account_sid
The SID of the Account that created the Alert resource. |
alert_text
The text of the alert. |
api_version
The API version used when the alert was generated. Can be empty for events that don’t have a specific API version. |
date_created
The date and time in GMT when the resource was created specified in ISO 8601 format. |
date_generated
The date and time in GMT when the alert was generated specified in ISO 8601 format. Due to buffering, this can be different than date_created. |
error_code
The error code for the condition that generated the alert. See the Error Dictionary for possible causes and solutions to the error. |
log_level
The log level. Can be: error, warning, notice, or debug. |
more_info
The URL of the page in our Error Dictionary with more information about the error condition. |
request_method
The method used by the request that generated the alert. If the alert was generated by a request we made to your server, this is the method we used. If the alert was generated by a request from your application to our API, this is the method your application used. |
request_url
The URL of the request that generated the alert. If the alert was generated by a request we made to your server, this is the URL on your server that generated the alert. If the alert was generated by a request from your application to our API, this is the URL of the resource requested. |
resource_sid
The SID of the resource for which the alert was generated. For instance, if your server failed to respond to an HTTP request during the flow of a particular call, this value would be the SID of the server. This value is empty if the alert was not generated for a particular resource. |
service_sid
The SID of the service or resource that generated the alert. Can be null. |
url
The absolute URL of the Alert resource. |
applications
Replication Method : |
Key-based Incremental |
Replication Key |
date_created |
Primary Key |
sid |
API endpoint : |
The applications table returns a list of application resource representations, each representing an application within your Twilio account.
sid
The unique string that that we created to identify the Application resource. |
date_created
The date and time in GMT that the resource was created specified in RFC 2822 format. |
account_sid
The SID of the Account that created the Application resources to read. |
api_version
The API version used to start a new TwiML session. |
date_updated
The date and time in GMT that the resource was last updated specified in RFC 2822 format. |
friendly_name
The string that you assigned to describe the resource. |
message_status_callback
The URL we call using a POST method to send message status information to your application. |
sms_fallback_method
The HTTP method we use to call sms_fallback_url. Can be: GET or POST. |
sms_fallback_url
The URL that we call when an error occurs while retrieving or executing the TwiML from sms_url. |
sms_method
The HTTP method we use to call sms_url. Can be: GET or POST. |
sms_status_callback
The URL we call using a POST method to send status information to your application about SMS messages that refer to the application. |
sms_url
The URL we call when the phone number receives an incoming SMS message. |
status_callback
The URL we call using the status_callback_method to send status information to your application. |
status_callback_method
The HTTP method we use to call status_callback. Can be: GET or POST. |
uri
The URI of the resource, relative to https://api.twilio.com. |
voice_callback_id_lookup
Whether we look up the caller’s caller-ID name from the CNAM database (additional charges apply). Can be: true or false. |
voice_fallback_method
The HTTP method we use to call voice_fallback_url. Can be: GET or POST |
voice_fallback_url
The URL that we call when an error occurs retrieving or executing the TwiML requested by url. |
voice_method
The HTTP method we use to call voice_url. Can be: GET or POST. |
voice_url
The URL we call when the phone number assigned to this application receives a call. |
available_phone_numbers_local
Replication Method : |
Full Table |
Primary Key |
iso_country : phone_number |
API endpoint : |
The available_phone_numbers_local table returns a list of available phone numbers for local resources for your Twilio account.
iso_country
The ISO country code of this phone number. |
||||
phone_number
The phone number in E.164 format, which consists of a + followed by the country code and subscriber number. |
||||
address_requirements
The type of Address resource the phone number requires. Can be: none, any, local, or foreign. none means no address is required. any means an address is required, but it can be anywhere in the world. local means an address in the phone number’s country is required. foreign means an address outside of the phone number’s country is required. |
||||
beta
Whether the phone number is new to the Twilio platform. Can be: true or false. |
||||
capabilities
The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: Voice, SMS, and MMS and each capability can be: true or false.
|
||||
friendly_name
A formatted version of the phone number. |
||||
lata
The LATA of this phone number. Available for only phone numbers from the US and Canada. |
||||
latitude
The longitude of this phone number’s location. Available for only phone numbers from the US and Canada. |
||||
locality
The locality or city of this phone number’s location. |
||||
longitude
The longitude of this phone number’s location. Available for only phone numbers from the US and Canada. |
||||
postal_code
The postal or ZIP code of this phone number’s location. Available for only phone numbers from the US and Canada. |
||||
rate_center
The rate center of this phone number. Available for only phone numbers from the US and Canada. |
||||
region
The two-letter state or province abbreviation of this phone number’s location. Available for only phone numbers from the US and Canada. |
available_phone_numbers_mobile
Replication Method : |
Full Table |
Primary Key |
iso_country : phone_number |
API endpoint : |
The available_phone_numbers_mobile table returns a list of available phone numbers for mobile resources for your Twilio account.
iso_country
The ISO country code of this phone number. |
||||
phone_number
The phone number in E.164 format, which consists of a + followed by the country code and subscriber number. |
||||
address_requirements
The type of Address resource the phone number requires. Can be: none, any, local, or foreign. none means no address is required. any means an address is required, but it can be anywhere in the world. local means an address in the phone number’s country is required. foreign means an address outside of the phone number’s country is required. |
||||
beta
Whether the phone number is new to the Twilio platform. Can be: true or false. |
||||
capabilities
The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: Voice, SMS, and MMS and each capability can be: true or false.
|
||||
friendly_name
A formatted version of the phone number. |
||||
lata
The LATA of this phone number. Available for only phone numbers from the US and Canada. |
||||
latitude
The latitude of this phone number’s location. Available for only phone numbers from the US and Canada. |
||||
locality
The locality or city of this phone number’s location. |
||||
longitude
The longitude of this phone number’s location. Available for only phone numbers from the US and Canada. |
||||
postal_code
The postal or ZIP code of this phone number’s location. Available for only phone numbers from the US and Canada. |
||||
rate_center
The rate center of this phone number. Available for only phone numbers from the US and Canada. |
||||
region
The two-letter state or province abbreviation of this phone number’s location. Available for only phone numbers from the US and Canada. |
available_phone_numbers_toll_free
Replication Method : |
Full Table |
Primary Key |
iso_country : phone_number |
API endpoint : |
The available_phone_numbers_toll_free table returns a list of available toll free phone numbers for your Twilio account.
iso_country
The ISO country code of this phone number. |
||||
phone_number
The phone number in E.164 format, which consists of a + followed by the country code and subscriber number. |
||||
address_requirements
The type of Address resource the phone number requires. Can be: none, any, local, or foreign. none means no address is required. any means an address is required, but it can be anywhere in the world. local means an address in the phone number’s country is required. foreign means an address outside of the phone number’s country is required. |
||||
beta
Whether the phone number is new to the Twilio platform. Can be: true or false. |
||||
capabilities
The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: Voice, SMS, and MMS and each capability can be: true or false.
|
||||
friendly_name
A formatted version of the phone number. |
||||
lata
The LATA of this phone number. Available for only phone numbers from the US and Canada. |
||||
latitude
The latitude of this phone number’s location. Available for only phone numbers from the US and Canada. |
||||
locality
The locality or city of this phone number’s location. |
||||
longitude
The longitude of this phone number’s location. Available for only phone numbers from the US and Canada. |
||||
postal_code
The postal or ZIP code of this phone number’s location. Available for only phone numbers from the US and Canada. |
||||
rate_center
The rate center of this phone number. Available for only phone numbers from the US and Canada. |
||||
region
The two-letter state or province abbreviation of this phone number’s location. Available for only phone numbers from the US and Canada. |
available_phone_number_countries
Replication Method : |
Full Table |
Primary Key |
country_code |
API endpoint : |
The available_phone_number_countries table returns a list of countries that have phone numbers to purchase for your Twilio account.
country_code
The ISO-3166-1 country code of the country. |
||
beta
Whether all phone numbers available in the country are new to the Twilio platform. true if they are and false if all numbers are not in the Twilio Phone Number Beta program. |
||
country
The name of the country. |
||
subresource_uris
A list of related AvailablePhoneNumber resources identified by their URIs relative to https://api.twilio.com
|
||
uri
The URI of the resource, relative to https://api.twilio.com |
Replication Method : |
Key-based Incremental |
Replication Key |
date_updated |
Primary Key |
sid |
API endpoint : |
The calls table returns a list of phone calls made to and from an account in your Twilio account, identified by its AccountSid
.
sid
The unique string that we created to identify this Call resource. |
||
date_updated
The date and time in GMT that this resource was last updated, specified in RFC 2822 format. |
||
account_sid
The SID of the Account that created this Call resource. |
||
annotation
|
||
answered_by
Either human or machine if this call was initiated with answering machine detection. Empty otherwise. |
||
api_version
The API version used to create the call. |
||
caller_name
The caller’s name if this call was an incoming call to a phone number with caller ID Lookup enabled. Otherwise, empty. |
||
date_created
The date and time in GMT that this resource was created specified in RFC 2822 format. |
||
direction
A string describing the direction of the call. Can be: inbound for inbound calls, outbound-api for calls initiated via the REST API or outbound-dial for calls initiated by a |
||
duration
The length of the call in seconds. This value is empty for busy, failed, unanswered, or ongoing calls. |
||
end_time
The time the call ended, given as GMT in RFC 2822 format. Empty if the call did not complete successfully. |
||
forwarded_from
The forwarding phone number if this call was an incoming call forwarded from another number (depends on carrier supporting forwarding). Otherwise, empty. |
||
from
The phone number, SIP address, Client identifier or SIM SID that made this call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as name@company.com. Client identifiers are formatted client:name. SIM SIDs are formatted as sim:sid. |
||
from_formatted
The calling phone number, SIP address, or Client identifier formatted for display. Non-North American phone numbers are in E.164 format (e.g., +442071838750). |
||
group_sid
The Group SID associated with this call. If no Group is associated with the call, the field is empty. |
||
parent_call_sid
The SID that identifies the call that created this leg. |
||
phone_number_sid
If the call was inbound, this is the SID of the IncomingPhoneNumber resource that received the call. If the call was outbound, it is the SID of the OutgoingCallerId resource from which the call was placed. |
||
price
The charge for this call, in the currency associated with the account. Populated after the call is completed. May not be immediately available. |
||
price_unit
The currency in which Price is measured, in ISO 4127 format (e.g., USD, EUR, JPY). Always capitalized for calls. |
||
queue_time
The wait time in milliseconds before the call is placed. |
||
start_time
The start time of the call, given as GMT in RFC 2822 format. Empty if the call has not yet been dialed. |
||
status
The status of this call. Can be: queued, ringing, in-progress, canceled, completed, failed, busy or no-answer |
||
subresource_uris
A list of subresources available to this call, identified by their URIs relative to https://api.twilio.com.
|
||
to
The phone number, SIP address, Client identifier or SIM SID that received this call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as name@company.com. Client identifiers are formatted client:name. SIM SIDs are formatted as sim:sid. |
||
to_formatted
The phone number, SIP address or Client identifier that received this call. Formatted for display. Non-North American phone numbers are in E.164 format (e.g., +442071838750). |
||
trunk_sid
The unique identifier of the trunk resource that was used for this call. The field is empty if the call was not made using a SIP trunk or if the call is not terminated. |
||
uri
The URI of this resource, relative to https://api.twilio.com. |
conferences
Replication Method : |
Key-based Incremental |
Replication Key |
date_updated |
Primary Key |
sid |
API endpoint : |
The conferences table returns all the conferences within your Twilio account.
sid
The unique string that that we created to identify this Conference resource. |
||
date_updated
The date and time in GMT that this resource was last updated, specified in RFC 2822 format. |
||
account_sid
The SID of the Account that created this Conference resource. |
||
api_version
The API version used to create this conference. |
||
call_sid_ending_conference
The call SID that caused the conference to end. |
||
date_created
The date and time in GMT that this resource was created specified in RFC 2822 format. |
||
friendly_name
A string that you assigned to describe this conference room. Maxiumum length is 128 characters. |
||
reason_conference_ended
The reason why a conference ended. When a conference is in progress, will be null. When conference is completed, can be: conference-ended-via-api, participant-with-end-conference-on-exit-left, participant-with-end-conference-on-exit-kicked, last-participant-kicked, or last-participant-left. |
||
region
A string that represents the Twilio Region where the conference audio was mixed. May be us1, ie1, de1, sg1, br1, au1, and jp1. Basic conference audio will always be mixed in us1. Global Conference audio will be mixed nearest to the majority of participants. |
||
status
The status of this conference. Can be: init, in-progress, or completed. |
||
subresource_uris
A list of related resources identified by their URIs relative to https://api.twilio.com.
|
||
uri
The URI of this resource, relative to https://api.twilio.com. |
conference_participants
Replication Method : |
Full Table |
Primary Key |
uri |
API endpoint : |
The conference_participants table returns the list of active participants in the Twilio conference identified by ConferenceSid
.
uri
The URI of the resource, relative to https://api.twilio.com. |
account_sid
The SID of the Account that created the Participant resource. |
call_sid
The SID of the Call the Participant resource is associated with. |
call_sid_to_coach
The SID of the participant who is being coached. The participant being coached is the only participant who can hear the participant who is coaching. |
coaching
Whether the participant is coaching another call. Can be: true or false. If not present, defaults to false unless call_sid_to_coach is defined. If true, call_sid_to_coach must be defined. |
conference_sid
The SID of the conference the participant is in. |
date_created
The date and time in GMT that the resource was created specified in RFC 2822 format. |
date_updated
The date and time in GMT that the resource was last updated specified in RFC 2822 format. |
end_conference_on_exit
Whether the conference ends when the participant leaves. Can be: true or false and the default is false. If true, the conference ends and all other participants drop out when the participant leaves. |
hold
Whether the participant is on hold. Can be true or false. |
label
The user-specified label of this participant, if one was given when the participant was created. This may be used to fetch, update or delete the participant. |
muted
Whether the participant is muted. Can be true or false. |
start_conference_on_enter
Whether the conference starts when the participant joins the conference, if it has not already started. Can be: true or false and the default is true. If false and the conference has not started, the participant is muted and hears background music until another participant starts the conference. |
status
The status of the participant’s call in a session. Can be: queued, connecting, ringing, connected, complete, or failed. |
dependent_phone_numbers
Replication Method : |
Full Table |
Primary Key |
sid |
API endpoint : |
The dependent_phone_numbers table returns a list of IncomingPhoneNumbers
in your Twilio account that require the specified address.
sid
The unique string that that we created to identify this IncomingPhoneNumber resource. |
||||
account_sid
The SID of the Account that is responsible for the Address resource. |
||||
address_requirements
The type of Address resource the phone number requires. Can be: none, any, local, or foreign. none means no address is required. any means an address is required, but it can be anywhere in the world. local means an address in the phone number’s country is required. foreign means an address outside of the phone number’s country is required. |
||||
api_version
The API version used to create this conference. |
||||
capabilities
The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: Voice, SMS, and MMS and each capability can be: true or false.
|
||||
date_created
The date and time in GMT that the resource was created specified in RFC 2822 format. |
||||
date_updated
The date and time in GMT that the resource was last updated specified in RFC 2822 format. |
||||
emergency_address_sid
The SID of the emergency address configuration that we use for emergency calling from this phone number. |
||||
emergency_status
The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country. |
||||
friendly_name
A string that identifies the IncomingPhoneNumber resources to read. |
||||
phone_number
The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use ‘*’ as a wildcard for any digit. |
||||
sms_application_sid
The SID of the application that handles SMS messages sent to the phone number. If an sms_application_sid is present, we ignore all sms_*_url values and use those of the application. |
||||
sms_fallback_method
The HTTP method we use to call sms_fallback_url. Can be: GET or POST. |
||||
sms_fallback_url
The URL that we call when an error occurs while retrieving or executing the TwiML from sms_url. |
||||
sms_method
The HTTP method we use to call sms_url. Can be: GET or POST. |
||||
sms_url
The URL we call when the phone number receives an incoming SMS message. |
||||
status_callback
The URL we call using the status_callback_method to send status information to your application. |
||||
status_callback_method
The HTTP method we use to call status_callback. Can be: GET or POST. |
||||
trunk_sid
The SID of the Trunk that handles calls to the phone number. If a trunk_sid is present, we ignore all of the voice urls and voice applications and use those set on the Trunk. Setting a trunk_sid will automatically delete your voice_application_sid and vice versa. |
||||
uri
The URI of the resource, relative to https://api.twilio.com. |
||||
voice_application_sid
The SID of the application that handles calls to the phone number. If a voice_application_sid is present, we ignore all of the voice urls and use those set on the application. Setting a voice_application_sid will automatically delete your trunk_sid and vice versa. |
||||
voice_caller_id_lookup
Whether we look up the caller’s caller-ID name from the CNAM database ($0.01 per look up). Can be: true or false. |
||||
voice_fallback_method
The HTTP method we use to call voice_fallback_url. Can be: GET or POST. |
||||
voice_fallback_url
The URL that we call when an error occurs retrieving or executing the TwiML requested by url. |
||||
voice_method
The HTTP method we use to call voice_url. Can be: GET or POST. |
||||
voice_url
The URL we call when the phone number receives a call. The voice_url will not be used if a voice_application_sid or a trunk_sid is set. |
incoming_phone_numbers
Replication Method : |
Key-based Incremental |
Replication Key |
date_updated |
Primary Key |
sid |
API endpoint : |
The incoming_phone_numbers table returns a list of IncomingPhoneNumbers
in your Twilio account that require the specified address.
sid
The unique string that that we created to identify this IncomingPhoneNumber resource. |
||||
date_updated
The date and time in GMT that the resource was last updated specified in RFC 2822 format. |
||||
account_sid
The SID of the Account that created the IncomingPhoneNumber resources to read. |
||||
address_requirements
The type of Address resource the phone number requires. Can be: none, any, local, or foreign. none means no address is required. any means an address is required, but it can be anywhere in the world. local means an address in the phone number’s country is required. foreign means an address outside of the phone number’s country is required. |
||||
address_sid
The SID of the Address resource associated with the phone number. |
||||
api_version
The API version used to start a new TwiML session. |
||||
beta
Whether to include phone numbers new to the Twilio platform. Can be: true or false and the default is true. |
||||
bundle_sid
The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations. |
||||
capabilities
The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are Voice, SMS, MMS, and fax and each capability can be: true or false.
|
||||
date_created
The date and time in GMT that the resource was created specified in RFC 2822 format. |
||||
emergency_address_sid
The SID of the emergency address configuration that we use for emergency calling from this phone number. |
||||
emergency_address_status
The status of address registration with emergency services. A registered emergency address will be used during handling of emergency calls from this number. |
||||
emergency_status
The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country. |
||||
friendly_name
A string that identifies the IncomingPhoneNumber resources to read. |
||||
identity_sid
The SID of the Identity resource that we associate with the phone number. Some regions require an Identity to meet local regulations. |
||||
origin
Whether to include phone numbers based on their origin. Can be: twilio or hosted. By default, phone numbers of all origin are included. |
||||
phone_number
The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use ‘*’ as a wildcard for any digit. |
||||
sms_application_sid
The SID of the application that handles SMS messages sent to the phone number. If an sms_application_sid is present, we ignore all sms_*_url values and use those of the application. |
||||
sms_fallback_method
The HTTP method we use to call sms_fallback_url. Can be: GET or POST. |
||||
sms_fallback_url
The URL that we call when an error occurs while retrieving or executing the TwiML from sms_url. |
||||
sms_method
The HTTP method we use to call sms_url. Can be: GET or POST. |
||||
sms_url
The URL we call when the phone number receives an incoming SMS message. |
||||
status
Status of phone number |
||||
status_callback
The URL we call using the status_callback_method to send status information to your application. |
||||
status_callback_method
The HTTP method we use to call status_callback. Can be: GET or POST. |
||||
trunk_sid
The SID of the Trunk that handles calls to the phone number. If a trunk_sid is present, we ignore all of the voice urls and voice applications and use those set on the Trunk. Setting a trunk_sid will automatically delete your voice_application_sid and vice versa. |
||||
uri
The URI of the resource, relative to https://api.twilio.com. |
||||
voice_application_sid
The SID of the application that handles calls to the phone number. If a voice_application_sid is present, we ignore all of the voice urls and use those set on the application. Setting a voice_application_sid will automatically delete your trunk_sid and vice versa. |
||||
voice_caller_id_lookup
Whether we look up the caller’s caller-ID name from the CNAM database ($0.01 per look up). Can be: true or false. |
||||
voice_fallback_method
The HTTP method we use to call voice_fallback_url. Can be: GET or POST. |
||||
voice_fallback_url
The URL that we call when an error occurs retrieving or executing the TwiML requested by url. |
||||
voice_method
The HTTP method we use to call voice_url. Can be: GET or POST. |
||||
voice_receive_mode
|
||||
voice_url
The URL we call when the phone number receives a call. The voice_url will not be used if a voice_application_sid or a trunk_sid is set. |
Replication Method : |
Key-based Incremental |
Replication Key |
date_updated |
Primary Key |
sid |
API endpoint : |
The keys table returns a list of API Keys in your Twilio account.
sid
The Twilio-provided string that uniquely identifies the Key resource to update. |
date_updated
The date and time in GMT that the resource was last updated specified in RFC 2822 format. |
account_sid
The SID of the Account that created the Key resources to update. |
date_created
The date and time in GMT that the resource was created specified in RFC 2822 format. |
friendly_name
A descriptive string that you create to describe the resource. It can be up to 64 characters long. |
messages
Replication Method : |
Key-based Incremental |
Replication Key |
date_updated |
Primary Key |
sid |
API endpoint : |
The messages table returns a list of messages associated with your Twilio account.
sid
The unique string that that we created to identify the Message resource. |
||
date_updated
The date and time in GMT that the resource was last updated specified in RFC 2822 format. |
||
account_sid
The SID of the Account that sent the message that created the resource. |
||
api_version
The API version used to process the message. |
||
body
The message text. Can be up to 1,600 characters long. |
||
date_created
The date and time in GMT that the resource was created specified in RFC 2822 format. |
||
date_sent
The date and time in GMT that the resource was sent specified in RFC 2822 format. For outgoing messages, this is when we sent the message. For incoming messages, this is when we made the HTTP request to your application. |
||
direction
The direction of the message. Can be: inbound for incoming messages, outbound-api for messages initiated by a REST API, outbound-call for messages initiated during a call, or outbound-reply for messages initiated in response to an incoming message. |
||
error_code
The error code returned if your message status is failed or undelivered. The error_code provides more information about the failure. If the message was successful, this value is null. |
||
error_message
The description of the error_code if your message status is failed or undelivered. If the message was successful, this value is null. |
||
from
The phone number (in E.164 format), alphanumeric sender ID, or Wireless SIM that initiated the message. For incoming messages, this will be the number of the sending phone. For outgoing messages, this value will be one of your Twilio phone numbers or the alphanumeric sender ID used. |
||
messaging_service_sid
The SID of the Messaging Service used with the message. The value is null if a Messaging Service was not used. |
||
num_media
The number of media files associated with the message. A message can send up to 10 media files. |
||
num_segments
The number of segments that make up the complete message. A message body that is too large to be sent in a single SMS message is segmented and charged as multiple messages. Inbound messages over 160 characters are reassembled when the message is received. Note: When using a Messaging Service to send messages, num_segments will always be 0 in Twilio’s response to your API request. |
||
price
The amount billed for the message, in the currency specified by price_unit. Note that your account is charged for each segment we send to the handset. Populated after the message has been sent. May not be immediately available. |
||
price_unit
The currency in which price is measured, in ISO 4127 format (e.g. usd, eur, jpy). |
||
status
The status of the message. Can be: accepted, scheduled, canceled, queued, sending, sent, failed, delivered, undelivered, receiving, received, or read (WhatsApp only). |
||
subresource_uris
|
||
to
The phone number in E.164 format that received the message. For incoming messages, this will be one of your Twilio phone numbers. For outgoing messages, this will be the sending phone. |
||
uri
The URI of the resource, relative to https://api.twilio.com. |
message_media
Replication Method : |
Full Table |
Primary Key |
sid |
API endpoint : |
The message_media table returns the list of media associated with your Twilio message.
sid
The unique string that that we created to identify this Media resource. |
account_sid
The SID of the Account that created this Media resource. |
content_type
The default mime-type of the media, for example image/jpeg, image/png, or image/gif |
date_created
The date and time in GMT that this resource was created specified in RFC 2822 format. |
date_updated
The date and time in GMT that this resource was last updated, specified in RFC 2822 format. |
parent_sid
The SID of the resource that created the media. |
uri
The URI of this resource, relative to https://api.twilio.com. |
outgoing_caller_ids
Replication Method : |
Key-based Incremental |
Replication Key |
date_updated |
Primary Key |
sid |
API endpoint : |
The outgoing_caller_ids table returns a list of OutgoingCallerId
resource representations, each representing a Caller ID number valid for a Twilio account.
sid
A 34 character string that uniquely identifies this resource. |
date_updated
The date that this resource was last updated, given in RFC 2822 format. |
account_sid
The unique ID of the Account responsible for this Caller Id. |
date_created
The date that this resource was created, given in RFC 2822 format. |
friendly_name
A human readable descriptive text for this resource, up to 64 characters long. By default, the FriendlyName is a nicely formatted version of the phone number. |
phone_number
The incoming phone number. Formatted with a ‘+’ and country code e.g., +16175551212 (E.164 format). |
uri
The URI for this resource, relative to https://api.twilio.com. |
queues
Replication Method : |
Key-based Incremental |
Replication Key |
date_updated |
Primary Key |
sid |
API endpoint : |
The queues table returns the list of call queues within your Twilio account.
sid
The unique string that that we created to identify this Queue resource. |
||
date_updated
The date and time in GMT that this resource was last updated, specified in RFC 2822 format. |
||
account_sid
The SID of the Account that created this Queue resource. |
||
average_wait_time
The average wait time in seconds of the members in this queue. This is calculated at the time of the request. |
||
current_size
The number of calls currently in the queue. |
||
date_created
|
||
friendly_name
A string that you assigned to describe this resource. |
||
max_size
The maximum number of calls that can be in the queue. The default is 1000 and the maximum is 5000. |
||
subresource_uris
A list of related resources identified by their URIs relative to https://api.twilio.com.
|
||
uri
The URI of this resource, relative to https://api.twilio.com. |
recordings
Replication Method : |
Key-based Incremental |
Replication Key |
date_created |
Primary Key |
sid |
API endpoint : |
The recordings table returns a list of recordings, each representing a recording generated during a call or conference in your Twilio account.
sid
The unique string that that we created to identify the Recording resource. |
||||
date_created
The date and time in GMT that the resource was created specified in RFC 2822 format. |
||||
account_sid
The SID of the Account that created the Recording resource. |
||||
api_version
The API version used during the recording. |
||||
call_sid
The SID of the Call the Recording resource is associated with. This will always refer to the parent leg of a two-leg call. |
||||
channels
The number of channels in the final recording file. Can be: 1 or 2. You can split a call with two legs into two separate recording channels if you record using TwiML Dial or the Outbound Rest API. |
||||
conference_sid
The Conference SID that identifies the conference associated with the recording, if a conference recording. |
||||
date_updated
The date and time in GMT that the resource was last updated specified in RFC 2822 format. |
||||
duration
The length of the recording in seconds. |
||||
encryption_details
How to decrypt the recording if it was encrypted using Call Recording Encryption feature.
|
||||
error_code
The error code that describes why the recording is absent. The error code is described in our Error Dictionary. This value is null if the recording status is not absent. |
||||
price
The one-time cost of creating the recording in the price_unit currency. |
||||
price_unit
The currency used in the price property. Example: USD. |
||||
source
How the recording was created. Can be: DialVerb, Conference, OutboundAPI, Trunking, RecordVerb, StartCallRecordingAPI, and StartConferenceRecordingAPI. |
||||
start_time
The start time of the recording in GMT and in RFC 2822 format. |
||||
status
he status of the recording. Can be: processing, completed, absent or deleted. |
||||
subresource_uris
A list of related resources identified by their relative URIs.
|
||||
uri
The URI of the resource, relative to https://api.twilio.com. |
transcriptions
Replication Method : |
Key-based Incremental |
Replication Key |
date_updated |
Primary Key |
sid |
API endpoint : |
The transcriptions table returns the full set of transcriptions generated from all recordings in your Twilio account.
sid
The unique string that that we created to identify the Transcription resource. |
date_updated
The date and time in GMT that the resource was last updated specified in RFC 2822 format. |
account_sid
The SID of the Account that created the Transcription resource. |
api_version
The API version used to create the transcription. |
date_created
The date and time in GMT that the resource was created specified in RFC 2822 format. |
duration
The duration of the transcribed audio in seconds. |
price
The charge for the transcript in the currency associated with the account. This value is populated after the transcript is complete so it may not be available immediately. |
price_unit
The currency in which price is measured, in ISO 4127 format (e.g. usd, eur, jpy). |
recording_sid
The SID of the Recording from which the transcription was created. |
status
The status of the transcription. Can be: in-progress, completed, failed |
transcription_text
The text content of the transcription. |
type
The transcription type. Can only be: fast. |
uri
The URI of the resource, relative to https://api.twilio.com. |
usage_records
Replication Method : |
Key-based Incremental |
Replication Key |
start_date |
Primary Key |
account_sid : category : start_date |
API endpoint : |
The usage_records table returns a list of usage records in your Twilio account.
account_sid
The SID of the Account that accrued the usage. |
||
category
The category of usage. |
||
start_date
The first date for which usage is included in this UsageRecord. The date is specified in GMT and formatted as YYYY-MM-DD. |
||
api_version
The API version used to create the resource. |
||
as_of
Usage records up to date as of this timestamp, formatted as YYYY-MM-DDTHH:MM:SS+00:00. All timestamps are in GMT |
||
count
The number of usage events, such as the number of calls. |
||
count_unit
The units in which count is measured, such as calls for calls or messages for SMS. |
||
description
A plain-language description of the usage category. |
||
end_date
The last date for which usage is included in the UsageRecord. The date is specified in GMT and formatted as YYYY-MM-DD. |
||
price
The total price of the usage in the currency specified in price_unit and associated with the account. |
||
price_unit
The currency in which price is measured, in ISO 4127 format, such as usd, eur, and jpy. |
||
subresource_uris
A list of related resources identified by their URIs.
|
||
uri
The URI of the resource, relative to https://api.twilio.com. |
||
usage
The amount used to bill usage and measured in units described in usage_unit. |
||
usage_unit
The units in which usage is measured, such as minutes for calls or messages for SMS. |
usage_triggers
Replication Method : |
Key-based Incremental |
Replication Key |
date_updated |
Primary Key |
sid |
API endpoint : |
The usage_triggers table returns list of usage triggers in your Twilio account.
sid
The unique string that that we created to identify the UsageTrigger resource. |
date_updated
The date and time in GMT that the resource was last updated specified in RFC 2822 format. |
account_sid
The SID of the Account that the trigger monitors. |
api_version
The API version used to create the resource. |
callback_method
The HTTP method we use to call callback_url. Can be: GET or POST. |
callback_url
The URL we call using the callback_method when the trigger fires. |
current_value
The current value of the field the trigger is watching. |
date_created
The date and time in GMT that the resource was created specified in RFC 2822 format. |
date_fired
The date and time in GMT that the trigger was last fired specified in RFC 2822 format. |
friendly_name
The string that you assigned to describe the trigger. |
recurring
The frequency of a recurring UsageTrigger. Can be: daily, monthly, or yearly for recurring triggers or empty for non-recurring triggers. A trigger will only fire once during each period. Recurring times are in GMT. |
trigger_by
The field in the UsageRecord resource that fires the trigger. Can be: count, usage, or price. |
trigger_value
The value at which the trigger will fire. Must be a positive, numeric value. |
uri
The URI of the resource, relative to https://api.twilio.com. |
usage_category
The usage category the trigger watches. |
usage_record_uri
The URI of the UsageRecord resource this trigger watches, relative to https://api.twilio.com. |
Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.