Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Use a server-side Brightalk API key in the Authorization header.

Headers

Brightalk-Version
string
default:2026-07-16

Selects the date-based API version. Omission uses the organization’s pinned default.

Allowed value: "2026-07-16"
X-Request-Id
string

A caller-generated correlation value matching [A-Za-z0-9._:-]{1,64}. Invalid values are replaced.

Maximum string length: 64
Pattern: ^[A-Za-z0-9._:-]{1,64}$

Path Parameters

recording_id
string<uuid>
required

The opaque Recording identifier. An opaque resource identifier.

Required string length: 1 - 255
Example:

"22222222-2222-5222-9222-222222222222"

Query Parameters

expires_in
integer
default:900

TTL override in seconds for the signed download URL. Defaults to 900 and must be between 60 and 3600. On the list operation this is only meaningful together with include=download_url; supplying it without include=download_url returns 400 validation_error rather than being silently ignored. It is always meaningful on the single-recording get.

Required range: 60 <= x <= 3600

Response

Recording returned.

A Recording as returned by the single-recording get, where download_url and download_url_expires_at are guaranteed rather than conditional on include=download_url. Composed rather than duplicated so the two operations cannot drift apart on the other seven fields.

object
string
required
Allowed value: "recording"
Example:

"recording"

id
string<uuid>
required

An opaque resource identifier, derived from the source row. Stable for the same call recording.

Required string length: 1 - 255
Example:

"22222222-2222-5222-9222-222222222222"

call_id
string<uuid> | null
required

The Call resource id this recording belongs to. Null when the call was not created through the Public API (dashboard, non-API Automation, or manual dial).

Required string length: 1 - 255
Example:

"11111111-1111-4111-8111-111111111111"

contact_id
string | null
required

An opaque resource identifier. Null when no contact is linked to this recording.

Required string length: 1 - 255
Example:

"con_demo_001"

recorded_at
string<date-time>
required

When the call occurred. The sort key for pagination.

Example:

"2026-07-20T01:00:00Z"

duration_seconds
integer | null
required
Required range: x >= 0
Example:

92

media_type
string
required
Allowed value: "audio/mpeg"
Example:

"audio/mpeg"

download_url
string<uri>
required

A freshly minted, short-lived signed URL for the recording's MP3 bytes. Present when requested with include=download_url on the list operation, and always present on the single-recording get. Treat it as opaque; do not construct, parse, or cache it past its expiry.

Maximum string length: 2048
download_url_expires_at
string<date-time>
required

When download_url expires. Absent whenever download_url is absent.

Example:

"2026-07-20T01:15:00Z"