outboundStream

Channel

outboundStream

Messages

Accepts one of the following messages:

Payload

commandstringrequired

Connect message

Example:"connect"

Value:"connect"

versionintegerrequired

Protocol version

Example:1

Value:1

callIdstring^[0-9A-HJKMNP-TV-Z]{26}$required

Unique Call ID

Example:"01KHKF468K4P1T3CZ4XJ1NYVN3"

serviceIdstring, (uuid)required

Service Unique ID

Example:"5c90f98a-5002-4f8a-9b02-c1cb552bed95"

sttLanguagestringrequired

BCP-47 language tag used for speech-to-text transcription of the inbound audio.

This is the language set in the SVAML command when the voice relay session was initiated.

Example:"en-US"

ttsVoicestringrequired

Name of the default voice that will be used when synthesizing speech.

This is the TTS voice name set in the SVAML command when the voice relay session was initiated.

Example:"Joanna"

interruptionsEnabledbooleanrequired

Indicates if automatic interruption on detected speech is enabled for this session.

Example:true

callHeadersobjectrequired

Arbitrary key/value pairs (header name -> header value).

Example:

{
  "key1": "value1",
  "key2": "value2"
}

Payload

{
  "command": "connect",
  "version": 1,
  "callId": "01KHKF468K4P1T3CZ4XJ1NYVN3",
  "serviceId": "5c90f98a-5002-4f8a-9b02-c1cb552bed95",
  "sttLanguage": "en-US",
  "ttsVoice": "Joanna",
  "interruptionsEnabled": true,
  "callHeaders": {
    "key1": "value1",
    "key2": "value2"
  }
}

Send

Connection initiated from the Sinch Platform

This is the first message sent from the Sinch platform for all outgoing stream connections. This message carries information about the call, including call headers, the Call-ID, Service-ID, etc. Based on the information that this command carries, the customer can make a decision if the request should be accepted or not.

Messages

ConnectRequest

We'd love to hear from you!