Get a recording's transcript

get

https://api.emaktalk.com/api/v2/call_records/{id}/recordings/{recording_id}/transcript

Returns one recording's transcript, whole: what was said, turn by turn, with its speaker table. For a call with several recordings, GET …/transcript returns them all.

Use it:

Read the recording's transcript summary on the record; fetch when its state is done.
Send format=text for plain text (see format); the default is JSON.
Cache by ETag: send it back as If-None-Match, and a transcript you already hold answers 304.

Response: { data }. A transcript that is not done comes with its state, no speakers and no turns.

Notes:

The text form is sent only when the transcript is done; otherwise the answer is JSON, so check Content-Type.
The ETag (weak) is present once the transcript is done; in JSON it equals the recording's transcript.etag on the record.
Needs access to the call's content (403 content_forbidden otherwise).
HEAD answers the same status and headers with no body.

Logged: each GET that hands over a done transcript is recorded in the call's access log as transcript_read, unless the reader was a participant on the call (an API key never is). A 304 and a HEAD are never recorded.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

The call record's id (a record's id).

recording_id

uuid

required

The recording's id: the id of one of the record's recordings.

Query Params

format

string

enum

Defaults to json

json (the default): { data }. text: plain text, one [m:ss] Speaker: text line per turn ([h:mm:ss] from an hour on, [?] when a turn's time is not known), times from the start of the recording. A speaker is written as its extension (Extension 101), an AI agent by name, the outside party by name or number (else Caller or Called party), else Agent or Speaker 1. Sent only when at least one transcript exists and every transcript that exists is done; otherwise the answer is JSON. Given once.

Allowed:

account_id

uuid

The one account to read, by its id (account.id). Only a caller that may choose the account (EMAK support) sends it, and must; everyone else reads the account they belong to. Absent for a caller that must name it: 400 parameter_missing. Empty or not an account id: 400 parameter_invalid. Given twice: 400 parameter_invalid for any caller. Sent by a caller that reads its own account: 403 forbidden. An account that does not exist or is disabled: 404 reference_not_found. Each names account_id in param. The account is named this way only: a request that sends the legacy account header X-Tenant-Domain-Uuid is refused (400 parameter_unknown).

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

*/*

200The transcript, whole: { data } in JSON, or plain text with format=text once it is done.

304Your copy is current: the If-None-Match you sent names this answer's tag (for the same format). No body; nothing was read or recorded in the access log.

400 parameter_invalid: the id or recording_id is not a UUID, or format is not json or text, or is given twice. parameter_unknown: a parameter this endpoint does not take. parameter_missing: account_id is absent for a caller that must name the account.

403 forbidden: the caller may not read this account's call history, or sent account_id without being allowed to choose an account. content_forbidden: the caller may see this call's details but not read its transcripts.

404 call_record_not_found: no call with this id is readable on your account. recording_not_found: the call has no recording with this id, or it was deleted while its transcript was being read. reference_not_found: the account named by account_id does not exist or is disabled.

405This path doesn't answer this method (method_not_allowed); the Allow header lists the ones it does: GET, HEAD on the reads; GET, HEAD, DELETE on a recording; POST on undelete and batch_delete.

429Too many requests (rate_limited). Wait retry_after_sec seconds (the Retry-After header), then retry the same request.

500Something failed on our side (internal), and nothing was handed over. Quote request_id when you report it.

503A temporary condition (try_again): the service is briefly busy, or the call's content changed while it was being read, so nothing was handed over. Wait retry_after_sec seconds (the Retry-After header), then retry.