REST Client Methods

Applications

View as Markdown

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

sidstringRequiredformat: "uuid"
The unique identifier for the Application.
account_sidstringRequiredformat: "uuid"
The unique identifier for the Account that created this Application.
api_versionstringRequired
The version of the SignalWire API.
date_createdstringRequired
The date, in RFC 2822 GMT format, this Application was created.
date_updatedstringRequired
The date, in RFC 2822 GMT format, this Application was updated.
friendly_namestringRequired
A named unique identifier for the resource.
uristringRequired
The URI for this Application.
voice_urlstring or nullRequired
The URL to request when a phone number receives a call or fax.
voice_methodstring or nullRequired

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

voice_fallback_urlstring or nullRequired

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

voice_fallback_methodstring or nullRequired

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

status_callbackstring or nullRequired
The URL to pass status updates to the Application.
status_callback_methodstring or nullRequired

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

voice_caller_id_lookupboolean or nullRequired
Whether or not to look up a caller's ID from the database. Always null.
sms_urlstring or nullRequired
The URL to request when an SMS is received.
sms_methodstring or nullRequired

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

sms_fallback_urlstring or nullRequired

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

sms_fallback_methodstring or nullRequired

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

sms_status_callbackstring or nullRequired
The URL to receive status updates for messages sent via this Application.
sms_status_callback_methodstring or nullRequired

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

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

Example object

The Application Object
1{
2  "sid": "string",
3  "account_sid": "string",
4  "api_version": "string",
5  "date_created": "string",
6  "date_updated": "string",
7  "friendly_name": "string",
8  "uri": "string",
9  "voice_url": "string",
10  "voice_method": "string",
11  "voice_fallback_url": "string",
12  "voice_fallback_method": "string",
13  "status_callback": "string",
14  "status_callback_method": "string",
15  "voice_caller_id_lookup": true,
16  "sms_url": "string",
17  "sms_method": "string",
18  "sms_fallback_url": "string",
19  "sms_fallback_method": "string",
20  "sms_status_callback": "string",
21  "sms_status_callback_method": "string",
22  "message_status_callback": "string"
23}