Skip to main content
GET
Get Call

Authorizations

Authorization
string
header
required

Your API key (ta_live_…) from Settings → API keys, sent as Authorization: Bearer <key>. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with 403.

Headers

Thinnest-Workspace
string

Developers only: the customer workspace this request acts in — its org_… id from POST /customers. Leave it out to act in your own workspace.

Example:

"org_3fKq9TzQ1mN8vB2xR7cLpA"

Path Parameters

id
string
required

The call's id as Place Call or List Calls gave it: out_… or sch_… for a call you placed, the call reference for any other.

Example:

"out_9f2c1a44-6b0e-4c1d-8a7f-2e5b3c9d1f60"

Response

The call.

One call and what it learned — the same object call.analysed delivers.

id
string
required

The id to open it by: out_… / sch_… for a call you placed, the call reference otherwise.

callRef
string | null
required

The reference of the attempt that actually rang. Null on a call that has not rung.

reference
string | null
required

Your reference from Place Call.

metadata
object | null
required

Your metadata from Place Call, untouched.

attempt
integer
required

1 for the first try, 2 for the first retry.

Required range: x >= 1
status
enum<string>
required

Where the call is. scheduled and cancelled only appear on calls you placed for later.

Available options:
scheduled,
ringing,
connected,
completed,
missed,
failed,
cancelled
direction
enum<string>
required

Who rang whom.

Available options:
inbound,
outbound
phone
string | null
required

The customer's number.

from
string | null
required

Your number the call rang from. Null until it rings, unless the request chose one.

agent
object | null
required

The agent on the call.

scheduledFor
string<date-time> | null
required

When a booked call will ring. Null once it has.

startedAt
string<date-time> | null
required

When it started ringing.

answeredAt
string<date-time> | null
required

When it was picked up.

endedAt
string<date-time> | null
required

When it ended.

seconds
integer
required

How long it lasted.

Required range: x >= 0
hangup
enum<string> | null
required

Why it ended. Null while live; not_placed for a booked call that never rang.

Available options:
answered,
no_answer,
busy,
rejected,
unreachable,
cancelled,
voicemail,
before_agent,
failed,
not_placed,
null
variables
object
required

The {{name}} values the call used.

summary
string | null
required

Two or three sentences about the call, when summarised.

fields
object
required

The collected details, keyed by field name. Empty when nothing was said.

analysedAt
string<date-time> | null
required

When the summary and fields were written. Null means they may still arrive.

error
string | null
required

Why a booked call could not be placed, in words. Null otherwise.

transcript
object[]
required

This call's spoken turns, oldest first.

recording
object | null
required

A signed link to the audio that needs no key — Get Recording By Signed Link. Null when the call was not recorded.

retryScheduledFor
string<date-time> | null
required

When the next try will ring, if this one did not reach them and another is queued.