REST Client MethodsRecordings

Update

View as Markdown

Use this endpoint for the Recordings method to pause, resume or stop a Recording. You can control what happens while recording is paused (replace pause with silence or skip it).

Path parameters

AccountSidstringRequiredformat: "uuid"
The Project ID that uniquely identifies the Account.
CallSidstringRequiredformat: "uuid"
The unique identifier for the call.
SidstringRequiredformat: "uuid"
The unique identifier for the call.

Request

StatusenumRequired
The status of the recording.
Allowed values:
PauseBehaviorenumOptionalDefaults to silence
What to do while recording is paused. Default is `silence`.
Allowed values:

Response

sidstringRequiredformat: "uuid"
The unique identifier for the recording.
account_sidstringRequiredformat: "uuid"
The unique identifier for the account that is associated with this recording.
api_versionstringRequired
The version of the SignalWire API.
call_sidstring or nullRequiredformat: "uuid"
The unique identifier for the call that is associated with this recording. Null if this is a conference recording.
conference_sidstring or nullRequiredformat: "uuid"
The unique identifier for the conference that is associated with this recording. Null if this is a call recording.
channelenumRequired
The number of channels in a recording (singular key). Returns '1' for mono or '2' for stereo.
Allowed values:
channelsenumRequired
The number of channels in a recording. Returns '1' for mono or '2' for stereo.
Allowed values:
date_createdstringRequired
The date, in RFC 2822 format, this recording was created.
date_updatedstringRequired
The date, in RFC 2822 format, this recording was updated.
start_timestring or nullRequired
The time, in RFC 2822 format, this recording started.
end_timestring or nullRequired
The time, in RFC 2822 format, this recording ended.
durationintegerRequired
The length, in seconds, of the recording.
pricestring or nullRequired
The cost for the recording.
price_unitstringRequired
The currency of the price of the recording.
sourceenumRequired
How the recording was made.
statusenumRequired
The status of the recording.
error_codestring or nullRequired
Further details about a failed recording.
uristringRequired
The URI of the recording.
subresource_urisobjectRequired
Subresource URIs.
encryption_detailsstring or nullRequired
Encryption details. Always null.
trimstringRequired
Whether leading and trailing silence is trimmed from a recording.