POST /calls/{call_id}/cancel
https://api.voygr.tech/calls/{call_id}/cancel
Overview
Best-effort cancel. Returns {"cancelled": true} when the call was still cancellable (queued/dialing), {"cancelled": false} when it already reached a terminal state - safe to call idempotently.
Authentication
- API key in header
X-API-Key: Your customer API key (pk_live_...), sent on every request. Self-serve at https://api.voygr.tech/checkout.
Parameters
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
call_id | path | required | string |
Responses
200
Successful Response
application/json
Schema: object
Fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cancelled | boolean | required |
alreadyterminal
{
"cancelled": false
}401
Missing or invalid X-API-Key.
application/json
X-API-Key header absent
{
"detail": {
"error": "API key required"
}
}X-API-Key doesn't resolve to an active key
{
"detail": {
"error": "invalid API key"
}
}404
Call not found, or isn't yours.
application/json
notfound
{
"detail": "Call not found"
}On this page
