Applications
An application contains a set of URLs and other data that tells SignalWire how to behave when calls and messages are received. They are useful for creating a single configuration that is shared between many numbers.
Properties
Attribute | Type | |
---|---|---|
account_sid | string | The unique identifier for the account that created this application. |
api_version | string | The version of the SignalWire API. |
date_created | datetime | The date, in RFC 2822 GMT format, this application was created. |
date_updated | datetime | The date, in RFC 2822 GMT format, this application was updated. |
friendly_name | string | The description, up to 64 characters long, of the account. |
message_status_callback | string | 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. |
sid | string | The unique identifier for the account. |
sms_fallback_method | string | Whether the request to SmsFallbackUrl is a GET or a POST . |
sms_fallback_url | string | The URL SignalWire will request if errors occur when fetching the SmsUrl . |
sms_method | string | Whether the request to SmsUrl is a GET or a POST . |
sms_status_callback | string | 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_url | string | The URL to request when an SMS is received. |
status_callback | string | The URL to pass status updates to the application. |
status_callback_method | string | Whether the request to StatusCallback is a GET or a POST . |
uri | string | The URI for this application. |
voice_caller_id_lookup | boolean | Whether or not to look up a caller's ID from the database. Possible values are true or false . |
voice_fallback_method | string | Whether the request to VoiceFallbackUrl is a GET or POST . |
voice_fallback_url | string | The URL SignalWire will request if errors occur when fetching the Url . |
voice_method | string | Whether the request to VoiceUrl is a GET or a POST . |
voice_url | string | The URL to request when a call is received. |
A sample application returned from the API:
{
"account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
"api_version": "2010-04-01",
"date_created": "Sun, 16 Sept 2018 10:00:00 +0000",
"date_updated": "Mon, 17 Sept 2018 20:00:00 +0000",
"friendly_name": "Application1",
"message_status_callback": "http://www.example.com/sms-status-callback",
"sid": "b3877c40-da60-4998-90ad-b792e98472af",
"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": "GET",
"uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications/b3877c40-da60-4998-90ad-b792e98472af.json",
"voice_caller_id_lookup": false,
"voice_fallback_method": "GET",
"voice_fallback_url": "http://www.example.com/voice-callback",
"voice_method": "GET",
"voice_url": "http://example.com"
}