> 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. # Client ## Docs - [Authentication](https://signalwire.com/docs/apis/relay/client/authentication.md): Authenticate a browser or mobile Relay connection by sending signalwire.connect with a short-lived JWT as the first WebSocket message. - [Events and subscriptions](https://signalwire.com/docs/apis/relay/client/events.md): How Relay pushes call, member, and room events to your client, and how to subscribe to a room's event feed. - [Connection lifecycle](https://signalwire.com/docs/apis/relay/client/connection-lifecycle.md): How a browser or mobile Relay connection lives — from connect through token refresh, a graceful server disconnect, and reconnect. - [Errors](https://signalwire.com/docs/apis/relay/client/errors.md): Every Relay response carries a code and message your client checks for success or failure. ## API Docs - [signalwire.authorization.state](https://signalwire.com/docs/apis/relay/client/signalwire/signalwire-authorization-state.md): SignalWire Relay — Client > Signalwire - [signalwire.connect](https://signalwire.com/docs/apis/relay/client/signalwire/signalwire-connect.md): SignalWire Relay — Client > Signalwire - [signalwire.disconnect](https://signalwire.com/docs/apis/relay/client/signalwire/signalwire-disconnect.md): SignalWire Relay — Client > Signalwire - [signalwire.ping](https://signalwire.com/docs/apis/relay/client/signalwire/signalwire-ping.md): SignalWire Relay — Client > Signalwire - [signalwire.reauthenticate](https://signalwire.com/docs/apis/relay/client/signalwire/signalwire-reauthenticate.md): SignalWire Relay — Client > Signalwire - [webrtc.message](https://signalwire.com/docs/apis/relay/client/webrtc/webrtc-message.md): SignalWire Relay — Client > Webrtc - [webrtc.verto](https://signalwire.com/docs/apis/relay/client/webrtc/webrtc-verto.md): SignalWire Relay — Client > Webrtc - [subscriber.online](https://signalwire.com/docs/apis/relay/client/fabric/subscriber-online.md): SignalWire Relay — Client > Call Fabric > Session - [subscriber.offline](https://signalwire.com/docs/apis/relay/client/fabric/subscriber-offline.md): SignalWire Relay — Client > Call Fabric > Session - [call.hangup](https://signalwire.com/docs/apis/relay/client/fabric/call-hangup.md): SignalWire Relay — Client > Call Fabric > Call Control - [call.end](https://signalwire.com/docs/apis/relay/client/fabric/call-end.md): SignalWire Relay — Client > Call Fabric > Call Control - [call.mute](https://signalwire.com/docs/apis/relay/client/fabric/call-mute.md): SignalWire Relay — Client > Call Fabric > Call Control - [call.unmute](https://signalwire.com/docs/apis/relay/client/fabric/call-unmute.md): SignalWire Relay — Client > Call Fabric > Call Control - [call.deaf](https://signalwire.com/docs/apis/relay/client/fabric/call-deaf.md): SignalWire Relay — Client > Call Fabric > Call Control - [call.undeaf](https://signalwire.com/docs/apis/relay/client/fabric/call-undeaf.md): SignalWire Relay — Client > Call Fabric > Call Control - [call.raisehand](https://signalwire.com/docs/apis/relay/client/fabric/call-raisehand.md): SignalWire Relay — Client > Call Fabric > Call Control - [call.lowerhand](https://signalwire.com/docs/apis/relay/client/fabric/call-lowerhand.md): SignalWire Relay — Client > Call Fabric > Call Control - [call.state](https://signalwire.com/docs/apis/relay/client/fabric/call-state.md): SignalWire Relay — Client > Call Fabric > Call Control - [call.joined](https://signalwire.com/docs/apis/relay/client/fabric/call-joined.md): SignalWire Relay — Client > Call Fabric > Call Control - [call.left](https://signalwire.com/docs/apis/relay/client/fabric/call-left.md): SignalWire Relay — Client > Call Fabric > Call Control - [call.connect](https://signalwire.com/docs/apis/relay/client/fabric/call-connect.md): SignalWire Relay — Client > Call Fabric > Call Control - [call.audioflags.set](https://signalwire.com/docs/apis/relay/client/fabric/call-audioflags-set.md): SignalWire Relay — Client > Call Fabric > Audio & Media - [call.denoise.set](https://signalwire.com/docs/apis/relay/client/fabric/call-denoise-set.md): SignalWire Relay — Client > Call Fabric > Audio & Media - [call.digit.send](https://signalwire.com/docs/apis/relay/client/fabric/call-digit-send.md): SignalWire Relay — Client > Call Fabric > Audio & Media - [call.lowbitrate.set](https://signalwire.com/docs/apis/relay/client/fabric/call-lowbitrate-set.md): SignalWire Relay — Client > Call Fabric > Audio & Media - [call.microphone.sensitivity.set](https://signalwire.com/docs/apis/relay/client/fabric/call-microphone-sensitivity-set.md): SignalWire Relay — Client > Call Fabric > Audio & Media - [call.microphone.volume.set](https://signalwire.com/docs/apis/relay/client/fabric/call-microphone-volume-set.md): SignalWire Relay — Client > Call Fabric > Audio & Media - [call.speaker.volume.set](https://signalwire.com/docs/apis/relay/client/fabric/call-speaker-volume-set.md): SignalWire Relay — Client > Call Fabric > Audio & Media - [call.vmuted.hide.set](https://signalwire.com/docs/apis/relay/client/fabric/call-vmuted-hide-set.md): SignalWire Relay — Client > Call Fabric > Audio & Media - [call.layout.list](https://signalwire.com/docs/apis/relay/client/fabric/call-layout-list.md): SignalWire Relay — Client > Call Fabric > Room & Layout - [call.layout.set](https://signalwire.com/docs/apis/relay/client/fabric/call-layout-set.md): SignalWire Relay — Client > Call Fabric > Room & Layout - [call.lock](https://signalwire.com/docs/apis/relay/client/fabric/call-lock.md): SignalWire Relay — Client > Call Fabric > Room & Layout - [call.unlock](https://signalwire.com/docs/apis/relay/client/fabric/call-unlock.md): SignalWire Relay — Client > Call Fabric > Room & Layout - [room.started](https://signalwire.com/docs/apis/relay/client/fabric/room-started.md): SignalWire Relay — Client > Call Fabric > Room & Layout - [room.subscribed](https://signalwire.com/docs/apis/relay/client/fabric/room-subscribed.md): SignalWire Relay — Client > Call Fabric > Room & Layout - [room.updated](https://signalwire.com/docs/apis/relay/client/fabric/room-updated.md): SignalWire Relay — Client > Call Fabric > Room & Layout - [room.ended](https://signalwire.com/docs/apis/relay/client/fabric/room-ended.md): SignalWire Relay — Client > Call Fabric > Room & Layout - [rooms.subscribed](https://signalwire.com/docs/apis/relay/client/fabric/rooms-subscribed.md): SignalWire Relay — Client > Call Fabric > Room & Layout - [layout.changed](https://signalwire.com/docs/apis/relay/client/fabric/layout-changed.md): SignalWire Relay — Client > Call Fabric > Room & Layout - [call.member.list](https://signalwire.com/docs/apis/relay/client/fabric/call-member-list.md): SignalWire Relay — Client > Call Fabric > Members - [call.member.position.set](https://signalwire.com/docs/apis/relay/client/fabric/call-member-position-set.md): SignalWire Relay — Client > Call Fabric > Members - [call.member.remove](https://signalwire.com/docs/apis/relay/client/fabric/call-member-remove.md): SignalWire Relay — Client > Call Fabric > Members - [member.joined](https://signalwire.com/docs/apis/relay/client/fabric/member-joined.md): SignalWire Relay — Client > Call Fabric > Members - [member.left](https://signalwire.com/docs/apis/relay/client/fabric/member-left.md): SignalWire Relay — Client > Call Fabric > Members - [member.updated](https://signalwire.com/docs/apis/relay/client/fabric/member-updated.md): SignalWire Relay — Client > Call Fabric > Members - [member.talking](https://signalwire.com/docs/apis/relay/client/fabric/member-talking.md): SignalWire Relay — Client > Call Fabric > Members - [member.promoted](https://signalwire.com/docs/apis/relay/client/fabric/member-promoted.md): SignalWire Relay — Client > Call Fabric > Members - [member.demoted](https://signalwire.com/docs/apis/relay/client/fabric/member-demoted.md): SignalWire Relay — Client > Call Fabric > Members - [call.play](https://signalwire.com/docs/apis/relay/client/fabric/call-play.md): SignalWire Relay — Client > Call Fabric > Media Events - [call.record](https://signalwire.com/docs/apis/relay/client/fabric/call-record.md): SignalWire Relay — Client > Call Fabric > Media Events - [call.collect](https://signalwire.com/docs/apis/relay/client/fabric/call-collect.md): SignalWire Relay — Client > Call Fabric > Media Events - [call.tap](https://signalwire.com/docs/apis/relay/client/fabric/call-tap.md): SignalWire Relay — Client > Call Fabric > Media Events - [call.stream](https://signalwire.com/docs/apis/relay/client/fabric/call-stream.md): SignalWire Relay — Client > Call Fabric > Media Events - [call.detect](https://signalwire.com/docs/apis/relay/client/fabric/call-detect.md): SignalWire Relay — Client > Call Fabric > Media Events - [recording.started](https://signalwire.com/docs/apis/relay/client/fabric/recording-started.md): SignalWire Relay — Client > Call Fabric > Media Events - [recording.updated](https://signalwire.com/docs/apis/relay/client/fabric/recording-updated.md): SignalWire Relay — Client > Call Fabric > Media Events - [recording.ended](https://signalwire.com/docs/apis/relay/client/fabric/recording-ended.md): SignalWire Relay — Client > Call Fabric > Media Events - [playback.started](https://signalwire.com/docs/apis/relay/client/fabric/playback-started.md): SignalWire Relay — Client > Call Fabric > Media Events - [playback.updated](https://signalwire.com/docs/apis/relay/client/fabric/playback-updated.md): SignalWire Relay — Client > Call Fabric > Media Events - [playback.ended](https://signalwire.com/docs/apis/relay/client/fabric/playback-ended.md): SignalWire Relay — Client > Call Fabric > Media Events - [stream.started](https://signalwire.com/docs/apis/relay/client/fabric/stream-started.md): SignalWire Relay — Client > Call Fabric > Media Events - [stream.ended](https://signalwire.com/docs/apis/relay/client/fabric/stream-ended.md): SignalWire Relay — Client > Call Fabric > Media Events - [conversation.message](https://signalwire.com/docs/apis/relay/client/fabric/conversation-message.md): SignalWire Relay — Client > Call Fabric > Conversation Events - [conversation.message.updated](https://signalwire.com/docs/apis/relay/client/fabric/conversation-message-updated.md): SignalWire Relay — Client > Call Fabric > Conversation Events - [conversation.joined](https://signalwire.com/docs/apis/relay/client/fabric/conversation-joined.md): SignalWire Relay — Client > Call Fabric > Conversation Events - [conversation.broadcast](https://signalwire.com/docs/apis/relay/client/fabric/conversation-broadcast.md): SignalWire Relay — Client > Call Fabric > Conversation Events - [call.dial](https://signalwire.com/docs/apis/relay/client/fabric/call-dial.md): SignalWire Relay — Client > Call Fabric > Call Events - [call.refer](https://signalwire.com/docs/apis/relay/client/fabric/call-refer.md): SignalWire Relay — Client > Call Fabric > Call Events - [call.send_digits](https://signalwire.com/docs/apis/relay/client/fabric/call-send-digits.md): SignalWire Relay — Client > Call Fabric > Call Events - [call.echo](https://signalwire.com/docs/apis/relay/client/fabric/call-echo.md): SignalWire Relay — Client > Call Fabric > Call Events - [call.denoise](https://signalwire.com/docs/apis/relay/client/fabric/call-denoise.md): SignalWire Relay — Client > Call Fabric > Call Events - [call.queue](https://signalwire.com/docs/apis/relay/client/fabric/call-queue.md): SignalWire Relay — Client > Call Fabric > Call Events - [call.room](https://signalwire.com/docs/apis/relay/client/fabric/call-room.md): SignalWire Relay — Client > Call Fabric > Call Events - [call.fax](https://signalwire.com/docs/apis/relay/client/fabric/call-fax.md): SignalWire Relay — Client > Call Fabric > Call Events - [call.pay](https://signalwire.com/docs/apis/relay/client/fabric/call-pay.md): SignalWire Relay — Client > Call Fabric > Call Events - [call.transcribe](https://signalwire.com/docs/apis/relay/client/fabric/call-transcribe.md): SignalWire Relay — Client > Call Fabric > Call Events - [call.ai](https://signalwire.com/docs/apis/relay/client/fabric/call-ai.md): SignalWire Relay — Client > Call Fabric > Call Events - [user_event](https://signalwire.com/docs/apis/relay/client/fabric/user-event.md): SignalWire Relay — Client > Call Fabric > Call Events - [ai.begin_speaking](https://signalwire.com/docs/apis/relay/client/fabric/ai-begin-speaking.md): SignalWire Relay — Client > Call Fabric > AI Events - [ai.completion](https://signalwire.com/docs/apis/relay/client/fabric/ai-completion.md): SignalWire Relay — Client > Call Fabric > AI Events - [ai.partial_result](https://signalwire.com/docs/apis/relay/client/fabric/ai-partial-result.md): SignalWire Relay — Client > Call Fabric > AI Events - [ai.post_prompt](https://signalwire.com/docs/apis/relay/client/fabric/ai-post-prompt.md): SignalWire Relay — Client > Call Fabric > AI Events - [ai.response](https://signalwire.com/docs/apis/relay/client/fabric/ai-response.md): SignalWire Relay — Client > Call Fabric > AI Events - [ai.response_utterance](https://signalwire.com/docs/apis/relay/client/fabric/ai-response-utterance.md): SignalWire Relay — Client > Call Fabric > AI Events - [ai.sidecar](https://signalwire.com/docs/apis/relay/client/fabric/ai-sidecar.md): SignalWire Relay — Client > Call Fabric > AI Events - [ai.speech_detect](https://signalwire.com/docs/apis/relay/client/fabric/ai-speech-detect.md): SignalWire Relay — Client > Call Fabric > AI Events - [ai.stop](https://signalwire.com/docs/apis/relay/client/fabric/ai-stop.md): SignalWire Relay — Client > Call Fabric > AI Events - [ai.swaig](https://signalwire.com/docs/apis/relay/client/fabric/ai-swaig.md): SignalWire Relay — Client > Call Fabric > AI Events - [ai.swaig_action](https://signalwire.com/docs/apis/relay/client/fabric/ai-swaig-action.md): SignalWire Relay — Client > Call Fabric > AI Events - [ai.transcribe.conversation_log](https://signalwire.com/docs/apis/relay/client/fabric/ai-transcribe-conversation-log.md): SignalWire Relay — Client > Call Fabric > AI Events - [ai.transcribe.live_summarize](https://signalwire.com/docs/apis/relay/client/fabric/ai-transcribe-live-summarize.md): SignalWire Relay — Client > Call Fabric > AI Events - [ai.transcribe.utterance](https://signalwire.com/docs/apis/relay/client/fabric/ai-transcribe-utterance.md): SignalWire Relay — Client > Call Fabric > AI Events - [ai.translate.conversation_log](https://signalwire.com/docs/apis/relay/client/fabric/ai-translate-conversation-log.md): SignalWire Relay — Client > Call Fabric > AI Events - [ai.translate.live_summary](https://signalwire.com/docs/apis/relay/client/fabric/ai-translate-live-summary.md): SignalWire Relay — Client > Call Fabric > AI Events - [ai.translate.transcript_delta](https://signalwire.com/docs/apis/relay/client/fabric/ai-translate-transcript-delta.md): SignalWire Relay — Client > Call Fabric > AI Events - [ai.transparent_barge](https://signalwire.com/docs/apis/relay/client/fabric/ai-transparent-barge.md): SignalWire Relay — Client > Call Fabric > AI Events - [ai.warning](https://signalwire.com/docs/apis/relay/client/fabric/ai-warning.md): SignalWire Relay — Client > Call Fabric > AI Events ## 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 browser or mobile app uses to place and control calls with Call Fabric and WebRTC. SignalWire Relay gives your browser or mobile app one persistent WebSocket connection to SignalWire. Over that single connection you place and control voice and video calls, manage the participant who is signed in, and react to real-time call and room events the moment they happen. Relay keeps the connection open, so SignalWire can push events straight to you — a call was answered, a member joined the room, the layout changed — 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 **Client** reference, for browser and mobile apps that authenticate with a short-lived token. Building a backend integration instead? See the [Server reference](/docs/apis/relay/server) for the `calling`, `messaging`, `tasking`, and `provisioning` 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 credential — a short-lived `jwt_token` your backend generates — travels in that first message instead. See [Authentication](/docs/apis/relay/client/authentication). 3. **Send commands and receive events** over the connection — place a call, control your audio and video, and listen for the room and member events each service emits. Every response carries a result you check for success or failure. See [Errors](/docs/apis/relay/client/errors). #### [Authentication](/docs/apis/relay/client/authentication) Open the socket, then log in with your first message using a short-lived token from your backend. #### [Events and subscriptions](/docs/apis/relay/client/events) React to server-pushed call, member, and room events, and subscribe to a room's event feed. #### [Connection lifecycle](/docs/apis/relay/client/connection-lifecycle) Keep the connection healthy, refresh your token, handle a server-initiated disconnect, and reconnect cleanly. #### [Errors](/docs/apis/relay/client/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 refresh your token when it nears expiry. #### Call Fabric Control calls and conference members addressed by resource: hang up, mute and unmute, raise or lower a hand, manage members, change the room layout, and register a subscriber's presence. #### WebRTC Carry the Verto signaling for browser-based (peer) calling — the offer/answer exchange that sets up media. 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 client developers use the SignalWire Browser SDK, which wraps the connection, authentication, WebRTC signaling, and every command in idiomatic, type-safe methods — so you don't manage the socket or negotiate media yourself. See the [Browser SDK](/docs/browser-sdk/v4/guides/overview) to build calling into a web app, or read on to work with the protocol directly.