Hang up a call
Ends a live call by hanging up its carrier leg. The final status is taken from the carrier: completed if the call was answered, canceled if it was still ringing, or the carrier’s own terminal status (and duration) if it had already ended. A call that never reached the carrier is closed as canceled.
Side effects. Hangs up the carrier leg, releases the workspace’s concurrency slot, closes the row (a concurrent post-call webhook that closes it first wins, keeping its richer data), invalidates the call caches and notifies the dashboard in real time. Transcript, analysis and billed minutes follow through the normal post-call pipeline. Writes an audit entry.
Idempotency. Idempotent: a call already in a terminal state (completed, failed, no-answer, busy, canceled) returns 200 with no side effects, so double clicks and retries are safe.
Webhook events. The call gets its one terminal event, call.completed or call.failed, as for any call that ends. See Webhooks.
Access
- Required scope:
write. - Rate limit: General API — 120 (Starter), 200 (Growth), 300 (Business) or 600 (Enterprise) requests/min per workspace. The 20/min outbound limit does not apply to this route. See Rate limits.
- Plan: Available on every plan.
Authentication
Workspace API key: jl_ followed by 64 lowercase hex characters, created by the workspace owner in the
dashboard (Settings → API Keys) and sent as Authorization: Bearer jl_.... The plaintext is shown once,
at creation; Jelliu stores only a SHA-256 hash. A workspace can hold up to 25 active keys.
Operations restricted to admins or owners reject keys without the full scope with 403, and say so in
their description. No key, whatever its scope, can mint or revoke API keys or rotate a webhook secret —
that requires a signed-in owner session. A revoked key stops authenticating within about 10 seconds.
See Authentication.
Path parameters
The live call’s id. Must be a UUID (400 Invalid call ID otherwise).
Response
The call is ended (or already was).