REST Client MethodsRecordings

Create

View as Markdown

Use this endpoint for the Recordings method to initiate a Recording for a Call. You can use this endpoint to start recording a Call that is already in progress. If you want to record the entire Call, you can specify recording params during creation of the Call.

Path parameters

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

Request

RecordingChannelsenumOptionalDefaults to mono
The number of channels in the recording. Can be `mono` (both legs of call recorded under one channel into one recording file) or `dual` (each leg of call recorded in separate channels into one recording file). Default is `mono`.
Allowed values:
RecordingStatusCallbackstringOptionalformat: "uri"
The URL to request to when recording is available. See the [Recording status callback](/docs/compatibility-api/rest/recordings/webhooks/recording-status-callback) webhook for the payload your URL will receive.
RecordingStatusCallbackEventstringOptionalDefaults to completed
The different recording statuses. To specify multiple events, separate with a space. Valid values: completed, in-progress, absent. Default is `completed`.
RecordingStatusCallbackMethodenumOptionalDefaults to POST
Whether the request to `RecordingStatusCallback` URL is a `GET` or a `POST`. Default is `POST`.
Allowed values:
RecordingTrackenumOptionalDefaults to both
Specifies whether to record the `inbound` audio to SignalWire from the called party or the `outbound` audio from SignalWire to the called party or `both` the inbound and outbound audio. Default is `both`.
Allowed values:
TrimenumOptionalDefaults to do-not-trim
Whether leading and trailing silence is trimmed from a recording. Default is `do-not-trim`.
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.