How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SignalWire SWML Scripts API

Endpoints related to creating & managing SWML Scripts

SignalWire SWML Scripts API is one of 80 APIs that SignalWire publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SWML Scripts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 6 operations across 3 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://{space_name}.signalwire.com.

6 operations 3 paths 26 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://{space_name}.signalwire.com
Authentication
HTTP Basic, HTTP Bearer
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 2

SignalWire SWML Scripts API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (SignalWireBasicAuth). It accepts HTTP bearer tokens (SignalWireBearerAuth). By default, every request must be authenticated.

  • SignalWireBasicAuth — SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed…
  • SignalWireBearerAuth — SignalWire Bearer Token Authentication for subscriber endpoints. The client sends HTTP requests with the Authorization header containing the word Bearer follow…

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

SWML Scripts 6

Endpoints related to creating & managing SWML Scripts

GET
/api/fabric/resources/swml_scripts
List SWML Scripts
list_swml_scripts → 200401404500
POST
/api/fabric/resources/swml_scripts
Create SWML Script
create_swml_script body → 200401404422500
GET
/api/fabric/resources/swml_scripts/{id}
Get SWML Script
get_swml_script 1 param → 200401404500
PUT
/api/fabric/resources/swml_scripts/{id}
Update SWML Script
update_swml_script 1 param body → 200401404422500
DELETE
/api/fabric/resources/swml_scripts/{id}
Delete SWML Script
delete_swml_script 1 param → 204401404500
GET
/api/fabric/resources/swml_scripts/{id}/addresses
List SWML Script Addresses
list_swml_script_addresses 1 param → 200401404500

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are FabricAddressApp (9 properties), SwmlScriptResponse (7 properties), CallingSwmlScript (7 properties), MessagingSwmlScript (5 properties). Each schema is shown below with its type and property counts.

Types.StatusCodes.StatusCode401
object
Access is unauthorized.
1 property 1 required
SwmlScriptResponse
object
7 properties 7 required
AddressChannel
VideoChannel
object
1 property 1 required
SwmlScriptPaginationresponse
object
4 properties 2 required
MessagingSwmlScriptUpdateRequest
object
Request body to update an existing messaging SWML Script. All fields are optional — include only what you want to change.
3 properties
SwmlScriptUpdateRequest
Body shape for updating an existing SWML Script. All fields are optional — include only what you want to change. Choose a [Calling Script](schema/CallingSwmlSc…
AudioChannel
object
1 property 1 required
uuid
string
Universal Unique Identifier.
Types.StatusCodes.StatusCode404
object
The server cannot find the requested resource.
1 property 1 required
SwmlScriptCreateStatusCode422
object
The request contains invalid parameters. See errors for details.
1 property 1 required
MessagingSwmlScript
object
A SWML Script that handles inbound SMS or MMS messages. The contents field carries a [messaging SWML document](/docs/swml/reference/messaging).
5 properties 5 required
SwmlScriptCreateRequest
Body shape for creating a SWML Script. Choose a [Calling Script](schema/CallingSwmlScriptCreateRequest) for inbound or outbound calls or a [Messaging Script](s…
CallingSwmlScriptCreateRequest
object
Request body to create a SWML Script that handles inbound or outbound calls.
4 properties 2 required
MessagingSwmlScriptCreateRequest
object
Request body to create a SWML Script that handles inbound SMS or MMS messages.
3 properties 2 required
SwmlScript
A SWML Script — either a [Calling Script](schema/CallingSwmlScript) for inbound or outbound calls, or a [Messaging Script](schema/MessagingSwmlScript) for inbo…
Types.StatusCodes.StatusCode500
object
An internal server error occurred.
1 property 1 required
SwmlScriptListResponse
object
2 properties 2 required
CallingSwmlScript
object
A SWML Script that handles inbound or outbound calls. The contents field carries a [calling SWML document](/docs/swml/reference/calling).
7 properties 5 required
SWMLScriptAddressPaginationResponse
object
4 properties 2 required
MessagingChannel
object
1 property 1 required
Types.StatusCodes.RestApiErrorItem
object
Details about a specific error.
5 properties 4 required
FabricAddressApp
object
9 properties 9 required
SWMLScriptAddressListResponse
object
2 properties 2 required
SwmlScriptUpdateStatusCode422
object
The request contains invalid parameters. See errors for details.
1 property 1 required
CallingSwmlScriptUpdateRequest
object
Request body to update an existing calling SWML Script. All fields are optional — include only what you want to change.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

signalwire-swml-scripts-api-openapi.yml Raw ↑

Other APIs SignalWire publishes across the network.

SignalWire Calling API (JSON-RPC)
SignalWire Accounts API
SignalWire Addresses API
SignalWire AI Agents: Custom API
SignalWire AI Agents: Dialogflow API
SignalWire AI Chat API
SignalWire AI Webhooks API
SignalWire Applications API
SignalWire Available Phone Numbers API
SignalWire Call Flows API
SignalWire Calling Webhooks API
SignalWire Calls API
Where this information came from

This is an independent, third-party profile of SignalWire SWML Scripts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.