transcripts

Request a call transcript

Asks for a transcript and summary of a recorded call that has none, through the same pipeline as the app's "Transcribe this call" button. It costs money: cost in the response is the transcription rate per started minute of recording, charged when the transcript completes (never on failure). Needs transcripts:read and calls:place, the account setting "Allow connected apps to read call summaries" (else 403 not_enabled) and an Idempotency-Key header. 402 insufficient_credits when the balance cannot cover it, 402 call_too_short for a recording too short to transcribe, 409 transcript_exists when the call already has one, 409 transcription_in_progress while another requested transcript is being made, 409 recording_unavailable when the call has no saved recording. Poll GET /v1/calls/{id}/transcript for the result.

post/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, calls:place)
    • HTTP bearer

Path parameters

idstring required

Call id (call_ prefix).

Headers

Idempotency-Keystring required

Required. A UUID v4 you generate; retrying with the same key and request replays the first response instead of requesting twice.

Response

Accepted

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
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.