Menu

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

REST API: Applications

An Application instance resource represents an application that you have created with Twilio. An application inside of Twilio is just a set of URLs and other configuration data that tells Twilio how to behave when one of your Twilio numbers receives a call or SMS message. This configuration data is the same configuration data that exists on IncomingPhoneNumber resources: 'VoiceUrl', 'VoiceMethod', 'VoiceFallbackUrl', 'VoiceFallbackMethod', 'StatusCallback', 'StatusCallbackMethod', 'VoiceCallerIdLookup', 'SmsUrl', 'SmsMethod', 'SmsFallbackUrl', 'SmsFallbackMethod', and 'SmsStatusCallback'.

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, 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.

Application properties

Names in PHP format
accountSid
sid<AC> Not PII

The unique id of the Account that created this application.

apiVersion
string Not PII

Requests to this application will start a new TwiML session with this API version.

dateCreated
date_time<rfc2822> Not PII

The date that this resource was created, given as GMT RFC 2822 format.

dateUpdated
date_time<rfc2822> Not PII

The date that this resource was last updated, given as GMT RFC 2822 format.

friendlyName
string Not PII

A human readable descriptive text for this resource, up to 64 characters long.

messageStatusCallback
url Not PII

Twilio will make a POST request to this URL to pass status parameters (such as sent or failed) to your application if you use the /Messages endpoint to send the message and specify this application's Sid as the ApplicationSid on an outgoing SMS request.

sid
sid<AP> Not PII

A 34 character string that uniquely identifies this resource.

smsFallbackMethod
http_method Not PII

The HTTP method Twilio will use when requesting the above URL. Either GET or POST.

smsFallbackUrl
url Not PII

The URL that Twilio will request if an error occurs retrieving or executing the TwiML from SmsUrl.

smsMethod
http_method Not PII

The HTTP method Twilio will use when making requests to the SmsUrl. Either GET or POST.

smsStatusCallback
url Not PII

The URL that Twilio will POST to when a message is sent via the /SMS/Messages endpoint if you specify the Sid of this application on an outgoing SMS request.

smsUrl
url Not PII

The URL Twilio will request when a phone number assigned to this application receives an incoming SMS message.

statusCallback
url Not PII

The URL that Twilio will request to pass status parameters (such as call ended) to your application.

statusCallbackMethod
http_method Not PII

The HTTP method Twilio will use to make requests to the StatusCallback URL. Either GET or POST.

uri
uri Not PII

The URI for this resource, relative to https://api.twilio.com.

voiceCallerIdLookup
boolean Not PII

Look up the caller's caller-ID name from the CNAM database (additional charges apply). Either true or false.

voiceFallbackMethod
http_method Not PII

The HTTP method Twilio will use when requesting the VoiceFallbackUrl. Either GET or POST.

voiceFallbackUrl
url Not PII

The URL that Twilio will request if an error occurs retrieving or executing the TwiML requested by Url.

voiceMethod
http_method Not PII

The HTTP method Twilio will use when requesting the above Url. Either GET or POST.

voiceUrl
url Not PII

The URL Twilio will request when a phone number assigned to this application receives a call.

Create an Application resource

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.

Parameters
Names in PHP format
friendlyName
Required
post string Not PII

A human readable description of the new application, maximum of 64 characters.

apiVersion
Optional
post string Not PII

Requests to this application's URLs will start a new TwiML session with this API version. Either 2010-04-01 or 2008-08-01. Defaults to your account's default API version.

voiceUrl
Optional
post url Not PII

The URL that Twilio should request when somebody dials a phone number assigned to this application.

voiceMethod
Optional
post http_method Not PII

The HTTP method that should be used to request the VoiceUrl. Must be either GET or POST. Defaults to POST.

voiceFallbackUrl
Optional
post url Not PII

The URL that Twilio will request if an error occurs retrieving or executing the TwiML requested by Url.

voiceFallbackMethod
Optional
post http_method Not PII

The HTTP method that should be used to request the VoiceFallbackUrl. Either GET or POST. Defaults to POST.

statusCallback
Optional
post url Not PII

The URL that Twilio will request to pass status parameters (such as call ended) to your application.

statusCallbackMethod
Optional
post http_method Not PII

The HTTP method Twilio will use to make requests to the StatusCallback URL. Either GET or POST. Defaults to POST.

voiceCallerIdLookup
Optional
post boolean Not PII

Do a lookup of a caller's name from the CNAM database and post it to your app. Either true or false. Defaults to false.

smsUrl
Optional
post url Not PII

The URL Twilio will request when a phone number assigned to this application receives an incoming SMS message.

smsMethod
Optional
post http_method Not PII

The HTTP method that should be used to request the SmsUrl. Must be either GET or POST. Defaults to POST.

smsFallbackUrl
Optional
post url Not PII

A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl.

smsFallbackMethod
Optional
post http_method Not PII

The HTTP method that should be used to request the SmsFallbackUrl. Must be either GET or POST. Defaults to POST.

smsStatusCallback
Optional
post url Not PII

Twilio will make a POST request to this URL to pass status parameters (such as sent or failed) to your application if you specify this application's Sid as the ApplicationSid on an outgoing SMS request.

messageStatusCallback
Optional
post url Not PII

Twilio will make a POST request to this URL to pass status parameters (such as sent or failed) to your application if you use the /Messages endpoint to send the message and specify this application's Sid as the ApplicationSid on an outgoing SMS request.

Example 1
        
        
        
        

        Fetch an Application resource

        get
        https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json
        Parameters
        Names in PHP format
        sid
        Required
        get sid<AP> Not PII

        The application Sid that that uniquely identifies this resource

        Example 1
              
              
              
              

              Read multiple Application resources

              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.

              Parameters
              Names in PHP format
              friendlyName
              Optional
              get string Not PII

              Only return application resources with friendly names that match exactly with this name

              Example 1
                    
                    
                    
                    
                    Example 2
                          
                          
                          
                          

                          Update an Application resource

                          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.

                          Parameters
                          Names in PHP format
                          friendlyName
                          Optional
                          post string Not PII

                          A human readable description of the application, with maximum length 64 characters.

                          apiVersion
                          Optional
                          post string Not PII

                          Requests to this application's URLs will start a new TwiML session with this API version. Either 2010-04-01 or 2008-08-01.

                          voiceUrl
                          Optional
                          post url Not PII

                          The URL that Twilio should request when somebody dials a phone number assigned to this application.

                          voiceMethod
                          Optional
                          post http_method Not PII

                          The HTTP method Twilio will use when requesting the above Url. Either GET or POST.

                          voiceFallbackUrl
                          Optional
                          post url Not PII

                          A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by VoiceUrl.

                          voiceFallbackMethod
                          Optional
                          post http_method Not PII

                          The HTTP method Twilio will use when requesting the VoiceFallbackUrl. Either GET or POST.

                          statusCallback
                          Optional
                          post url Not PII

                          The URL that Twilio will request to pass status parameters (such as call ended) to your application.

                          statusCallbackMethod
                          Optional
                          post http_method Not PII

                          The HTTP method Twilio will use to make requests to the StatusCallback URL. Either GET or POST.

                          voiceCallerIdLookup
                          Optional
                          post boolean Not PII

                          Look up the caller's caller-ID name from the CNAM database (additional charges apply). Either true or false.

                          smsUrl
                          Optional
                          post url Not PII

                          The URL Twilio will request when a phone number assigned to this application receives an incoming SMS message.

                          smsMethod
                          Optional
                          post http_method Not PII

                          The HTTP method Twilio will use when making requests to the SmsUrl. Either GET or POST.

                          smsFallbackUrl
                          Optional
                          post url Not PII

                          A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl.

                          smsFallbackMethod
                          Optional
                          post http_method Not PII

                          The HTTP method that should be used to request the SmsFallbackUrl. Either GET or POST.

                          smsStatusCallback
                          Optional
                          post url Not PII

                          The URL that Twilio will POST to when a message is sent via the /SMS/Messages endpoint if you specify the Sid of this application on an outgoing SMS request.

                          messageStatusCallback
                          Optional
                          post url Not PII

                          Twilio will make a POST request to this URL to pass status parameters (such as sent or failed) to your application if you use the /Messages endpoint to send the message and specify this application's Sid as the ApplicationSid on an outgoing SMS request.

                          Example 1
                                
                                
                                
                                

                                Delete an Application resource

                                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.

                                Parameters
                                Names in PHP format
                                sid
                                Required
                                delete sid<AP> Not PII

                                The application sid the uniquely identifies this application

                                Example 1
                                      
                                      
                                      
                                      

                                      Need some help?

                                      We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.