SignalWire API Documentation
This is the complete API documentation for connecting to the SignalWire API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet SignalWire: Manage SignalWire calling, datasphere, fabric, fax, messaging, and voice resources from your SignalWire space. Keep reading to get started.
Quickstart
Before you run your first SignalWire request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one SignalWire connection — create or choose one in Connections. Note its
connectionId.
Every SignalWire action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/signalWire/latest/actions/{actionSlug}You need a MindCloud API Key and a SignalWire connection. Then call an action such as Get AI Agent:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/signalWire/latest/actions/get-ai-agent" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--get \
--data-urlencode "connectionId=$CONNECTION_ID"Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authentication
Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected SignalWire account that should run the action. MindCloud stores and refreshes the SignalWire credentials behind that connection, so you never send provider tokens with your requests.
Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.
SignalWire actions
All 120 published actions for this SignalWire version. Each page documents the endpoint, arguments, and response controls.
- PUTAssign a resource as a call handler for a Domain Application.
- PUTAssign a Resource to a Phone Route
- PUTAssign a Resource to a SIP endpoint
- POSTCreate a Document
- POSTCreate AI Agent
- POSTCreate Call Flow
- POSTCreate Chat Token
- POSTCreate Conference Room
- POSTCreate cXML Script
- POSTCreate cXML Webhook
- POSTCreate FreeSWITCH Connector
- POSTCreate Guest Embed Token
- POSTCreate PubSub Token
- POSTCreate Relay Application
- POSTCreate SIP Endpoint
- POSTCreate SIP Gateway
- POSTCreate Subscriber
- POSTCreate Subscriber Guest Token
- POSTCreate Subscriber Invite Token
- POSTCreate Subscriber SIP Endpoint
- POSTCreate Subscriber Token
- POSTCreate SWML Script
- POSTCreate SWML Webhook
- DELETEDelete a Document
- DELETEDelete AI Agent
- DELETEDelete Call Flow
- DELETEDelete Chunk
- DELETEDelete Conference Room
- DELETEDelete cXML Application
- DELETEDelete cXML Script
- DELETEDelete cXML Webhook
- DELETEDelete Dialogflow Agent
- DELETEDelete FreeSWITCH Connector
- DELETEDelete Relay Application
- DELETEDelete Resource
- DELETEDelete SIP Endpoint
- DELETEDelete SIP Gateway
- DELETEDelete Subscriber
- DELETEDelete Subscriber SIP Endpoint
- DELETEDelete SWML Script
- DELETEDelete SWML Webhook
- PUTDeploy Call Flow Version
- GETGet AI Agent
- GETGet Call Flow
- GETGet Conference Room
- GETGet cXML Application
- GETGet cXML Script
- GETGet cXML Webhook
- GETGet Dialogflow Agent
- GETGet Fax Log
- GETGet FreeSWITCH Connector
- GETGet Message Log
- GETGet Relay Application
- GETGet Resource
- GETGet SIP Endpoint
- GETGet SIP Gateway
- GETGet Subscriber
- GETGet Subscriber SIP Endpoint
- GETGet SWML Script
- GETGet SWML Webhook
- GETGet Voice Log
- GETList AI Agent Addresses
- GETList AI Agents
- GETList Call Flow Addresses
- GETList Call Flow Versions
- GETList Call Flows
- GETList Chunks
- GETList Conference Room Addresses
- GETList Conference Rooms
- GETList Conferences
- GETList cXML Application Addresses
- GETList cXML Applications
- GETList cXML Script Addresses
- GETList cXML Scripts
- GETList cXML Webhook Addresses
- GETList cXML Webhooks
- GETList Dialogflow Agent Addresses
- GETList Dialogflow Agents
- GETList Documents
- GETList Fabric Addresses assigned to a SIP Gateway
- GETList Fabric Resources
- GETList Fax Logs
- GETList FreeSWITCH Connector Addresses
- GETList FreeSWITCH Connectors
- GETList Log Events
- GETList Message Logs
- GETList Relay Application Addresses
- GETList Relay Applications
- GETList Resource Addresses
- GETList SIP Endpoint Addresses
- GETList SIP Endpoints
- GETList SIP Gateways
- GETList Subscriber Addresses
- GETList Subscriber SIP Endpoints
- GETList Subscribers
- GETList SWML Script Addresses
- GETList SWML Scripts
- GETList SWML Webhook Addresses
- GETList SWML Webhooks
- GETList Voice Logs
- POSTRefresh Subscriber Token
- GETRetrieve Chunk
- GETSearch Documents
- PUTSend Call Commands
- PUTUpdate a Document
- PUTUpdate AI Agent
- PUTUpdate Call Flow
- PUTUpdate Conference Room
- PUTUpdate cXML Application
- PUTUpdate cXML Script
- PUTUpdate cXML Webhook
- PUTUpdate Dialogflow Agent
- PUTUpdate FreeSWITCH Connector
- PUTUpdate Relay Application
- PUTUpdate SIP Endpoint
- PUTUpdate SIP Gateway
- PUTUpdate Subscriber
- PUTUpdate Subscriber SIP Endpoint
- PUTUpdate SWML Script
- PUTUpdate SWML Webhook
Related apps
More Communication apps on the Universal API, behind the same REST shape. Or browse all apps.