record

Start recording an active call. Pass a control_id to name the recording so you can pause, resume, or stop it later. The response never carries control_id back — omit it and you have no way to control this recording afterward.

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

from signalwire.rest import RestClient
client = RestClient(
    project="your-project-id",
    token="your-api-token",
    host="your-space.signalwire.com",
)
client.calling.record(
    call_id="call-id-xxx",
    control_id="record-1",
    audio={"format": "mp3", "stereo": True}
)