Skip to content
Channel

customer/defined

name: customer/defined

Messages

Accepts one of the following messages:

Payload

commandstringrequired

Connect message

Example:"connect"
Value:"connect"
versionintegerrequired

Protocol version

Example:1
Value:1
callIdstringrequired

Call unique identifier

Example:"7856b65f-e3b5-4b25-8825-77ee10b57602"
applicationKeystringrequired

Service unique identifier

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

Audio codec used for encoding binary audio frames transmitted over the WebSocket connection. Audio frames are 16-bit signed linear PCM, mono (single channel), with little-endian byte order.

Example:"PCM"
Value:"PCM"
sampleRateintegerrequired

Audio sample rate in Hertz (Hz). The value is negotiated at call setup via the SVAML connectStream command. Higher sample rates provide better audio quality but increase bandwidth and processing requirements.

  • 8000 Hz: Narrowband telephony quality (standard PSTN)
  • 16000 Hz: Wideband quality, suitable for most voice applications
  • 24000 Hz: High-quality voice
  • 44100 Hz: CD-quality audio
  • 48000 Hz: Professional audio standard
  • 96000 Hz: Ultra high-quality audio

For calls traversing the PSTN, audio is typically sampled at 8 kHz; using a higher value will not improve perceived quality.

Enum ValueDescription
8000

8 kHz (standard for PSTN calls)

16000

16 kHz (wideband audio)

24000

24 kHz (super-wideband audio)

44100

44.1 kHz (CD quality audio)

48000

48 kHz (professional audio quality)

96000

96 kHz (high-resolution audio)

Example:8000
callHeadersobjectrequired

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

Example:
{ "key1": "value1", "key2": "value2" }
Payload
{ "command": "connect", "version": 1, "callId": "7856b65f-e3b5-4b25-8825-77ee10b57602", "applicationKey": "5c90f98a-5002-4f8a-9b02-c1cb552bed95", "codec": "PCM", "sampleRate": 8000, "callHeaders": { "key1": "value1", "key2": "value2" } }

Send

Send
Connection initiated from the Sinch Platform

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, Application-ID, etc. Based on the information that this command carries, the customer can make a decision if the request should be accepted or not.

We'd love to hear from you!
Rate this content: