Sign in
Applications

Create an Application

Create an Application.

Permissions

The API token must include one of the following scopes: Voice or Messaging or Fax.

post/Accounts/{AccountSid}/Applications

Path parameters

AccountSidstring uuid required

The Account ID that has the Application.

Request body

FriendlyNamestring required

A named unique identifier for the resource. Allowed characters: A-Za-z0-9_-. Maximum of 100 characters.

MessageStatusCallbackstring

If a message's ApplicationSid is set to this Application's Sid, when a message receives a status change, SignalWire will send a POST request to this URL with the message's details.

SmsFallbackMethod'GET' | 'POST'

Whether the request to SmsFallbackUrl is a GET or a POST. Default is POST.

SmsFallbackUrlstring

The URL SignalWire will request if errors occur when fetching the SmsUrl.

SmsMethod'GET' | 'POST'

Whether the request to SmsUrl is a GET or a POST. Default is POST.

SmsStatusCallbackstring

If a message's ApplicationSid is set to this Application's Sid, when a message receives a status change, SignalWire will send a POST request to this URL with the message's details.

SmsUrlstring

The URL to request when an SMS is received.

StatusCallbackstring

The URL to pass status updates to the Application.

StatusCallbackMethod'GET' | 'POST'

Whether the request to the StatusCallback URL is a GET or a POST. Default is POST.

VoiceCallerIdLookupboolean

Whether or not to look up a caller's ID from the database. Possible values are true or false. Default is false.

VoiceFallbackMethod'GET' | 'POST'

Whether the request to VoiceFallbackUrl is a GET or a POST. Default is POST.

VoiceFallbackUrlstring

The URL SignalWire will request if errors occur when fetching the Url.

VoiceMethod'GET' | 'POST'

Whether the request to VoiceUrl is a GET or a POST. Default is POST.

VoiceUrlstring

The URL to request when a phone number receives a call or fax.

Example request

{
  "FriendlyName": "My Friendly Name",
  "MessageStatusCallback": "http://www.example.com/sms-status-callback",
  "SmsFallbackMethod": "GET",
  "SmsFallbackUrl": "http://www.example.com/sms-fallback",
  "SmsMethod": "GET",
  "SmsStatusCallback": "http://www.example.com/sms-status-callback",
  "SmsUrl": "http://example.com",
  "StatusCallback": "http://example.com",
  "StatusCallbackMethod": "POST",
  "VoiceFallbackMethod": "GET",
  "VoiceFallbackUrl": "http://example.com",
  "VoiceMethod": "GET",
  "VoiceUrl": "http://example.com"
}

Response

The request has succeeded.

account_sidstring uuid

The unique identifier for the Account that created this Application.

api_versionstring

The version of the SignalWire API.

date_createdstring

The date, in RFC 2822 GMT format, this Application was created.

date_updatedstring

The date, in RFC 2822 GMT format, this Application was updated.

sidstring uuid

The unique identifier for the Application.

friendly_namestring

A named unique identifier for the resource. Allowed characters: A-Za-z0-9_-. Maximum of 100 characters.

message_status_callbackstring

If a message's ApplicationSid is set to this Application's Sid, when a message receives a status change, SignalWire will send a POST request to this URL with the message's details.

sms_fallback_methodstring

Whether the request to SmsFallbackUrl is a GET or a POST. Default is POST.

sms_fallback_urlstring

The URL SignalWire will request if errors occur when fetching the SmsUrl.

sms_methodstring

Whether the request to SmsUrl is a GET or a POST. Default is POST.

sms_status_callbackstring

If a message's ApplicationSid is set to this Application's Sid, when a message receives a status change, SignalWire will send a POST request to this URL with the message's details.

sms_urlstring

The URL to request when an SMS is received.

status_callbackstring

The URL to pass status updates to the Application.

status_callback_methodstring

Whether the request to the StatusCallback URL is a GET or a POST. Default is POST.

uristring

The URI for this Application.

voice_caller_id_lookupboolean

Whether or not to look up a caller's ID from the database. Possible values are true or false. Default is false.

voice_fallback_methodstring

Whether the request to VoiceFallbackUrl is a GET or a POST. Default is POST.

voice_fallback_urlstring

The URL SignalWire will request if errors occur when fetching the Url.

voice_methodstring

Whether the request to VoiceUrl is a GET or a POST. Default is POST.

voice_urlstring

The URL to request when a phone number receives a call or fax.

Example response

{
  "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
  "api_version": "2010-04-01",
  "date_created": "Sat, 15 Sept 2018 10:00:00 +0000",
  "date_updated": "Sat, 16 Sept 2018 10:00:00 +0000",
  "sid": "b3877c40-da60-4998-90ad-b792e98472af",
  "friendly_name": "My Friendly Name",
  "message_status_callback": "http://www.example.com/sms-status-callback",
  "sms_fallback_method": "GET",
  "sms_fallback_url": "http://www.example.com/sms-fallback",
  "sms_method": "GET",
  "sms_status_callback": "http://www.example.com/sms-status-callback",
  "sms_url": "http://example.com",
  "status_callback": "http://example.com",
  "status_callback_method": "POST",
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications/b3877c40-da60-4998-90ad-b792e98472af.json",
  "voice_fallback_method": "GET",
  "voice_fallback_url": "http://example.com",
  "voice_method": "GET",
  "voice_url": "http://example.com"
}

Changes