{"templateId":"markdown","sharedDataIds":{},"props":{"metadata":{"markdoc":{"tagList":["admonition","json-schema"]},"product":"Voice","type":"markdown"},"seo":{"title":"connectStream action","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":"SMS API","description":"The SMS API allows you to send and receive SMS messages with a few easy steps. You can also send bulk SMS messages to multiple customers using the Sinch SMS service.","includeFiles":["docs/sms/**/*.md","docs/sms/**/*.yaml"],"excludeFiles":["docs/sms/index.md"]},{"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":"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"]}],"hide":false,"excludeFiles":[]},"description":"Details about the connectStream SVAML action."},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"connectstream","__idx":0},"children":["connectStream"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Important!"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This feature is in closed beta - Please, contact Sinch sales for more details."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Determines how to route a call to a Stream/websocket server."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Available to use in a response to an ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/voice/api-reference/voice/callbacks/ice"},"children":["Incoming Call Event"]}," callback."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"use-cases","__idx":1},"children":["Use cases"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Connect inbound calls via one of the standard voice channels (PSTN, SIP or IN-App) to the new Stream channel",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Reply ICE with connectStream() action."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Connect outbound calls via one of the standard voice channels into a conference room, and add a stream channel into the same conference, to combine 2 or more outbound calls with a stream outbound call.",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Initiate a conferenceCallout to connect a standard voice channel (PSTN, SIP or In-App) into a conference room"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Initiate a customCallout to connect a stream outbound call leg."]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["ConnectStream Action example code"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"Json","header":{"controls":{"copy":{}}},"source":"\n{\n \"action\": {\n \"name\": \"connectStream\",\n \"destination\": {\n \"type\": \"Websocket\",\n \"endpoint\": \"wss://yourcompany.com/websocket-server\"\n },\n \"streamingOptions\": {\n \"version\": 1,\n \"sampleRate\": 44100\n },\n \"maxDuration\": 3000,\n \"callHeaders\": [\n {\n \"key\": \"foo\",\n \"value\": \"bar\"\n },\n {\n \"key\": \"baz\",\n \"value\": \"qux\"\n }\n ]\n }\n}\n","lang":"Json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Schema"]}]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../voice.yaml#/components/schemas/svaml.action.connectStream"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/svaml.action.connectStream"},"destinationWebSocket":{"type":"object","description":"Specifies where to route the Stream call.","required":["type","endpoint"],"properties":{"type":{"type":"string","description":"This attribute defines the streaming protocol - currently only `Websocket` is supported.","enum":["Websocket"],"x-enumDescriptions":{"Websocket":"Use websocket stream protocol"},"example":"Websocket"},"endpoint":{"type":"string","description":"The Stream/Websocket server address.","example":"wss://yourcompany.com/websocket-server"}}},"callHeader":{"type":"object","description":"Call Headers can be used to pass custom data from a Sinch SDK client to another, or specified in an ICE response to be made available to the receiving client. Further, if Call Headers is specified they will be available in ICE and DICE events.","properties":{"key":{"type":"string","description":"The call header key of the key value pair."},"value":{"type":"string","description":"The call header value of the key value pair."}}},"svaml.action.connectStream":{"type":"object","description":"Determines how to route a call to a Stream/websocket server. Available to use in a response to an [Incoming Call Event](https://developers.sinch.com/docs/voice/api-reference/voice/callbacks/ice) callback.","required":["name","destination"],"properties":{"name":{"type":"string","description":"The name property. Must have the value `connectStream`.","x-enumDescriptions":{"connectStream":"The `connectStream` action."},"enum":["connectStream"],"default":"connectStream"},"destination":{"$ref":"#/components/schemas/destinationWebSocket"},"streamingOptions":{"type":"object","description":"Optional parameters for the WebSocket stream.","properties":{"version":{"type":"integer","description":"The version of the streaming feature.","example":1},"sampleRate":{"type":"integer","description":"The sample rate for the audio stream in Hz.","example":44100}}},"maxDuration":{"type":"integer","description":"The max duration of the call in seconds (max 14400 seconds). If the call is still connected at that time, it will be automatically disconnected.","example":3600},"callHeaders":{"type":"array","description":"These custom parameters (headers/messages) are sent to your WebSocket server in the initial message when the ConnectStream is established.","items":{"$ref":"#/components/schemas/callHeader"}}}}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note:"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After the server response is received Sinch will start to send binary messages and expects to receive binary messages back, encoded with the same CODEC received."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"voice-api-websocket-connection-flow","__idx":2},"children":["Voice API Websocket connection flow"]},{"$$mdtype":"Tag","name":"Mermaid","attributes":{"data-language":"mermaid","diagramSource":"sequenceDiagram\n autonumber\n participant sinch as Sinch Platform\n participant wss as Customer Websocket Server\n \n sinch --) wss: WS Connection request\n wss --) sinch: WS Accepted\n sinch -) wss: WS text message (command:connect)\n wss -) sinch: WS text message (command:answer)\n note over sinch,wss: Audio exchange\n sinch -) wss: WS binary message : audio\n wss -) sinch: WS binary message : audio\n note over sinch,wss: Message exchange\n rect rgba(255, 241, 38, 1)\n note right of wss: Clear buffer (VAD / barge-in)\n end\n wss -) sinch: WS text message (command:clear)\n\n rect rgba(255, 241, 38, 1)\n note right of wss: Send to keep channel open.
ie: every 30 secs\n end\n wss -) sinch: WS text message (command:heartbeat)\n","diagramHtml":"
Sinch PlatformCustomer Websocket ServerAudio exchangeMessage exchangeClear buffer (VAD / barge-in)Send to keep channel open. ie: every 30 secsWS Connection request1WS Accepted2WS text message (command:connect)3WS text message (command:answer)4WS binary message : audio5WS binary message : audio6WS text message (command:clear)7WS text message (command:heartbeat)8Sinch PlatformCustomer Websocket Server
"},"children":["sequenceDiagram\n autonumber\n participant sinch as Sinch Platform\n participant wss as Customer Websocket Server\n \n sinch --) wss: WS Connection request\n wss --) sinch: WS Accepted\n sinch -) wss: WS text message (command:connect)\n wss -) sinch: WS text message (command:answer)\n note over sinch,wss: Audio exchange\n sinch -) wss: WS binary message : audio\n wss -) sinch: WS binary message : audio\n note over sinch,wss: Message exchange\n rect rgba(255, 241, 38, 1)\n note right of wss: Clear buffer (VAD / barge-in)\n end\n wss -) sinch: WS text message (command:clear)\n\n rect rgba(255, 241, 38, 1)\n note right of wss: Send to keep channel open.
ie: every 30 secs\n end\n wss -) sinch: WS text message (command:heartbeat)\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The websocket connection request does not contain any headers. The client is expected to either accept the connection (200 OK) or decline (non-successful HTTP response). If declined, the call is hung up."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the connection is accepted, the server immediately sends a connect command message, containing all the information."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The client is expected to send a command message back to indicate whether the call should be answered or hung up. If answered, the audio streams start."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This flow introduces an extra message with a payload that might be considered to be cleaner. Compared to the previous flow, the customer header names are preserved (not prepended with X-)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The websocket close message, sent from either side, indicates a hangup. This message can contain code and reason."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"connect-message","__idx":3},"children":["Connect message:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"Json","header":{"controls":{"copy":{}}},"source":"{\n \"command\": \"connect\",\n \"CallId\": \"...\",\n \"ApplicationId\": \"...\",\n \"Headers\": {\n \"Header1\": \"Value1\",\n \"ApplicationId\": \"dsfkjhgdfkjghsdfkjg\"\n }\n}\n","lang":"Json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"customer-message","__idx":4},"children":["Customer message:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"command\": \"answer\"\n}\n-or-\n{\n \"command\": \"busy\"\n}\n-or-\n{\n \"command\": \"reject\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note:"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Info about Close message and how audio is streamed if the Close message is sent."]}]},{"$$mdtype":"Tag","name":"Mermaid","attributes":{"data-language":"mermaid","diagramSource":"sequenceDiagram\n participant sinch as Sinch Platform\n participant wss as Customer Websocket Server\n \n sinch --) wss: WS Connection request\n alt\n wss --) sinch: WS Accepted (200 ok)\n else Decline\n wss --) sinch: WS Respponse (Any other code)\n rect rgba(255, 0, 0, 1)\n note right of wss: Stream ended\n end\n end\n sinch -) wss: WS text message (command:connect)\n rect rgba(0, 247, 16, 1)\n note right of wss: Contains callHeaders, callId, AppKey, etc.\n end\n alt\n wss -) sinch: WS text message (command:answer)\n else Send BUSY signal\n wss -) sinch: WS text message (command:busy)\n rect rgba(255, 0, 0, 1)\n note right of wss: Stream ended\n end\n else Reject the call\n wss -) sinch: WS text message (command:reject)\n rect rgba(255, 0, 0, 1)\n note right of wss: Stream ended\n end\n end\n note over sinch,wss: Audio exchange\n sinch -) wss: WS binary message : audio\n wss -) sinch: WS binary message : audio\n note over sinch,wss: Message exchange\n rect rgb(255, 241, 38)\n note right of wss: Clear buffer (VAD / barge-in)\n end\n wss -) sinch: WS text message (command:clear)\n rect rgb(255, 241, 38)\n note right of wss: Send to keep channel open.
If no audio is sent on the channel
ie: every 30 secs\n end\n wss -) sinch: WS text message (command:heartbeat)\n note over sinch,wss: Ending the call\n alt Customer ends call\n wss --) sinch: Websocket close()\n rect rgba(255, 0, 0, 1)\n note right of wss: Stream ended\n end\n else Sinch ends call\n wss --) sinch: Websocket close()\n rect rgba(255, 0, 0, 1)\n note right of wss: Stream ended\n end\n end\n","diagramHtml":"
Sinch PlatformCustomer Websocket ServerStream endedalt[Decline]Contains callHeaders, callId, AppKey, etc.Stream endedStream endedalt[Send BUSY signal][Reject the call]Audio exchangeMessage exchangeClear buffer (VAD / barge-in)Send to keep channel open. If no audio is sent on the channel ie: every 30 secsEnding the callStream endedStream endedalt[Customer ends call][Sinch ends call]WS Connection requestWS Accepted (200 ok)WS Respponse (Any other code)WS text message (command:connect)WS text message (command:answer)WS text message (command:busy)WS text message (command:reject)WS binary message : audioWS binary message : audioWS text message (command:clear)WS text message (command:heartbeat)Websocket close()Websocket close()Sinch PlatformCustomer Websocket Server
"},"children":["sequenceDiagram\n participant sinch as Sinch Platform\n participant wss as Customer Websocket Server\n \n sinch --) wss: WS Connection request\n alt\n wss --) sinch: WS Accepted (200 ok)\n else Decline\n wss --) sinch: WS Respponse (Any other code)\n rect rgba(255, 0, 0, 1)\n note right of wss: Stream ended\n end\n end\n sinch -) wss: WS text message (command:connect)\n rect rgba(0, 247, 16, 1)\n note right of wss: Contains callHeaders, callId, AppKey, etc.\n end\n alt\n wss -) sinch: WS text message (command:answer)\n else Send BUSY signal\n wss -) sinch: WS text message (command:busy)\n rect rgba(255, 0, 0, 1)\n note right of wss: Stream ended\n end\n else Reject the call\n wss -) sinch: WS text message (command:reject)\n rect rgba(255, 0, 0, 1)\n note right of wss: Stream ended\n end\n end\n note over sinch,wss: Audio exchange\n sinch -) wss: WS binary message : audio\n wss -) sinch: WS binary message : audio\n note over sinch,wss: Message exchange\n rect rgb(255, 241, 38)\n note right of wss: Clear buffer (VAD / barge-in)\n end\n wss -) sinch: WS text message (command:clear)\n rect rgb(255, 241, 38)\n note right of wss: Send to keep channel open.
If no audio is sent on the channel
ie: every 30 secs\n end\n wss -) sinch: WS text message (command:heartbeat)\n note over sinch,wss: Ending the call\n alt Customer ends call\n wss --) sinch: Websocket close()\n rect rgba(255, 0, 0, 1)\n note right of wss: Stream ended\n end\n else Sinch ends call\n wss --) sinch: Websocket close()\n rect rgba(255, 0, 0, 1)\n note right of wss: Stream ended\n end\n end\n"]}]},"headings":[{"value":"connectStream","id":"connectstream","depth":1},{"value":"Use cases","id":"use-cases","depth":2},{"value":"Voice API Websocket connection flow","id":"voice-api-websocket-connection-flow","depth":2},{"value":"Connect message:","id":"connect-message","depth":4},{"value":"Customer message:","id":"customer-message","depth":4}],"frontmatter":{"seo":{"title":"connectStream action","description":"Details about the connectStream SVAML action."}},"lastModified":"2025-12-11T00:46:56.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/voice/api-reference/svaml/streams","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}