stream

Start streaming audio from an active call to a WebSocket endpoint. This is commonly used for real-time speech processing, analytics, or archival. Returns a control_id for stopping the stream.

Request

idstringRequiredformat: "uuid"

The unique identifying ID of an existing call.

paramsobjectRequired

An object of parameters that will be utilized by the active command.

Response

Call LegobjectRequired

Returned when the call is a standard PSTN, SIP, or WebRTC call.

Fabric Subscriber Device LegobjectRequired

Returned when the call is a Fabric subscriber device leg. The status field is always null for this type.

Example

1 from signalwire.rest import RestClient
2 
3 client = RestClient(
4     project="your-project-id",
5     token="your-api-token",
6     host="your-space.signalwire.com",
7 )
8 
9 result = client.calling.stream(
10     call_id="call-id-xxx",
11     url="wss://example.com/audio-stream",
12 )
13 control_id = result.get("control_id")