Create a new application within your account

POST /2010-04-01/Accounts/{AccountSid}/Applications.json

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.

Path parameters

AccountSid string Required

The SID of the Account that will create the resource.

Body

ApiVersion string

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.
FriendlyName string

A descriptive string that you create to describe the new application. It can be up to 64 characters long.
MessageStatusCallback string(uri)

The URL we should call using a POST method to send message status information to your application.
SmsFallbackMethod string(http-method)

The HTTP method we should use to call sms_fallback_url. Can be: GET or POST.

Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
SmsFallbackUrl string(uri)

The URL that we should call when an error occurs while retrieving or executing the TwiML from sms_url.
SmsMethod string(http-method)

The HTTP method we should use to call sms_url. Can be: GET or POST.

Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
SmsStatusCallback string(uri)

The URL we should call using a POST method to send status information about SMS messages sent by the application.
SmsUrl string(uri)

The URL we should call when the phone number receives an incoming SMS message.
StatusCallback string(uri)

The URL we should call using the status_callback_method to send status information to your application.
StatusCallbackMethod string(http-method)

The HTTP method we should use to call status_callback. Can be: GET or POST.

Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
VoiceCallerIdLookup boolean

Whether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: true or false.
VoiceFallbackMethod string(http-method)

The HTTP method we should use to call voice_fallback_url. Can be: GET or POST.

Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
VoiceFallbackUrl string(uri)

The URL that we should call when an error occurs retrieving or executing the TwiML requested by url.
VoiceMethod string(http-method)

The HTTP method we should use to call voice_url. Can be: GET or POST.

Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
VoiceUrl string(uri)

The URL we should call when the phone number assigned to this application receives a call.

Responses

201

Created
Hide response attributes Show response attributes object
- account_sid string | null
  
  The SID of the Account that created the resource
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
- api_version string | null
  
  The API version used to start a new TwiML session
- date_created string(date-time-rfc-2822) | null
  
  The RFC 2822 date and time in GMT that the resource was created
- date_updated string(date-time-rfc-2822) | null
  
  The RFC 2822 date and time in GMT that the resource was last updated
- friendly_name string | null
  
  The string that you assigned to describe the resource
- message_status_callback string(uri) | null
  
  The URL to send message status information to your application
- sid string | null
  
  The unique string that identifies the resource
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AP[0-9a-fA-F]{32}$.
- sms_fallback_method string(http-method) | null
  
  The HTTP method used with sms_fallback_url
  
  Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
- sms_fallback_url string(uri) | null
  
  The URL that we call when an error occurs while retrieving or executing the TwiML
- sms_method string(http-method) | null
  
  The HTTP method to use with sms_url
  
  Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
- sms_status_callback string(uri) | null
  
  The URL to send status information to your application
- sms_url string(uri) | null
  
  The URL we call when the phone number receives an incoming SMS message
- status_callback string(uri) | null
  
  The URL to send status information to your application
- status_callback_method string(http-method) | null
  
  The HTTP method we use to call status_callback
  
  Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
- uri string(uri) | null
  
  The URI of the resource, relative to https://api.twilio.com
- voice_caller_id_lookup boolean | null
  
  Whether to lookup the caller's name
- voice_fallback_method string(http-method) | null
  
  The HTTP method used with voice_fallback_url
  
  Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
- voice_fallback_url string(uri) | null
  
  The URL we call when a TwiML error occurs
- voice_method string(http-method) | null
  
  The HTTP method used with the voice_url
  
  Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
- voice_url string(uri) | null
  
  The URL we call when the phone number receives a call

POST /2010-04-01/Accounts/{AccountSid}/Applications.json

curl \
 -X POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Applications.json \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'ApiVersion=string&FriendlyName=string&MessageStatusCallback=https%3A%2F%2Fexample.com&SmsFallbackMethod=HEAD&SmsFallbackUrl=https%3A%2F%2Fexample.com&SmsMethod=HEAD&SmsStatusCallback=https%3A%2F%2Fexample.com&SmsUrl=https%3A%2F%2Fexample.com&StatusCallback=https%3A%2F%2Fexample.com&StatusCallbackMethod=HEAD&VoiceCallerIdLookup=true&VoiceFallbackMethod=HEAD&VoiceFallbackUrl=https%3A%2F%2Fexample.com&VoiceMethod=HEAD&VoiceUrl=https%3A%2F%2Fexample.com'

Request example

{
  "ApiVersion": "string",
  "FriendlyName": "string",
  "MessageStatusCallback": "https://example.com",
  "SmsFallbackMethod": "HEAD",
  "SmsFallbackUrl": "https://example.com",
  "SmsMethod": "HEAD",
  "SmsStatusCallback": "https://example.com",
  "SmsUrl": "https://example.com",
  "StatusCallback": "https://example.com",
  "StatusCallbackMethod": "HEAD",
  "VoiceCallerIdLookup": true,
  "VoiceFallbackMethod": "HEAD",
  "VoiceFallbackUrl": "https://example.com",
  "VoiceMethod": "HEAD",
  "VoiceUrl": "https://example.com"
}

Request examples

{
  "ApiVersion": "string",
  "FriendlyName": "string",
  "MessageStatusCallback": "https://example.com",
  "SmsFallbackMethod": "HEAD",
  "SmsFallbackUrl": "https://example.com",
  "SmsMethod": "HEAD",
  "SmsStatusCallback": "https://example.com",
  "SmsUrl": "https://example.com",
  "StatusCallback": "https://example.com",
  "StatusCallbackMethod": "HEAD",
  "VoiceCallerIdLookup": true,
  "VoiceFallbackMethod": "HEAD",
  "VoiceFallbackUrl": "https://example.com",
  "VoiceMethod": "HEAD",
  "VoiceUrl": "https://example.com"
}

Response examples (201)

{
  "account_sid": "string",
  "api_version": "string",
  "date_created": "string",
  "date_updated": "string",
  "friendly_name": "string",
  "message_status_callback": "https://example.com",
  "sid": "string",
  "sms_fallback_method": "HEAD",
  "sms_fallback_url": "https://example.com",
  "sms_method": "HEAD",
  "sms_status_callback": "https://example.com",
  "sms_url": "https://example.com",
  "status_callback": "https://example.com",
  "status_callback_method": "HEAD",
  "uri": "https://example.com",
  "voice_caller_id_lookup": true,
  "voice_fallback_method": "HEAD",
  "voice_fallback_url": "https://example.com",
  "voice_method": "HEAD",
  "voice_url": "https://example.com"
}

Response examples (201)

{
  "account_sid": "string",
  "api_version": "string",
  "date_created": "string",
  "date_updated": "string",
  "friendly_name": "string",
  "message_status_callback": "https://example.com",
  "sid": "string",
  "sms_fallback_method": "HEAD",
  "sms_fallback_url": "https://example.com",
  "sms_method": "HEAD",
  "sms_status_callback": "https://example.com",
  "sms_url": "https://example.com",
  "status_callback": "https://example.com",
  "status_callback_method": "HEAD",
  "uri": "https://example.com",
  "voice_caller_id_lookup": true,
  "voice_fallback_method": "HEAD",
  "voice_fallback_url": "https://example.com",
  "voice_method": "HEAD",
  "voice_url": "https://example.com"
}