> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes. # Server ## Docs - [Authentication](https://signalwire.com/docs/apis/relay/server/authentication.md): Authenticate a backend Relay connection by sending signalwire.connect with your project ID and API token as the first WebSocket message. - [Events and subscriptions](https://signalwire.com/docs/apis/relay/server/events.md): How Relay pushes events to your backend connection, and how to subscribe to inbound events with contexts. - [Connection lifecycle](https://signalwire.com/docs/apis/relay/server/connection-lifecycle.md): How a backend Relay connection lives — from connect through detecting a dropped socket, rotating credentials, and reconnecting. - [Errors](https://signalwire.com/docs/apis/relay/server/errors.md): Every Relay response carries a code and message your backend checks for success or failure. ## API Docs - [signalwire.authorization.state](https://signalwire.com/docs/apis/relay/server/signalwire/signalwire-authorization-state.md): SignalWire Relay — Server > Signalwire - [signalwire.connect](https://signalwire.com/docs/apis/relay/server/signalwire/signalwire-connect.md): SignalWire Relay — Server > Signalwire - [signalwire.ping](https://signalwire.com/docs/apis/relay/server/signalwire/signalwire-ping.md): SignalWire Relay — Server > Signalwire - [signalwire.reauthenticate](https://signalwire.com/docs/apis/relay/server/signalwire/signalwire-reauthenticate.md): SignalWire Relay — Server > Signalwire - [signalwire.receive](https://signalwire.com/docs/apis/relay/server/signalwire/signalwire-receive.md): SignalWire Relay — Server > Signalwire - [signalwire.unreceive](https://signalwire.com/docs/apis/relay/server/signalwire/signalwire-unreceive.md): SignalWire Relay — Server > Signalwire - [calling.answer](https://signalwire.com/docs/apis/relay/server/calling/calling-answer.md): SignalWire Relay — Server > Calling > Call Setup & Lifecycle - [calling.call.receive](https://signalwire.com/docs/apis/relay/server/calling/calling-call-receive.md): SignalWire Relay — Server > Calling > Call Setup & Lifecycle - [calling.call.state](https://signalwire.com/docs/apis/relay/server/calling/calling-call-state.md): SignalWire Relay — Server > Calling > Call Setup & Lifecycle - [calling.dial](https://signalwire.com/docs/apis/relay/server/calling/calling-dial.md): SignalWire Relay — Server > Calling > Call Setup & Lifecycle - [calling.end](https://signalwire.com/docs/apis/relay/server/calling/calling-end.md): SignalWire Relay — Server > Calling > Call Setup & Lifecycle - [calling.error](https://signalwire.com/docs/apis/relay/server/calling/calling-error.md): SignalWire Relay — Server > Calling > Call Setup & Lifecycle - [calling.ring](https://signalwire.com/docs/apis/relay/server/calling/calling-ring.md): SignalWire Relay — Server > Calling > Call Setup & Lifecycle - [calling.connect](https://signalwire.com/docs/apis/relay/server/calling/calling-connect.md): SignalWire Relay — Server > Calling > Call Control & Bridging - [calling.disconnect](https://signalwire.com/docs/apis/relay/server/calling/calling-disconnect.md): SignalWire Relay — Server > Calling > Call Control & Bridging - [calling.pass](https://signalwire.com/docs/apis/relay/server/calling/calling-pass.md): SignalWire Relay — Server > Calling > Call Control & Bridging - [calling.refer](https://signalwire.com/docs/apis/relay/server/calling/calling-refer.md): SignalWire Relay — Server > Calling > Call Control & Bridging - [calling.transfer](https://signalwire.com/docs/apis/relay/server/calling/calling-transfer.md): SignalWire Relay — Server > Calling > Call Control & Bridging - [calling.play](https://signalwire.com/docs/apis/relay/server/calling/calling-play.md): SignalWire Relay — Server > Calling > Playback - [calling.play.pause](https://signalwire.com/docs/apis/relay/server/calling/calling-play-pause.md): SignalWire Relay — Server > Calling > Playback - [calling.play.resume](https://signalwire.com/docs/apis/relay/server/calling/calling-play-resume.md): SignalWire Relay — Server > Calling > Playback - [calling.play.stop](https://signalwire.com/docs/apis/relay/server/calling/calling-play-stop.md): SignalWire Relay — Server > Calling > Playback - [calling.play.volume](https://signalwire.com/docs/apis/relay/server/calling/calling-play-volume.md): SignalWire Relay — Server > Calling > Playback - [calling.bind_digit](https://signalwire.com/docs/apis/relay/server/calling/calling-bind-digit.md): SignalWire Relay — Server > Calling > Prompt & Collect Input - [calling.clear_digit_bindings](https://signalwire.com/docs/apis/relay/server/calling/calling-clear-digit-bindings.md): SignalWire Relay — Server > Calling > Prompt & Collect Input - [calling.collect](https://signalwire.com/docs/apis/relay/server/calling/calling-collect.md): SignalWire Relay — Server > Calling > Prompt & Collect Input - [calling.collect.start_input_timers](https://signalwire.com/docs/apis/relay/server/calling/calling-collect-start-input-timers.md): SignalWire Relay — Server > Calling > Prompt & Collect Input - [calling.collect.stop](https://signalwire.com/docs/apis/relay/server/calling/calling-collect-stop.md): SignalWire Relay — Server > Calling > Prompt & Collect Input - [calling.play_and_collect](https://signalwire.com/docs/apis/relay/server/calling/calling-play-and-collect.md): SignalWire Relay — Server > Calling > Prompt & Collect Input - [calling.play_and_collect.stop](https://signalwire.com/docs/apis/relay/server/calling/calling-play-and-collect-stop.md): SignalWire Relay — Server > Calling > Prompt & Collect Input - [calling.play_and_collect.volume](https://signalwire.com/docs/apis/relay/server/calling/calling-play-and-collect-volume.md): SignalWire Relay — Server > Calling > Prompt & Collect Input - [calling.send_digits](https://signalwire.com/docs/apis/relay/server/calling/calling-send-digits.md): SignalWire Relay — Server > Calling > Prompt & Collect Input - [calling.pay](https://signalwire.com/docs/apis/relay/server/calling/calling-pay.md): SignalWire Relay — Server > Calling > Payments - [calling.pay.stop](https://signalwire.com/docs/apis/relay/server/calling/calling-pay-stop.md): SignalWire Relay — Server > Calling > Payments - [calling.record](https://signalwire.com/docs/apis/relay/server/calling/calling-record.md): SignalWire Relay — Server > Calling > Recording - [calling.record.pause](https://signalwire.com/docs/apis/relay/server/calling/calling-record-pause.md): SignalWire Relay — Server > Calling > Recording - [calling.record.resume](https://signalwire.com/docs/apis/relay/server/calling/calling-record-resume.md): SignalWire Relay — Server > Calling > Recording - [calling.record.stop](https://signalwire.com/docs/apis/relay/server/calling/calling-record-stop.md): SignalWire Relay — Server > Calling > Recording - [calling.detect](https://signalwire.com/docs/apis/relay/server/calling/calling-detect.md): SignalWire Relay — Server > Calling > Detection - [calling.detect.stop](https://signalwire.com/docs/apis/relay/server/calling/calling-detect-stop.md): SignalWire Relay — Server > Calling > Detection - [calling.receive_fax](https://signalwire.com/docs/apis/relay/server/calling/calling-receive-fax.md): SignalWire Relay — Server > Calling > Fax - [calling.receive_fax.stop](https://signalwire.com/docs/apis/relay/server/calling/calling-receive-fax-stop.md): SignalWire Relay — Server > Calling > Fax - [calling.send_fax](https://signalwire.com/docs/apis/relay/server/calling/calling-send-fax.md): SignalWire Relay — Server > Calling > Fax - [calling.send_fax.stop](https://signalwire.com/docs/apis/relay/server/calling/calling-send-fax-stop.md): SignalWire Relay — Server > Calling > Fax - [calling.stream](https://signalwire.com/docs/apis/relay/server/calling/calling-stream.md): SignalWire Relay — Server > Calling > Media Streaming & Tap - [calling.stream.stop](https://signalwire.com/docs/apis/relay/server/calling/calling-stream-stop.md): SignalWire Relay — Server > Calling > Media Streaming & Tap - [calling.tap](https://signalwire.com/docs/apis/relay/server/calling/calling-tap.md): SignalWire Relay — Server > Calling > Media Streaming & Tap - [calling.tap.stop](https://signalwire.com/docs/apis/relay/server/calling/calling-tap-stop.md): SignalWire Relay — Server > Calling > Media Streaming & Tap - [calling.live_transcribe](https://signalwire.com/docs/apis/relay/server/calling/calling-live-transcribe.md): SignalWire Relay — Server > Calling > Transcription & Translation - [calling.live_translate](https://signalwire.com/docs/apis/relay/server/calling/calling-live-translate.md): SignalWire Relay — Server > Calling > Transcription & Translation - [calling.transcribe](https://signalwire.com/docs/apis/relay/server/calling/calling-transcribe.md): SignalWire Relay — Server > Calling > Transcription & Translation - [calling.transcribe.stop](https://signalwire.com/docs/apis/relay/server/calling/calling-transcribe-stop.md): SignalWire Relay — Server > Calling > Transcription & Translation - [calling.denoise](https://signalwire.com/docs/apis/relay/server/calling/calling-denoise.md): SignalWire Relay — Server > Calling > Audio Processing - [calling.denoise.stop](https://signalwire.com/docs/apis/relay/server/calling/calling-denoise-stop.md): SignalWire Relay — Server > Calling > Audio Processing - [calling.echo](https://signalwire.com/docs/apis/relay/server/calling/calling-echo.md): SignalWire Relay — Server > Calling > Audio Processing - [calling.queue.enter](https://signalwire.com/docs/apis/relay/server/calling/calling-queue-enter.md): SignalWire Relay — Server > Calling > Queues - [calling.queue.leave](https://signalwire.com/docs/apis/relay/server/calling/calling-queue-leave.md): SignalWire Relay — Server > Calling > Queues - [calling.join_conference](https://signalwire.com/docs/apis/relay/server/calling/calling-join-conference.md): SignalWire Relay — Server > Calling > Conferencing & Rooms - [calling.join_room](https://signalwire.com/docs/apis/relay/server/calling/calling-join-room.md): SignalWire Relay — Server > Calling > Conferencing & Rooms - [calling.leave_conference](https://signalwire.com/docs/apis/relay/server/calling/calling-leave-conference.md): SignalWire Relay — Server > Calling > Conferencing & Rooms - [calling.leave_room](https://signalwire.com/docs/apis/relay/server/calling/calling-leave-room.md): SignalWire Relay — Server > Calling > Conferencing & Rooms - [calling.ai](https://signalwire.com/docs/apis/relay/server/calling/calling-ai.md): SignalWire Relay — Server > Calling > AI Agent - [calling.ai.stop](https://signalwire.com/docs/apis/relay/server/calling/calling-ai-stop.md): SignalWire Relay — Server > Calling > AI Agent - [calling.ai_adjust](https://signalwire.com/docs/apis/relay/server/calling/calling-ai-adjust.md): SignalWire Relay — Server > Calling > AI Agent - [calling.ai_hold](https://signalwire.com/docs/apis/relay/server/calling/calling-ai-hold.md): SignalWire Relay — Server > Calling > AI Agent - [calling.ai_message](https://signalwire.com/docs/apis/relay/server/calling/calling-ai-message.md): SignalWire Relay — Server > Calling > AI Agent - [calling.ai_unhold](https://signalwire.com/docs/apis/relay/server/calling/calling-ai-unhold.md): SignalWire Relay — Server > Calling > AI Agent - [calling.amazon_bedrock](https://signalwire.com/docs/apis/relay/server/calling/calling-amazon-bedrock.md): SignalWire Relay — Server > Calling > AI Agent - [calling.ai_sidecar](https://signalwire.com/docs/apis/relay/server/calling/calling-ai-sidecar.md): SignalWire Relay — Server > Calling > AI Sidecar - [calling.ai_sidecar.ask](https://signalwire.com/docs/apis/relay/server/calling/calling-ai-sidecar-ask.md): SignalWire Relay — Server > Calling > AI Sidecar - [calling.ai_sidecar.poke](https://signalwire.com/docs/apis/relay/server/calling/calling-ai-sidecar-poke.md): SignalWire Relay — Server > Calling > AI Sidecar - [calling.ai_sidecar.status](https://signalwire.com/docs/apis/relay/server/calling/calling-ai-sidecar-status.md): SignalWire Relay — Server > Calling > AI Sidecar - [calling.ai_sidecar.stop](https://signalwire.com/docs/apis/relay/server/calling/calling-ai-sidecar-stop.md): SignalWire Relay — Server > Calling > AI Sidecar - [calling.user_event](https://signalwire.com/docs/apis/relay/server/calling/calling-user-event.md): SignalWire Relay — Server > Calling > Custom Events - [messaging.receive](https://signalwire.com/docs/apis/relay/server/messaging/messaging-receive.md): SignalWire Relay — Server > Messaging - [messaging.send](https://signalwire.com/docs/apis/relay/server/messaging/messaging-send.md): SignalWire Relay — Server > Messaging - [signalwire.provision](https://signalwire.com/docs/apis/relay/server/provisioning/signalwire-provision.md): SignalWire Relay — Server > Provisioning - [queuing.relay.tasks](https://signalwire.com/docs/apis/relay/server/queuing/queuing-relay-tasks.md): SignalWire Relay — Server > Tasking ## AsyncAPI Specification - [AsyncAPI JSON](https://signalwire.com/docs/asyncapi.json): raw AsyncAPI 2.6.0 specification for the WebSocket channels, JSON format - [AsyncAPI YAML](https://signalwire.com/docs/asyncapi.yaml): raw AsyncAPI 2.6.0 specification for the WebSocket channels, YAML format > **Note:** This page contains both a page directory (above) and the landing page content (below). The page directory is generated for agent use and does not appear on the landing page. > Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes. # Overview > Relay is a single WebSocket connection your backend uses to control calls, send messages, run tasks, and react to real-time events. SignalWire Relay gives your backend one persistent WebSocket connection to SignalWire. Over that single connection you place and control voice calls, send and receive messages, hand work to long-running processes, and react to real-time events the moment they happen. That's the key difference from the [REST API](/docs/apis), where each request is its own HTTP round trip. Relay keeps the connection open, so SignalWire can push events straight to you — a call was answered, a recording finished, a message arrived — without you polling for them. You open the connection once, authenticate, then send commands and receive events over the same socket for as long as it stays open. > **Note** > > This is the **Server** reference, for backend code that holds your SignalWire credentials. Building a browser or mobile app? See the [Client reference](/docs/apis/relay/client) for the Call Fabric and WebRTC surface. ## How a connection works Every Relay session follows the same shape: 1. **Open the WebSocket** to `wss://relay.signalwire.com`. 2. **Authenticate** by sending `signalwire.connect` as your very first message. A WebSocket has no `Authorization` header, so your credentials — a project ID and API token — travel in that first message instead. See [Authentication](/docs/apis/relay/server/authentication). 3. **Send commands and receive events** over the connection — dial a call, send a message, and listen for the events each service emits. Every response carries a result you check for success or failure. See [Errors](/docs/apis/relay/server/errors). #### [Authentication](/docs/apis/relay/server/authentication) Open the socket, then log in with your first message using your project ID and API token. #### [Events and subscriptions](/docs/apis/relay/server/events) React to server-pushed events, and subscribe to inbound ones — like an incoming call — with contexts. #### [Connection lifecycle](/docs/apis/relay/server/connection-lifecycle) Detect a dropped connection, rotate your API token in place, and reconnect cleanly. #### [Errors](/docs/apis/relay/server/errors) Every response carries a `code` and a `message`. Learn how to tell success from failure and what the common codes mean. ## Services Relay groups its commands and events into services. They all share the one connection you open with `signalwire.connect`. #### Signalwire The entry point. Authenticate, open the connection, and subscribe to the contexts whose events you want to receive. #### Calling Control voice calls: dial and answer, bridge calls together, play and collect audio, record, run detection, and add AI agents. #### Messaging Send SMS and MMS, and react to incoming messages and delivery updates. #### Tasking Push a JSON payload to a long-running Relay client from a short-lived process such as a web request handler or a cron job. #### Provisioning Provision a Relay connector and receive the runtime configuration it should run with. Browse the full command-and-event reference for each service in the API reference under this tab. ## Use Relay from an SDK You can speak the Relay WebSocket protocol directly, but most developers use a SignalWire SDK that wraps the connection, authentication, and every command in idiomatic, type-safe methods. The [Server SDKs](/docs/server-sdks) — the Realtime clients for backend code (Python, Node, and more) — expose the `calling`, `messaging`, and `tasking` services as native objects. See the [Realtime reference](/docs/server-sdks/reference/python/relay). Pick the language that matches your stack, or read on to work with the protocol directly.