# SignalWire API Documentation

This is the complete API documentation for connecting to the SignalWire API using MindCloud's Universal API.

MindCloud offers one normalized API to access 3,400+ apps from a single place. It centralizes authentication and normalizes app APIs so they are easier and more consistent to use.

## Quickstart

1. A **MindCloud account** — sign in or create an account at [MindCloud](https://app.mindcloud.co).
2. A **MindCloud API Key** — create one in [API Keys](https://app.mindcloud.co/user/api-keys). Keep it on your server.
3. At least one **SignalWire connection** — create or choose one in [Connections](https://app.mindcloud.co/credentials). Note its `connectionId`.

```text
POST https://connect.mindcloud.co/v2/universal/apps/signalWire/actions/{actionSlug}/run
```

## SignalWire actions

- PUT `assign-a-resource-as-a-call-handler-for-a-domain-application` Assign a resource as a call handler for a Domain Application.
- PUT `assign-a-resource-to-a-phone-route` Assign a Resource to a Phone Route
- PUT `assign-a-resource-to-a-sip-endpoint` Assign a Resource to a SIP endpoint
- POST `create-a-document` Create a Document
- POST `create-ai-agent` Create AI Agent
- POST `create-call-flow` Create Call Flow
- POST `create-chat-token` Create Chat Token
- POST `create-conference-room` Create Conference Room
- POST `create-cxml-script` Create cXML Script
- POST `create-cxml-webhook` Create cXML Webhook
- POST `create-freeswitch-connector` Create FreeSWITCH Connector
- POST `create-guest-embed-token` Create Guest Embed Token
- POST `create-pubsub-token` Create PubSub Token
- POST `create-relay-application` Create Relay Application
- POST `create-sip-endpoint` Create SIP Endpoint
- POST `create-sip-gateway` Create SIP Gateway
- POST `create-subscriber` Create Subscriber
- POST `create-subscriber-guest-token` Create Subscriber Guest Token
- POST `create-subscriber-invite-token` Create Subscriber Invite Token
- POST `create-subscriber-sip-endpoint` Create Subscriber SIP Endpoint
- POST `create-subscriber-token` Create Subscriber Token
- POST `create-swml-script` Create SWML Script
- POST `create-swml-webhook` Create SWML Webhook
- DELETE `delete-a-document` Delete a Document
- DELETE `delete-ai-agent` Delete AI Agent
- DELETE `delete-call-flow` Delete Call Flow
- DELETE `delete-chunk` Delete Chunk
- DELETE `delete-conference-room` Delete Conference Room
- DELETE `delete-cxml-application` Delete cXML Application
- DELETE `delete-cxml-script` Delete cXML Script
- DELETE `delete-cxml-webhook` Delete cXML Webhook
- DELETE `delete-dialogflow-agent` Delete Dialogflow Agent
- DELETE `delete-freeswitch-connector` Delete FreeSWITCH Connector
- DELETE `delete-relay-application` Delete Relay Application
- DELETE `delete-resource` Delete Resource
- DELETE `delete-sip-endpoint` Delete SIP Endpoint
- DELETE `delete-sip-gateway` Delete SIP Gateway
- DELETE `delete-subscriber` Delete Subscriber
- DELETE `delete-subscriber-sip-endpoint` Delete Subscriber SIP Endpoint
- DELETE `delete-swml-script` Delete SWML Script
- DELETE `delete-swml-webhook` Delete SWML Webhook
- PUT `deploy-call-flow-version` Deploy Call Flow Version
- GET `get-ai-agent` Get AI Agent
- GET `get-call-flow` Get Call Flow
- GET `get-conference-room` Get Conference Room
- GET `get-cxml-application` Get cXML Application
- GET `get-cxml-script` Get cXML Script
- GET `get-cxml-webhook` Get cXML Webhook
- GET `get-dialogflow-agent` Get Dialogflow Agent
- GET `get-fax-log` Get Fax Log
- GET `get-freeswitch-connector` Get FreeSWITCH Connector
- GET `get-message-log` Get Message Log
- GET `get-relay-application` Get Relay Application
- GET `get-resource` Get Resource
- GET `get-sip-endpoint` Get SIP Endpoint
- GET `get-sip-gateway` Get SIP Gateway
- GET `get-subscriber` Get Subscriber
- GET `get-subscriber-sip-endpoint` Get Subscriber SIP Endpoint
- GET `get-swml-script` Get SWML Script
- GET `get-swml-webhook` Get SWML Webhook
- GET `get-voice-log` Get Voice Log
- GET `list-ai-agent-addresses` List AI Agent Addresses
- GET `list-ai-agents` List AI Agents
- GET `list-call-flow-addresses` List Call Flow Addresses
- GET `list-call-flow-versions` List Call Flow Versions
- GET `list-call-flows` List Call Flows
- GET `list-chunks` List Chunks
- GET `list-conference-room-addresses` List Conference Room Addresses
- GET `list-conference-rooms` List Conference Rooms
- GET `list-conferences` List Conferences
- GET `list-cxml-application-addresses` List cXML Application Addresses
- GET `list-cxml-applications` List cXML Applications
- GET `list-cxml-script-addresses` List cXML Script Addresses
- GET `list-cxml-scripts` List cXML Scripts
- GET `list-cxml-webhook-addresses` List cXML Webhook Addresses
- GET `list-cxml-webhooks` List cXML Webhooks
- GET `list-dialogflow-agent-addresses` List Dialogflow Agent Addresses
- GET `list-dialogflow-agents` List Dialogflow Agents
- GET `list-documents` List Documents
- GET `list-fabric-addresses-assigned-to-a-sip-gateway` List Fabric Addresses assigned to a SIP Gateway
- GET `list-fabric-resources` List Fabric Resources
- GET `list-fax-logs` List Fax Logs
- GET `list-freeswitch-connector-addresses` List FreeSWITCH Connector Addresses
- GET `list-freeswitch-connectors` List FreeSWITCH Connectors
- GET `list-log-events` List Log Events
- GET `list-message-logs` List Message Logs
- GET `list-relay-application-addresses` List Relay Application Addresses
- GET `list-relay-applications` List Relay Applications
- GET `list-resource-addresses` List Resource Addresses
- GET `list-sip-endpoint-addresses` List SIP Endpoint Addresses
- GET `list-sip-endpoints` List SIP Endpoints
- GET `list-sip-gateways` List SIP Gateways
- GET `list-subscriber-addresses` List Subscriber Addresses
- GET `list-subscriber-sip-endpoints` List Subscriber SIP Endpoints
- GET `list-subscribers` List Subscribers
- GET `list-swml-script-addresses` List SWML Script Addresses
- GET `list-swml-scripts` List SWML Scripts
- GET `list-swml-webhook-addresses` List SWML Webhook Addresses
- GET `list-swml-webhooks` List SWML Webhooks
- GET `list-voice-logs` List Voice Logs
- POST `refresh-subscriber-token` Refresh Subscriber Token
- GET `retrieve-chunk` Retrieve Chunk
- GET `search-documents` Search Documents
- PUT `send-call-commands` Send Call Commands
- PUT `update-a-document` Update a Document
- PUT `update-ai-agent` Update AI Agent
- PUT `update-call-flow` Update Call Flow
- PUT `update-conference-room` Update Conference Room
- PUT `update-cxml-application` Update cXML Application
- PUT `update-cxml-script` Update cXML Script
- PUT `update-cxml-webhook` Update cXML Webhook
- PUT `update-dialogflow-agent` Update Dialogflow Agent
- PUT `update-freeswitch-connector` Update FreeSWITCH Connector
- PUT `update-relay-application` Update Relay Application
- PUT `update-sip-endpoint` Update SIP Endpoint
- PUT `update-sip-gateway` Update SIP Gateway
- PUT `update-subscriber` Update Subscriber
- PUT `update-subscriber-sip-endpoint` Update Subscriber SIP Endpoint
- PUT `update-swml-script` Update SWML Script
- PUT `update-swml-webhook` Update SWML Webhook