Compatibility REST APIRecordings

Create a Recording

View as Markdown

Create a recording.

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.

Request

This endpoint expects an object.
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 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

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.
pricestring or null
The cost for the recording.
price_unitstring
The currency of the price of the recording.
sourceenum
How the recording was made.
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
Whether leading and trailing silence is trimmed from a recording.

Errors