REST API: Applications
An Application Resource (also referred to as a "TwiML Application" or "TwiML App") represents a collection of endpoints that return TwiML instructions to Twilio. TwiML Applications are most commonly used for the Voice SDKs to handle outbound calls, but can also be used to configure multiple phone numbers with the same set of TwiML endpoints.
The Applications list resource represents the set of an account's Twilio
applications. You can POST
to the list resource to create a new application.
Note that accounts can contain at most 1000 applications.
Applications are useful for encapsulating configuration information that you
need to distribute across multiple phone numbers. You can assign an
ApplicationSid to an IncomingPhoneNumber to tell Twilio to use the application's
URLs instead of the ones set directly on the IncomingPhoneNumber. So if you
create an application with its VoiceUrl set to http://myapp.com/answer(link takes you to an external page) , you can
assign that application to all of your phone numbers and Twilio will make a
request to that URL whenever a call comes in.
Resource properties The API version used to start a new TwiML session.
date_created
type: string<DATE TIME RFC 2822> Not PIIdate_updated
type: string<DATE TIME RFC 2822> Not PIIThe string that you assigned to describe the resource.
message_status_callback
type: string<URI> Not PIIThe URL we call using a POST method to send message status information to your application.
The unique string that that we created to identify the Application resource.
sms_fallback_method
type: enum<HTTP METHOD> Not PIIThe HTTP method we use to call sms_fallback_url
. Can be: GET
or POST
.
sms_fallback_url
type: string<URI> Not PIIThe URL that we call when an error occurs while retrieving or executing the TwiML from sms_url
.
sms_method
type: enum<HTTP METHOD> Not PIIThe HTTP method we use to call sms_url
. Can be: GET
or POST
.
sms_status_callback
type: string<URI> Not PIIThe URL we call using a POST method to send status information to your application about SMS messages that refer to the application.
The URL we call when the phone number receives an incoming SMS message.
status_callback
type: string<URI> Not PIIThe URL we call using the status_callback_method
to send status information to your application.
status_callback_method
type: enum<HTTP METHOD> Not PIIThe HTTP method we use to call status_callback
. Can be: GET
or POST
.
The URI of the resource, relative to https://api.twilio.com
.
voice_caller_id_lookup
type: boolean Not PIIWhether we look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: true
or false
.
voice_fallback_method
type: enum<HTTP METHOD> Not PIIThe HTTP method we use to call voice_fallback_url
. Can be: GET
or POST
.
voice_fallback_url
type: string<URI> Not PIIThe URL that we call when an error occurs retrieving or executing the TwiML requested by url
.
voice_method
type: enum<HTTP METHOD> Not PIIThe HTTP method we use to call voice_url
. Can be: GET
or POST
.
The URL we call when the phone number assigned to this application receives a call.
public_application_connect_enabled
type: boolean Not PIIWhether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be: true
or false
.
POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Applications.json
Creates a new application within your account.
If successful, Twilio responds with a representation of the new application.
URI parameters Request body parameters The API version to use to start a new TwiML session. Can be: 2010-04-01
or 2008-08-01
. The default value is the account's default API version.
The URL we should call when the phone number assigned to this application receives a call.
VoiceMethod
type: enum<HTTP METHOD> Not PIIThe HTTP method we should use to call voice_url
. Can be: GET
or POST
.
VoiceFallbackUrl
type: string<URI> Not PIIThe URL that we should call when an error occurs retrieving or executing the TwiML requested by url
.
VoiceFallbackMethod
type: enum<HTTP METHOD> Not PIIThe HTTP method we should use to call voice_fallback_url
. Can be: GET
or POST
.
StatusCallback
type: string<URI> Not PIIThe URL we should call using the status_callback_method
to send status information to your application.
StatusCallbackMethod
type: enum<HTTP METHOD> Not PIIThe HTTP method we should use to call status_callback
. Can be: GET
or POST
.
VoiceCallerIdLookup
type: boolean Not PIIWhether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: true
or false
.
The URL we should call when the phone number receives an incoming SMS message.
SmsMethod
type: enum<HTTP METHOD> Not PIIThe HTTP method we should use to call sms_url
. Can be: GET
or POST
.
SmsFallbackUrl
type: string<URI> Not PIIThe URL that we should call when an error occurs while retrieving or executing the TwiML from sms_url
.
SmsFallbackMethod
type: enum<HTTP METHOD> Not PIIThe HTTP method we should use to call sms_fallback_url
. Can be: GET
or POST
.
SmsStatusCallback
type: string<URI> Not PIIThe URL we should call using a POST method to send status information about SMS messages sent by the application.
MessageStatusCallback
type: string<URI> Not PIIThe URL we should call using a POST method to send message status information to your application.
A descriptive string that you create to describe the new application. It can be up to 64 characters long.
PublicApplicationConnectEnabled
type: boolean Not PIIWhether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be: true
or false
.
_14 // Download the helper library from https://www.twilio.com/docs/node/install
_14 // Find your Account SID and Auth Token at twilio.com/console
_14 // and set the environment variables. See http://twil.io/secure
_14 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_14 const authToken = process.env.TWILIO_AUTH_TOKEN;
_14 const client = require('twilio')(accountSid, authToken);
_14 voiceUrl: 'http://demo.twilio.com/docs/voice.xml',
_14 friendlyName: 'Phone Me'
_14 .then(application => console.log(application.sid));
_23 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23 "api_version": "2010-04-01",
_23 "date_created": "Mon, 22 Aug 2011 20:59:45 +0000",
_23 "date_updated": "Tue, 18 Aug 2015 16:48:57 +0000",
_23 "friendly_name": "Phone Me",
_23 "message_status_callback": "http://www.example.com/sms-status-callback",
_23 "sid": "APXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23 "sms_fallback_method": "GET",
_23 "sms_fallback_url": "http://www.example.com/sms-fallback",
_23 "sms_status_callback": "http://www.example.com/sms-status-callback",
_23 "sms_url": "http://example.com",
_23 "status_callback": "http://example.com",
_23 "status_callback_method": "GET",
_23 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Applications/APXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_23 "voice_caller_id_lookup": false,
_23 "voice_fallback_method": "GET",
_23 "voice_fallback_url": "http://www.example.com/voice-callback",
_23 "voice_method": "GET",
_23 "voice_url": "http://demo.twilio.com/docs/voice.xml",
_23 "public_application_connect_enabled": true
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json
URI parameters Path Parameter
The Twilio-provided string that uniquely identifies the Application resource to fetch.
_10 // Download the helper library from https://www.twilio.com/docs/node/install
_10 // Find your Account SID and Auth Token at twilio.com/console
_10 // and set the environment variables. See http://twil.io/secure
_10 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10 const authToken = process.env.TWILIO_AUTH_TOKEN;
_10 const client = require('twilio')(accountSid, authToken);
_10 client.applications('APXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10 .then(application => console.log(application.friendlyName));
_23 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23 "api_version": "2010-04-01",
_23 "date_created": "Mon, 22 Aug 2011 20:59:45 +0000",
_23 "date_updated": "Tue, 18 Aug 2015 16:48:57 +0000",
_23 "friendly_name": "Application Friendly Name",
_23 "message_status_callback": "http://www.example.com/sms-status-callback",
_23 "sid": "APXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23 "sms_fallback_method": "GET",
_23 "sms_fallback_url": "http://www.example.com/sms-fallback",
_23 "sms_status_callback": "http://www.example.com/sms-status-callback",
_23 "sms_url": "http://example.com",
_23 "status_callback": "http://example.com",
_23 "status_callback_method": "GET",
_23 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Applications/APXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_23 "voice_caller_id_lookup": false,
_23 "voice_fallback_method": "GET",
_23 "voice_fallback_url": "http://www.example.com/voice-callback",
_23 "voice_method": "GET",
_23 "voice_url": "http://example.com",
_23 "public_application_connect_enabled": false
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Applications.json
Returns a list of Application resource representations, each representing an
application within your account. The list includes paging information .
URI parameters Query Parameter
The string that identifies the Application resources to read.
Query Parameter
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Query Parameter
The page index. This value is simply for client state.
Query Parameter
The page token. This is provided by the API.
_10 // Download the helper library from https://www.twilio.com/docs/node/install
_10 // Find your Account SID and Auth Token at twilio.com/console
_10 // and set the environment variables. See http://twil.io/secure
_10 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10 const authToken = process.env.TWILIO_AUTH_TOKEN;
_10 const client = require('twilio')(accountSid, authToken);
_10 client.applications.list({limit: 20})
_10 .then(applications => applications.forEach(a => console.log(a.sid)));
_35 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_35 "api_version": "2010-04-01",
_35 "date_created": "Fri, 21 Aug 2015 00:07:25 +0000",
_35 "date_updated": "Fri, 21 Aug 2015 00:07:25 +0000",
_35 "friendly_name": "d8821fb7-4d01-48b2-bdc5-34e46252b90b",
_35 "message_status_callback": null,
_35 "sid": "APXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_35 "sms_fallback_method": "POST",
_35 "sms_fallback_url": null,
_35 "sms_method": "POST",
_35 "sms_status_callback": null,
_35 "status_callback": null,
_35 "status_callback_method": "POST",
_35 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Applications/APXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_35 "voice_caller_id_lookup": false,
_35 "voice_fallback_method": "POST",
_35 "voice_fallback_url": null,
_35 "voice_method": "POST",
_35 "public_application_connect_enabled": false
_35 "first_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Applications.json?PageSize=1&Page=0",
_35 "next_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Applications.json?PageSize=1&Page=1",
_35 "previous_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Applications.json?PageSize=1&Page=0",
_35 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Applications.json?PageSize=1&Page=0"
_10 // Download the helper library from https://www.twilio.com/docs/node/install
_10 // Find your Account SID and Auth Token at twilio.com/console
_10 // and set the environment variables. See http://twil.io/secure
_10 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10 const authToken = process.env.TWILIO_AUTH_TOKEN;
_10 const client = require('twilio')(accountSid, authToken);
_10 client.applications.list({friendlyName: 'MyApp', limit: 20})
_10 .then(applications => applications.forEach(a => console.log(a.sid)));
_35 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_35 "api_version": "2010-04-01",
_35 "date_created": "Fri, 21 Aug 2015 00:07:25 +0000",
_35 "date_updated": "Fri, 21 Aug 2015 00:07:25 +0000",
_35 "friendly_name": "d8821fb7-4d01-48b2-bdc5-34e46252b90b",
_35 "message_status_callback": null,
_35 "sid": "APXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_35 "sms_fallback_method": "POST",
_35 "sms_fallback_url": null,
_35 "sms_method": "POST",
_35 "sms_status_callback": null,
_35 "status_callback": null,
_35 "status_callback_method": "POST",
_35 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Applications/APXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_35 "voice_caller_id_lookup": false,
_35 "voice_fallback_method": "POST",
_35 "voice_fallback_url": null,
_35 "voice_method": "POST",
_35 "public_application_connect_enabled": false
_35 "first_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Applications.json?PageSize=1&Page=0",
_35 "next_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Applications.json?PageSize=1&Page=1",
_35 "previous_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Applications.json?PageSize=1&Page=0",
_35 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Applications.json?PageSize=1&Page=0"
POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json
Tries to update the application's properties, and returns the updated
resource representation if successful. The returned response is identical
to that returned above when making a GET
request.
URI parameters Path Parameter
The Twilio-provided string that uniquely identifies the Application resource to update.
Request body parameters A descriptive string that you create to describe the resource. It can be up to 64 characters long.
The API version to use to start a new TwiML session. Can be: 2010-04-01
or 2008-08-01
. The default value is your account's default API version.
The URL we should call when the phone number assigned to this application receives a call.
VoiceMethod
type: enum<HTTP METHOD> Not PIIThe HTTP method we should use to call voice_url
. Can be: GET
or POST
.
VoiceFallbackUrl
type: string<URI> Not PIIThe URL that we should call when an error occurs retrieving or executing the TwiML requested by url
.
VoiceFallbackMethod
type: enum<HTTP METHOD> Not PIIThe HTTP method we should use to call voice_fallback_url
. Can be: GET
or POST
.
StatusCallback
type: string<URI> Not PIIThe URL we should call using the status_callback_method
to send status information to your application.
StatusCallbackMethod
type: enum<HTTP METHOD> Not PIIThe HTTP method we should use to call status_callback
. Can be: GET
or POST
.
VoiceCallerIdLookup
type: boolean Not PIIWhether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: true
or false
.
The URL we should call when the phone number receives an incoming SMS message.
SmsMethod
type: enum<HTTP METHOD> Not PIIThe HTTP method we should use to call sms_url
. Can be: GET
or POST
.
SmsFallbackUrl
type: string<URI> Not PIIThe URL that we should call when an error occurs while retrieving or executing the TwiML from sms_url
.
SmsFallbackMethod
type: enum<HTTP METHOD> Not PIIThe HTTP method we should use to call sms_fallback_url
. Can be: GET
or POST
.
SmsStatusCallback
type: string<URI> Not PIISame as message_status_callback: The URL we should call using a POST method to send status information about SMS messages sent by the application. Deprecated, included for backwards compatibility.
MessageStatusCallback
type: string<URI> Not PIIThe URL we should call using a POST method to send message status information to your application.
PublicApplicationConnectEnabled
type: boolean Not PIIWhether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be: true
or false
.
_13 // Download the helper library from https://www.twilio.com/docs/node/install
_13 // Find your Account SID and Auth Token at twilio.com/console
_13 // and set the environment variables. See http://twil.io/secure
_13 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_13 const authToken = process.env.TWILIO_AUTH_TOKEN;
_13 const client = require('twilio')(accountSid, authToken);
_13 client.applications('AP2a0747eba6abf96b7e3c3ff0b4530f6e')
_13 smsUrl: 'http://demo.twilio.com/docs/sms.xml',
_13 voiceUrl: 'http://demo.twilio.com/docs/voice.xml'
_13 .then(application => console.log(application.friendlyName));
_23 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23 "api_version": "2010-04-01",
_23 "date_created": "Mon, 22 Aug 2011 20:59:45 +0000",
_23 "date_updated": "Tue, 18 Aug 2015 16:48:57 +0000",
_23 "friendly_name": "Application Friendly Name",
_23 "message_status_callback": "http://www.example.com/sms-status-callback",
_23 "sid": "AP2a0747eba6abf96b7e3c3ff0b4530f6e",
_23 "sms_fallback_method": "GET",
_23 "sms_fallback_url": "http://www.example.com/sms-fallback",
_23 "sms_status_callback": "http://www.example.com/sms-status-callback",
_23 "sms_url": "http://demo.twilio.com/docs/sms.xml",
_23 "status_callback": "http://example.com",
_23 "status_callback_method": "GET",
_23 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Applications/APXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_23 "voice_caller_id_lookup": false,
_23 "voice_fallback_method": "GET",
_23 "voice_fallback_url": "http://www.example.com/voice-callback",
_23 "voice_method": "GET",
_23 "voice_url": "http://demo.twilio.com/docs/voice.xml",
_23 "public_application_connect_enabled": true
DELETE https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json
Delete this application. If this application's sid is assigned
to any IncomingPhoneNumber resources as a VoiceApplicationSid or
SmsApplicationSid it will be removed.
If successful, Twilio will return an HTTP 204 response with no body.
URI parameters Path Parameter
The Twilio-provided string that uniquely identifies the Application resource to delete.
_10 // Download the helper library from https://www.twilio.com/docs/node/install
_10 // Find your Account SID and Auth Token at twilio.com/console
_10 // and set the environment variables. See http://twil.io/secure
_10 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10 const authToken = process.env.TWILIO_AUTH_TOKEN;
_10 const client = require('twilio')(accountSid, authToken);
_10 client.applications('APXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX').remove();