Sign inGet Started
Rozpocznij
Przewodniki
Referencja API
SDK
CLI
Baza wiedzy
Changelog

List a call's recordings and transcripts

GET
/v1/voice/calls/{call_id}/recordings
const inventory = await bird.voice.calls.recordings.list("vcs_01krdgeqcxet5s7t44vh8rt9mg");
for (const recording of inventory.recordings) {
  console.log(recording.leg_id, recording.id);
}
Odpowiedź200
{
  "media": [
    {
      "id": "vcm_01krdgeqcxet5s7t44vh8rt9mg",
      "leg_id": "vcl_01krdgeqcxet5s7t44vh8rt9mg",
      "call_id": "vcs_01krdgeqcxet5s7t44vh8rt9mg",
      "codec": "PCMU",
      "state": "available",
      "offset_ms": 0,
      "audio_ms": 1000,
      "started_at": "2026-11-01T12:00:00Z",
      "ended_at": "2026-11-01T12:00:01Z",
      "source_party": {
        "endpoint": {
          "type": "pstn"
        },
        "address": "+14155551234"
      }
    }
  ],
  "recordings": [
    {
      "id": "vrc_01krdgeqcxet5s7t44vh8rt9mg",
      "leg_id": "vcl_01krdgeqcxet5s7t44vh8rt9mg",
      "call_id": "vcs_01krdgeqcxet5s7t44vh8rt9mg",
      "number": "+12025550100",
      "channel": "rx",
      "media_id": "vcm_01krdgeqcxet5s7t44vh8rt9mg",
      "media_started_at": "2026-11-01T12:00:00Z",
      "started_at": "2026-11-01T12:00:00Z",
      "ended_at": "2026-11-01T12:00:01Z"
    }
  ],
  "transcripts": [],
  "truncated": false,
  "evaluated_at": "2026-11-01T12:01:00Z"
}

Returns everything captured across every leg of one call: its stored audio, each leg's view of it, and every transcription attempt over it. A stream heard on several legs appears once in media, with one view per leg in recordings.

Audio streams, their recording views and transcripts leave the API 30 days after the source audio starts. Transcription does not restart that period. Read truncated before presenting the result as complete.

The collections arrive independently. A stream can appear before its recording view, or without a view if delivery fails or the view expires. Download audio with getVoiceLegRecordingAudio, passing the recording view's leg_id and id. The download requires a recording view ID, so a stream cannot be downloaded until its view is available.

A call this workspace never placed, or whose recordings have all expired, answers with empty collections rather than 404.

Parametry

call_idstring

The call to read. Every leg carries its call's ID as call_id.

Treść odpowiedzi

media
array of object
wymagane

The stored audio this read covers, each stream once.

Pokaż atrybuty podrzędne
recordings
array of object
wymagane

Each leg's view of that audio.

Pokaż atrybuty podrzędne
transcripts
array of object
wymagane

Every transcription attempt over that audio, including failed ones.

Pokaż atrybuty podrzędne
transcripts.id
string
wymagane

Unique identifier for this attempt.

transcripts.leg_id
string
wymagane

The leg the transcribed stream was captured from.

transcripts.call_id
nullable string

null on a transcript of a stream captured before calls existed.

transcripts.media_id
string
wymagane

The stream this attempt describes.

transcripts.media_started_at
string
wymagane

When that stream started. A transcript is retained with the stream it describes rather than on its own transcription lag.

transcripts.state
string
wymagane

Whether the attempt produced a transcript. failed is an outcome, not evidence that a later attempt cannot succeed.

Possible values: available, failed

transcripts.source
string
wymagane

What the times in cues are worth: whole for a pass that times nothing, aligned for offline forced alignment, live for a streaming producer.

Possible values (may grow over time): whole, aligned, live

transcripts.model
string

The model that produced it.

transcripts.channel
string
wymagane

The direction of the transcribed stream.

Possible values: rx, tx

transcripts.cues
array of object
wymagane

The transcript, in order. Concatenating cues across streams reads as prose nobody spoke, and a reader matching over it can match the wrong party's words.

Pokaż atrybuty podrzędne
transcripts.source_party
nullable object

The party this audio was captured from, which is what says whose voice it carries. channel only says which direction of the leg the stream came from. A recording view's number identifies a number associated with that view, which can be an outbound destination.

null on a stream stored before the platform recorded a party for it.

Pokaż atrybuty podrzędne
transcripts.created_at
string
wymagane
truncated
boolean
wymagane

Whether a collection above was cut at this read's per-collection limit of 500. When true, there is more than is shown here and this response is not the whole set.

false means no collection hit that limit, and a collection that could not be read in full fails the request rather than returning a short answer. What false does not establish is that every recording made has arrived: delivery into this store is asynchronous, so a recording made moments ago can be absent from a complete read.

evaluated_at
string
wymagane

The instant each collection's retention was decided at. Nothing here stays true because you are still holding the response. A recording can expire after it.

Powiązane zasoby

Przejdź do dokumentacji, przewodników i przykładów dotyczących tego tematu.

Uzyskaj brief wdrożeniowy