{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/voice-2.0/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["partial"]},"product":"Voice v2 (preview)","type":"markdown"},"seo":{"title":"Voice Relay Stream Control","siteUrl":"https://developers.sinch.com","llmstxt":{"title":"Sinch Developer Documentation","description":"LLMs.txt containing a map of all the documentation files for Sinch.","sections":[{"title":"Numbers API","description":"The Numbers API enables you to search for, view, and activate numbers. It's considered a precursor to other APIs in the Sinch product family. The numbers API can be used in tandem with any of our APIs that perform messaging or calling.","includeFiles":["docs/numbers/**/*.md","docs/numbers/**/*.yaml"],"excludeFiles":["docs/numbers/index.md"]},{"title":"Conversation API","description":"Send and receive messages globally on many popular channels with ease and confidence when using Sinch's Conversation API. Conversation API is the preferred API for sending mobile messages on SMS and other social channels with Sinch. It is a simple API with unified error messages, consistent request payloads, and common webhook payloads that are channel-agnostic.","includeFiles":["docs/conversation/**/*.md","docs/conversation/**/*.yaml"],"excludeFiles":["docs/conversation/index.md"]},{"title":"Voice API","description":"The Voice API works as a big telephony switch. The Voice API handles incoming phone calls (also known as incoming call “legs”), sets up outgoing phone calls (or outgoing call “legs”), and bridges the two. The incoming call leg may come in over a data connection (from a smartphone or web application using the Sinch SDKs) or through a local phone number (from the PSTN network). Similarly, the outgoing call leg can be over data (to another smartphone or web application using the Sinch SDKs) or the PSTN network.","includeFiles":["docs/voice/**/*.md","docs/voice/**/*.yaml"],"excludeFiles":["docs/voice/index.md"]},{"title":"Voice API v2","description":"The Voice API works as a big telephony switch. The Voice API handles incoming phone calls (also known as incoming call “legs”), sets up outgoing phone calls (or outgoing call “legs”), and bridges the two. The incoming call leg may come in over a data connection (from a smartphone or web application using the Sinch SDKs) or through a local phone number (from the PSTN network). Similarly, the outgoing call leg can be over data (to another smartphone or web application using the Sinch SDKs) or the PSTN network.","includeFiles":["docs/voice-2.0/**/*.md","docs/voice-2.0/**/*.yaml"],"excludeFiles":["docs/voice-2.0/index.md"]},{"title":"Verification API","description":"The Verification API is a platform for phone number verification. It consists of the API and different software development kits (the Sinch SDKs) that you integrate with your smartphone or web application and cloud based back-end services. Together they enable SMS, Flashcall, Phone Call and Data verification in your application.","includeFiles":["docs/verification/**/*.md","docs/verification/**/*.yaml"],"excludeFiles":["docs/verification/index.md"]},{"title":"Provisioning API","description":"Provisioning API allows you to programmatically set up your senders, accounts and templates on your favorite messaging platforms on the Conversation API. For now, you can create your first WhatsApp channel through Meta's Embedded sign up, you can configure your first SMS App and configure your webhooks. As development continues, we will be adding the most commonly used channels.","includeFiles":["docs/provisioning-api/**/*.md","docs/provisioning-api/**/*.json"],"excludeFiles":["docs/provisioning-api/index.md"]},{"title":"Elastic SIP Trunking API","description":"With Elastic SIP Trunking you can create and manage your SIP trunks and phone numbers programmatically.","includeFiles":["docs/est/**/*.md","docs/est/**/*.yaml"],"excludeFiles":["docs/est/index.md"]},{"title":"Fax API","description":"Send and receive HIPAA compliant faxes on our modern fax platform using our developer-friendly API.","includeFiles":["docs/fax/**/*.md","docs/fax/**/*.yaml"],"excludeFiles":["docs/fax/index.md"]},{"title":"In-app Voice and Video SDK","description":"The In-app Voice and Video SDK enables you to add voice and video calling capabilities directly into your mobile or web application using the Sinch SDKs.","includeFiles":["docs/in-app-calling/**/*.md"],"excludeFiles":["docs/in-app-calling/index.md"]},{"title":"Number Lookup API","description":"The Number Lookup API is designed to provide in-depth information about phone numbers, helping enterprises enhance their communication strategies and prevent fraud. By identifying the type of phone line (for example, mobile, landline, VoIP) and the associated carrier, the API allows businesses to optimize routing, reduce unnecessary costs, and improve customer engagement.","includeFiles":["docs/number-lookup-api-v2/**/*.md","docs/number-lookup-api-v2/**/*.yaml"],"excludeFiles":["docs/number-lookup-api-v2/index.md"]},{"title":"Functions","description":"Serverless compute for voice and messaging. Deploy your code and Sinch routes live calls and messages to it — no infrastructure to run.","includeFiles":["docs/functions/functions/**/*.md","docs/functions/concepts/**/*.md","docs/functions/reference/**/*.md"],"excludeFiles":["docs/functions/functions/index.md"]},{"title":"CLI","description":"One command line for every Sinch API and the full Functions lifecycle — scaffold, run locally, deploy, and manage.","includeFiles":["docs/functions/cli/**/*.md"],"excludeFiles":["docs/functions/cli/index.md"]}]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"voice-relay-stream-control","__idx":0},"children":["Voice Relay Stream Control"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Commands that can be executed on an ongoing stream."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"connection-flow-diagram","__idx":1},"children":["Connection Flow Diagram"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"sequenceDiagram\n participant SP as Sinch Platform\n participant CS as Customer WebSocket Server\n\n Note over SP,CS: WebSocket Connection\n SP->>CS: WS connect request\n alt WS accepted\n CS-->>SP: Accept connection\n else WS rejected\n CS--xSP: Non-success response\n rect rgb(255, 204, 204)\n Note over SP,CS: Stream ended\n end\n end\n\n Note over SP,CS: Session Start\n SP->>CS: ConnectRequest {command: connect}\n Note right of CS: First protocol message. Server decides to accept or decline.\n\n alt Accepted\n CS->>SP: AnswerResponse {command: answer}\n else Declined\n CS->>SP: Close WebSocket (no answer)\n rect rgb(255, 204, 204)\n Note over SP,CS: Stream ended\n end\n end\n\n Note over SP,CS: Live Relay Loop\n loop While call is active\n rect rgb(240, 240, 240)\n Note over SP,CS: STT (Platform to Server)\n SP->>CS: TextMessage {command: text}\n end\n\n rect rgb(240, 240, 240)\n Note over SP,CS: TTS (Server to Platform)\n CS->>SP: TextResponseMessage {command: text}\n Note left of SP: Multiple chunks allowed. A batch ends when isLast=true.\n end\n\n rect rgb(240, 240, 240)\n Note over SP,CS: Playback Status (Platform to Server)\n SP->>CS: PlaybackEvent {command: textPlaybackStart|textPlaybackStop|textPlaybackCancel}\n end\n\n rect rgb(240, 240, 240)\n Note over SP,CS: DTMF (Bidirectional)\n SP->>CS: DtmfReceive {command: dtmf}\n CS->>SP: DtmfSend {command: dtmf}\n end\n\n rect rgb(240, 240, 240)\n Note over SP,CS: Interrupt Handling\n alt Speech detected during TTS\n SP->>CS: InterruptDetect {command: interrupt}\n alt Manual stop requested\n CS->>SP: Interrupt {command: interrupt}\n end\n else No speech interruption\n Note over SP,CS: Playback continues normally.\n end\n end\n end\n\n Note over SP,CS: Call End\n alt Customer closes connection\n CS->>SP: WebSocket close\n rect rgb(255, 204, 204)\n Note over SP,CS: Stream ended\n end\n else Sinch ends call\n SP->>CS: WebSocket close\n rect rgb(255, 204, 204)\n Note over SP,CS: Stream ended\n end\n end\n","diagramHtml":"","diagramHtmlDark":""},"children":["sequenceDiagram\n participant SP as Sinch Platform\n participant CS as Customer WebSocket Server\n\n Note over SP,CS: WebSocket Connection\n SP->>CS: WS connect request\n alt WS accepted\n CS-->>SP: Accept connection\n else WS rejected\n CS--xSP: Non-success response\n rect rgb(255, 204, 204)\n Note over SP,CS: Stream ended\n end\n end\n\n Note over SP,CS: Session Start\n SP->>CS: ConnectRequest {command: connect}\n Note right of CS: First protocol message. Server decides to accept or decline.\n\n alt Accepted\n CS->>SP: AnswerResponse {command: answer}\n else Declined\n CS->>SP: Close WebSocket (no answer)\n rect rgb(255, 204, 204)\n Note over SP,CS: Stream ended\n end\n end\n\n Note over SP,CS: Live Relay Loop\n loop While call is active\n rect rgb(240, 240, 240)\n Note over SP,CS: STT (Platform to Server)\n SP->>CS: TextMessage {command: text}\n end\n\n rect rgb(240, 240, 240)\n Note over SP,CS: TTS (Server to Platform)\n CS->>SP: TextResponseMessage {command: text}\n Note left of SP: Multiple chunks allowed. A batch ends when isLast=true.\n end\n\n rect rgb(240, 240, 240)\n Note over SP,CS: Playback Status (Platform to Server)\n SP->>CS: PlaybackEvent {command: textPlaybackStart|textPlaybackStop|textPlaybackCancel}\n end\n\n rect rgb(240, 240, 240)\n Note over SP,CS: DTMF (Bidirectional)\n SP->>CS: DtmfReceive {command: dtmf}\n CS->>SP: DtmfSend {command: dtmf}\n end\n\n rect rgb(240, 240, 240)\n Note over SP,CS: Interrupt Handling\n alt Speech detected during TTS\n SP->>CS: InterruptDetect {command: interrupt}\n alt Manual stop requested\n CS->>SP: Interrupt {command: interrupt}\n end\n else No speech interruption\n Note over SP,CS: Playback continues normally.\n end\n end\n end\n\n Note over SP,CS: Call End\n alt Customer closes connection\n CS->>SP: WebSocket close\n rect rgb(255, 204, 204)\n Note over SP,CS: Stream ended\n end\n else Sinch ends call\n SP->>CS: WebSocket close\n rect rgb(255, 204, 204)\n Note over SP,CS: Stream ended\n end\n end\n"]}]},"headings":[{"value":"Voice Relay Stream Control","id":"voice-relay-stream-control","depth":2},{"value":"Connection Flow Diagram","id":"connection-flow-diagram","depth":3}],"frontmatter":{"seo":{"title":"Voice Relay Stream Control"}},"lastModified":"2026-08-31T13:48:15.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/voice-2.0/api-reference/x-voice-relay/vr_connection_flow","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}