Skip to navigation
Compatibility REST APIApplications

Create an Application

View as MarkdownOpen in Claude

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.

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

Path parameters

AccountSidstringRequiredformat: "uuid"
The Account ID that has the Application.

Request

This endpoint expects an object.
FriendlyNamestringRequired<=64 characters
A named unique identifier for the resource.
VoiceUrlstringOptionalformat: "uri"
The URL to request when a phone number receives a call or fax.
VoiceMethodenumOptionalDefaults to POST

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

Allowed values:
VoiceFallbackUrlstringOptionalformat: "uri"

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

VoiceFallbackMethodenumOptionalDefaults to POST

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

Allowed values:
StatusCallbackstringOptionalformat: "uri"
The URL to pass status updates to the Application.
StatusCallbackMethodenumOptionalDefaults to POST

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

Allowed values:
SmsUrlstringOptionalformat: "uri"
The URL to request when an SMS is received.
SmsMethodenumOptionalDefaults to POST

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

Allowed values:
SmsFallbackUrlstringOptionalformat: "uri"

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

SmsFallbackMethodenumOptionalDefaults to POST

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

Allowed values:
SmsStatusCallbackstringOptionalformat: "uri"
The URL to receive status updates for messages sent via this Application.
SmsStatusCallbackMethodenumOptionalDefaults to POST

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

Allowed values:

Response

Response containing a newly created application.
sidstringformat: "uuid"
The unique identifier for the Application.
account_sidstringformat: "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.
friendly_namestring
A named unique identifier for the resource.
uristring
The URI for this Application.
voice_urlstring or null
The URL to request when a phone number receives a call or fax.
voice_methodstring or null

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

voice_fallback_urlstring or null

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

voice_fallback_methodstring or null

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

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

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

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

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

sms_fallback_urlstring or null

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

sms_fallback_methodstring or null

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

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

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

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

Errors

400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error