Skip to main content
POST

Authorizations

Authorization
string
header
required

Your workspace secret key, sk_live_ followed by 32 hex characters. Create one in the console under Developers.

Headers

Idempotency-Key
string

Up to 255 characters. The same key within 24 hours replays the first answer and creates nothing new. Build it from your own record, such as order-8842-reminder-1.

Maximum string length: 255

Path Parameters

call_id
string
required

The call's id (call_…), from the 202 that created it.

Body

application/json
after_human
string
ai
string
connect
object
instruction
string
metadata
object
mode
string
ttl_secs
integer
verify
string

Response

Armed: dial connect.dial now

A live human takeover of a call in progress (a phone call, or a web call rung out to the person).

after_human
enum<string>
required
Available options:
end_call
ai
enum<string>
required
Available options:
paused
call_id
string
required
connect
object
required
created_at
string<date-time>
required
id
string
required
Pattern: ^hof_
initiator
enum<string>
required

api: POST /v2/calls/{id}/handoffs. agent: the agent's transfer_call tool.

Available options:
api,
agent
mode
enum<string>
required
Available options:
talk
object
enum<string>
required
Available options:
handoff
state
enum<string>
required
Available options:
armed,
connecting,
active,
ended
duration_secs
integer
Required range: x >= 0
ended_at
string<date-time>
ended_by
enum<string>
Available options:
human,
caller,
api,
system
expires_at
string<date-time>
joined_at
string<date-time>
metadata
object
outcome
enum<string>
Available options:
completed,
failed,
cancelled,
expired
reason
enum<string>
Available options:
expired,
caller_left,
join_failed,
cancelled,
human_hung_up,
caller_hung_up,
ended_by_api,
max_duration,
call_ended,
worker_unsupported,
no_answer,
dial_failed