REST Client MethodsApplications

Update

View as Markdown

Use this endpoint for the Applications method to modify the properties of an application.

Path parameters

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

Request

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

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.

Request examples

Update an application

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.applications('Sid')
5      .update({smsUrl: 'http://your-application.com/docs/sms.xml'})
6      .then(application => console.log(application.friendlyName))
7      .done();

Update an application’s VoiceUrl

Update the URL that SignalWire will request when a call to your account is received.

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.applications('Sid')
5      .update({
6         voiceUrl: 'http://your-application.com/docs/voice.xml'
7       })
8      .then(application => console.log(application.friendlyName))
9      .done();