Skip to the content

Read a recording

GET /v1/recordings/{recording_id}

Property	Value
Operation	`get_recording`
Group	Recordings
Scope	`recordings:read`
Route class	`read`
Idempotency	No `Idempotency-Key`
Audit	Not audited: A metadata read; the recording row carries no audio.
Released in	1.15.0
Phase 0 host	Served (the hosted api pins 1.65.0)

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the recordings:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/recordings/rec_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/recordings/rec_...`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/recordings/rec_...",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Parameters

Name	In	Type	Required	Description
`recording_id`	path	RecordingId	yes	The id of a Call recording: `rec_` and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.

Responses

Status	Content type	Shape	Error codes
`200`	`application/json`	Recording
`400`	`application/json`	ErrorEnvelope	`invalid_request`
`401`	`application/json`	ErrorEnvelope	`unauthenticated`
`403`	`application/json`	ErrorEnvelope	`forbidden`
`404`	`application/json`	ErrorEnvelope	`not_found`
`429`	`application/json`	ErrorEnvelope	`rate_limited`
`500`	`application/json`	ErrorEnvelope	`internal_error`

Fields of the `200` answer

The shape is Recording.

Field	Type	Required	Description
`call_id`	CallId	yes
`created_at`	Timestamp	yes
`duration_ms`	integer or null	yes	The length of the audio; null until the audio is uploaded.
`format`	RecordingFormat or null	yes	Null until the audio is uploaded.
`id`	RecordingId	yes
`key_version`	integer	yes	The version of the key that wraps the per-Call key; safe to log.
`object`	`"recording"`	yes
`ring_ms`	integer or null	no	The length in milliseconds of the ring tone the audio begins with (1.42.0, board #136): the ring-to-answer period of an inbound phone Call, the Call's `ring_ms`, so the Agent answered at this offset into the audio and a player marks the answer instant there. 0 to 60,000. Null when the audio begins at the answer, as for a web Call or a recording whose worker wrote no tone; absent from an api older than 1.42.0, which a reader treats as null.
`size_bytes`	integer or null	yes	The size of the stored object, ciphertext included; null until uploaded.
`status`	RecordingStatus	yes
`updated_at`	Timestamp	yes