Skip to main content
POST
/
v1
/
calls
/
{uuid}
/
streams
Start call streaming
curl --request POST \
  --url https://api.wavix.com/v1/calls/{uuid}/streams \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "stream_url": "wss://examples.com/stream",
  "stream_type": "twoway",
  "stream_channel": "inbound"
}
'
{
  "success": true,
  "stream_id": "123e4567-e89b-12d3-a456-426614174000"
}

Authorizations

​
Authorization
string
header
required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Path Parameters

​
uuid
string<uuid>
required

Call ID.

Body

application/json

Streaming configuration.

​
stream_url
string<uri>
required

WebSocket URL for call streaming

Example:

"wss://examples.com/stream"

​
stream_type
enum<string>
required

Specifies the streaming type. Can be either oneway for unidirectional or twoway for bidirectional streaming.

Available options:
oneway,
twoway
Example:

"twoway"

​
stream_channel
enum<string>
required

Specifies which audio channel to stream. Use inbound to stream the incoming channel (to Wavix), outbound for the outbound channel (from Wavix), or both to stream both. For bidirectional call streaming, this setting is ignored and the inbound channel is only streamed.

Available options:
inbound,
outbound,
both
Example:

"inbound"

Response

Streaming started.

​
success
boolean

Indicates that the request was successful

Example:

true

​
stream_id
string<uuid>

Stream ID

Example:

"123e4567-e89b-12d3-a456-426614174000"