Applications

Create an Application

Changed on

Creates a reusable voice and messaging routing application in the account. The new Application also becomes an addressable cXML Application. The cXML Applications API manages existing applications but does not create them, so create Applications here.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice or Messaging or Fax.

Learn more about API scopes.

post/Accounts/{AccountSid}/Applications

Request

  • Base URL
    https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01
  • URL
    https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Applications
  • Auth
    HTTP basic

Path parameters

AccountSidstring uuid required

Universal Unique Identifier.

The Account ID that has the Application.

Request body application/x-www-form-urlencoded

FriendlyNamestring required

A named unique identifier for the resource.

VoiceUrlstring uri

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

VoiceMethod'GET' | 'POST'

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

VoiceFallbackUrlstring uri

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

VoiceFallbackMethod'GET' | 'POST'

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

StatusCallbackstring uri

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.

SmsUrlstring uri

The URL to request when an SMS is received.

SmsMethod'GET' | 'POST'

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

SmsFallbackUrlstring uri

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

SmsFallbackMethod'GET' | 'POST'

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

SmsStatusCallbackstring uri

The URL to receive status updates for messages sent via this Application.

SmsStatusCallbackMethod'GET' | 'POST'

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

Example request

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

Response

Response containing a newly created application.

sidstring uuid required

Universal Unique Identifier.

account_sidstring uuid required

Universal Unique Identifier.

api_versionstring required

The version of the SignalWire API.

date_createdstring required

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

date_updatedstring required

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

friendly_namestring required

A named unique identifier for the resource.

uristring required

The URI for this Application.

voice_urlstring nullable required

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

voice_methodstring nullable required

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

voice_fallback_urlstring nullable required

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

voice_fallback_methodstring nullable required

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

status_callbackstring nullable required

The URL to pass status updates to the Application.

status_callback_methodstring nullable required

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

voice_caller_id_lookupboolean nullable required

Whether or not to look up a caller's ID from the database. Always null.

sms_urlstring nullable required

The URL to request when an SMS is received.

sms_methodstring nullable required

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

sms_fallback_urlstring nullable required

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

sms_fallback_methodstring nullable required

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

sms_status_callbackstring nullable required

The URL to receive status updates for messages sent via this Application.

sms_status_callback_methodstring nullable required

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

message_status_callbackstring nullable required

The URL to receive status updates for messages sent via this Application.

Example response

{
  "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",
  "friendly_name": "My Friendly Name",
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications/b3877c40-da60-4998-90ad-b792e98472af.json",
  "voice_url": "http://example.com",
  "voice_method": "POST",
  "voice_fallback_url": "http://example.com",
  "voice_fallback_method": "POST",
  "status_callback": "http://example.com",
  "status_callback_method": "POST",
  "sms_url": "http://example.com",
  "sms_method": "POST",
  "sms_fallback_url": "http://www.example.com/sms-fallback",
  "sms_fallback_method": "POST",
  "sms_status_callback": "http://www.example.com/sms-status-callback",
  "sms_status_callback_method": "POST",
  "message_status_callback": "http://www.example.com/sms-status-callback"
}

Changes

  • 2916d5e3072eRevision changes
    • breaking

      the response's property type changed from string to no type, and format from uuid to no format for status

    • breaking

      the response's property type changed from string to no type, and format from uuid to no format for status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

  • 5344c0c93a4cRevision changes
    • breaking

      added 'unevaluatedProperties' constraint to the request body

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status