Skip to main content

Create an Application

Use this endpoint for the Applications method to create a new application within your account.

Parameters

ParameterDescription
FriendlyName RequiredThe description, up to 64 characters long, of the account.
MessageStatusCallback OptionalIf 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 OptionalWhether the request to SmsFallbackUrl is a GET or a POST. Default is POST.
SmsFallbackUrl OptionalThe URL SignalWire will request if errors occur when fetching the SmsUrl.
SmsMethod OptionalWhether the request to SmsUrl is a GET or a POST. Default is POST.
SmsStatusCallback OptionalIf 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.
SmsUrl OptionalThe URL to request when an SMS is received.
StatusCallback OptionalThe URL to pass status updates to the application.
StatusCallbackMethod OptionalWhether the request to the StatusCallback URL is a GET or a POST. Default is POST.
VoiceCallerIdLookup OptionalWhether or not to look up a caller's ID from the database. Possible values are true or false. Default is false.
VoiceFallbackMethod OptionalWhether the request to VoiceFallbackUrl is a GET or a POST. Default is POST.
VoiceFallbackUrl OptionalThe URL SignalWire will request if errors occur when fetching the Url.
VoiceMethod OptionalWhether the request to VoiceUrl is a GET or POST. Default is POST.
VoiceUrl OptionalThe URL to request when a phone number receives a call or fax.

Request

curl https://example.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Applications.json \
-X POST \
--data-urlencode "FriendlyName=Application1" \
-u "YourProjectID:YourAuthToken"

Responses

200 OK

{
"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"
}