Get SWML Script
Changed onRetrieves one stored SWML Script by resource ID so you can inspect the instructions used by its calling or messaging handler. Use List SWML Scripts to discover IDs, or a SWML Webhook when instructions must come from your server at request time.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice, Messaging, Fax, or Video.
Learn more about API scopes.
Request
- Base URLhttps://{Your_Space_Name}.signalwire.com
- URLhttps://{Your_Space_Name}.signalwire.com/api/fabric/resources/swml_scripts/{id}
- AuthHTTP basic
Path parameters
Universal Unique Identifier.
Unique ID of a SWML Script.
Response
The request has succeeded.
Example response
{
"display_name": "Welcome Script",
"type": "swml_script",
"created_at": "2024-05-06T12:20:00Z",
"updated_at": "2024-05-06T12:20:00Z",
"swml_script": {
"display_name": "Booking Assistant",
"script_type": "calling",
"request_url": "https://example.com/swml_script",
"contents": {
"version": "1.0.0",
"sections": {
"main": [
{
"play": {
"url": "https://cdn.signalwire.com/swml/audio.mp3"
}
}
]
}
},
"status_callback_url": "https://website.com/status",
"status_callback_method": "POST"
}
}Changes
- breaking
the
///response's property type changed from no type toobjectfor status - breaking
the
///response's property type changed from no type toobjectfor status - info
removed from the
///response propertyallOflist for the response status - info
removed from the
///response propertyallOflist for the response status - info
added 'unevaluatedProperties' constraint to the
///response property for the status - info
added 'unevaluatedProperties' constraint to the
///response property for the status
- breaking
- breaking
the
////////////response's property type changed from no type toobjectfor status - breaking
the
////////////////////////////response's property type changed fromarrayto no type for status - breaking
the
////////////////////////////response's property type changed fromarrayto no type for status - breaking
the
/////////////////////////response's property type changed fromarrayto no type for status - breaking
the
/////////////////////////response's property type changed fromarrayto no type for status - breaking
the
////////////////////////response's property type changed fromarrayto no type for status - breaking
the
////////////////////////response's property type changed fromarrayto no type for status - breaking
the
/////////////////////response's property type changed fromarrayto no type for status - breaking
the
/////////////////////response's property type changed fromarrayto no type for status - breaking
the
////////////////////////////response's property type changed fromarrayto no type for status - breaking
the
////////////////////////////response's property type changed fromarrayto no type for status - breaking
the
/////////////////////////response's property type changed fromarrayto no type for status - breaking
the
/////////////////////////response's property type changed fromarrayto no type for status - breaking
the
////////////////////////response's property type changed fromarrayto no type for status - breaking
the
////////////////////////response's property type changed fromarrayto no type for status - breaking
the
/////////////////////response's property type changed fromarrayto no type for status - breaking
the
/////////////////////response's property type changed fromarrayto no type for status - breaking
the
////////////response's property type changed from no type toobjectfor status - breaking
the
////////////////////////////response's property type changed fromarrayto no type for status - breaking
the
////////////////////////////response's property type changed fromarrayto no type for status - breaking
the
/////////////////////////response's property type changed fromarrayto no type for status - breaking
the
/////////////////////////response's property type changed fromarrayto no type for status - breaking
the
////////////////////////response's property type changed fromarrayto no type for status - breaking
the
////////////////////////response's property type changed fromarrayto no type for status - breaking
the
/////////////////////response's property type changed fromarrayto no type for status - breaking
the
/////////////////////response's property type changed fromarrayto no type for status - breaking
the
////////////////////////////response's property type changed fromarrayto no type for status - breaking
the
////////////////////////////response's property type changed fromarrayto no type for status - breaking
the
/////////////////////////response's property type changed fromarrayto no type for status - breaking
the
/////////////////////////response's property type changed fromarrayto no type for status - breaking
the
////////////////////////response's property type changed fromarrayto no type for status - breaking
the
////////////////////////response's property type changed fromarrayto no type for status - breaking
the
/////////////////////response's property type changed fromarrayto no type for status - breaking
the
/////////////////////response's property type changed fromarrayto no type for status
This list may be incomplete.
- breaking
Some revisions have not been checked yet.