Recordings

A Recording instance resource represents an audio file created by FreeClimb during a Call or Conference.

The Recording resource is a subresource of a Call resource and Conference resource. This enables navigating directly from a Call or Conference to the Recordings generated from them. Recordings are owned by an account and are stored for the account holder on FreeClimb until deleted.

There are two ways to begin a Recording:

When creating a Conference, set the record property to true. When the Conference ends, the request message to the statusCallbackUrl returns the recordingId other Recording resource properties.
Initiate a Recording at any time during a Call or Conference using the StartRecordCall or RecordUtterance PerCL commands.

Resource properties

Property	Type	Description
accountId	string	ID of the account that created this recording.
callId	string	ID of the Call that was recorded. If a Conference was recorded, this value is empty and the `conferenceId` property is populated.
conferenceId	string	ID of the Conference that was recorded. If a Call was recorded, this value is empty and the `callId` property is populated.
dateCreated	string	Date that this resource was created (GMT), in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT).
dateUpdated	string	Date that this resource was last updated (GMT), in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT).
dateCreatedISO	string date-time	Date that this resource was created (UTC) in RFC3339 format (e.g., 2024-10-09T15:05:03.358Z).
dateUpdatedISO	string date-time	Date that this resource was last updated (UTC) in RFC3339 format (e.g., 2024-10-09T15:05:03.358Z).
durationSec	string	Length of the recording in seconds.
recordingId	string	String that uniquely identifies this recording resource.
revision	string	Revision count for the resource. Set to `1` on creation and is incremented at every update.
deleted	boolean	If the recording file has been deleted from the platform. Only the Recording Metadata is persisted on the platform once this is true.
type	string	enum ["private","protected"]
mimeType	string	The Mime Type of the recording. "audio/wav" is the most common.
downloadUrl	string	URI to download this resource, relative to API base URL.
uri	string	URI for this resource, relative to API base URL.