Skip to navigation
Compatibility REST APIRecordings

Update a Recording

View as MarkdownOpen in Claude

Pauses, resumes, or stops a recording on an active call. When pausing, choose whether the elapsed interval becomes silence in the media or is skipped. This controls an in-progress recording; account-level Recordings operations retrieve or delete saved media.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.

Learn more about API scopes.

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

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

This endpoint expects an object.
StatusenumRequired
The status of the recording.
Allowed values:
PauseBehaviorenumOptionalDefaults to silence

What to do while recording is paused. Default is silence.

Allowed values:

Response

The request has succeeded.
sidstringformat: "uuid"
The unique identifier for the recording.
account_sidstringformat: "uuid"
The unique identifier for the account that is associated with this recording.
api_versionstring
The version of the SignalWire API.
call_sidstring or nullformat: "uuid"
The unique identifier for the call that is associated with this recording. Null if this is a conference recording.
conference_sidstring or nullformat: "uuid"
The unique identifier for the conference that is associated with this recording. Null if this is a call recording.
channelenum

The number of channels in a recording (singular key). Returns ‘1’ for mono or ‘2’ for stereo.

Allowed values:
channelsenum
The number of channels in a recording. Returns '1' for mono or '2' for stereo.
Allowed values:
date_createdstring
The date, in RFC 2822 format, this recording was created.
date_updatedstring
The date, in RFC 2822 format, this recording was updated.
start_timestring or null
The time, in RFC 2822 format, this recording started.
end_timestring or null
The time, in RFC 2822 format, this recording ended.
durationinteger
The length, in seconds, of the recording.
pricedouble
The cost of the recording.
price_unitstring
The currency of the price of the recording.
sourceenum or null

How the recording was started. A call recording is never Conference. Null for a recording made because the call was created through the REST API with Record set to true.

Allowed values:
statusenum
The status of the recording.
error_codestring or null
Further details about a failed recording.
uristring
The URI of the recording.
subresource_urisobject
Subresource URIs.
encryption_detailsstring or null
Encryption details. Always null.
trimstring or null

Whether leading and trailing silence is trimmed from a recording: trim-silence or do-not-trim. Can be null.

Errors

400
Bad Request Error
404
Not Found Error
422
Unprocessable Entity Error
503
Service Unavailable Error