Get a call record

get

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

Returns one call record, complete: its facts, its recordings (each with a transcript summary), its analyses in brief and its journey (the journey only for admins, the reporting role and API keys).

Use it:

Request it without include for the default parts listed above.
Name parts with include for exactly those parts, in full: journey, recordings, transcript, analyses, access_log.
Play audio from each recording's media_url; audio is never embedded.

Response: { data }. Parts you did not name come as the list row carries them: recordings without their transcript summaries, analyses in brief.

Notes:

The transcript text comes only with include=transcript, as transcripts.
A part you may not see is refused (403 forbidden, param: include), never silently dropped.
HEAD answers the same status and headers with no body.

Logged: with include=transcript, each done transcript handed over 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), exactly like the transcript endpoint. Nothing else is recorded, and HEAD never is.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

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

Query Params

include

array of strings

Comma-separated or repeated. Absent: the record with its recordings (each with its transcript summary), its analyses in brief and its journey (the journey only for admins, the reporting role and API keys); never the transcript text or the access log. Present: exactly the parts named, in full, and the others as the list row carries them. journey (admins, the reporting role and API keys); recordings (each with its transcript summary; without recordings, recordings come without it); transcript (every recording's transcript, in transcripts; recorded in the access log like any transcript read); analyses (each kind's full analysis); access_log (the account's admins and API keys). A part you may not see answers 403 forbidden.

include

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

Responses

Language

Credentials

Bearer

Loading…

Response

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

application/json

200The call record: { data }.

400 parameter_invalid: the id is not a UUID, or include is empty or names a part this endpoint does not serve (details.allowed lists the parts it serves). parameter_unknown: a parameter this endpoint does not take. parameter_missing: account_id is absent for a caller that must name the account.

404 call_record_not_found: no call with this id is readable on your account. recording_not_found: with include=transcript, a recording was deleted while its transcript was being read. Read the record again. 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.