Skip to main content
POST
Live call control

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access.

Path Parameters

id
string<uuid>
required

Active call ID.

Body

application/json
action
enum<string>
required
Available options:
listen_token,
whisper,
end_agent,
hangup
text
string

Required when action is whisper.

speak
boolean

When whispering, have the agent speak immediately.

reason
string

Optional reason for end_agent or hangup.

barge
boolean

For listen_token: join with publish (audible) instead of hidden listen-only.

Response

Action result. listen_token returns join credentials; other actions return { ok: true }.

data
object
required