transcripts

Get a call's transcript

The call's transcript: AI summary, action items and reference numbers, and with include=utterances the speaker turns. All text is redacted. In utterances every number (digits or spelled out) and keypad (DTMF) entry reads [redacted]. The summary, each action item and each reference number (label and value together) have every number read [redacted] when the item holds six or more digits in all, or a word such as code, OTP, PIN, password, card or account; otherwise short numbers such as dates, times and amounts stay. Needs transcripts:read and the account setting "Allow connected apps to read call summaries" (Settings → Connected apps, off by default); when it is off the answer is 403 not_enabled with settings_url. A call that is not yours is 404 call_not_found; a call without a transcript is 404 transcript_not_found (the message says whether one can be requested and its cost). Personal calls only. Every read is recorded in the account's audit log.

get/calls/{id}/transcript

Request

  • Base URL: https://api.voixcall.com/v1
  • URL: https://api.voixcall.com/v1/calls/{id}/transcript
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://api.voixcall.com/oauth/authorize, token URL https://api.voixcall.com/oauth/token, scopes: transcripts:read)
    • HTTP bearer

Path parameters

idstring required

Call id (call_ prefix).

Query parameters

include'utterances'

include=utterances adds the redacted speaker turns (REST only; assistants get the summary).

utterance_offsetinteger

With include=utterances: index of the first utterance to return; pass next_utterance_offset from the previous page.

Response

OK

action_itemsstring[] nullable required

Follow-ups from the call, redacted like summary.

call_idstring required
completed_atstring date-time nullable required
duration_secondsinteger nullable required

Length of the transcribed recording.

idstring required
languagestring nullable required

BCP 47 tag when detected.

livemodeboolean required
next_utterance_offsetinteger nullable required

Set when more utterances follow: the utterance_offset for the next page. null on the last page and without include=utterances.

object'transcript' required

Always "transcript".

status'pending' | 'processing' | 'completed' | 'failed' | 'expired' required

pending and processing: being made. completed: summary available. failed: transcription failed (it can be requested again once it has stopped retrying). expired: removed by the transcript retention period; the summary and utterances are gone. New values may appear.

summarystring nullable required

AI summary of the call, redacted: when it holds six or more digits in all, or a word such as code, OTP, PIN, password, card or account, every number in it reads [redacted]; keypad entries always do. null until completed, and once expired.

Changes

No recorded changes to this operation across all 1 revision of this API.