Live call control
Supervisor actions on an active call: listen_token (join credentials), whisper (coach the agent), end_agent (mute AI / take-over), or hangup (end the call for everyone via room delete). Requires plan feature live_monitoring. Required scope: calls:write.
Authorizations
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
Active call ID.
Body
listen_token, whisper, end_agent, hangup Required when action is whisper.
When whispering, have the agent speak immediately.
Optional reason for end_agent or hangup.
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 }.
- Option 1
- Option 2