Skip to content

End a call

POST
/v1/calls/{call}/end
curl --request POST \
--url https://api.caller9.app/v1/calls/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/end \
--header 'Authorization: Bearer <token>'

Removes the call from the studio. An answered call is hung up. A call that is still queued (ringing) is not simply rejected: it is sent to the studio’s voicemail greeting, the same as when the studio is busy. An outbound call that has not been dialed yet is cancelled. Ending a call that has already ended (but is still known to the studio) returns ok.

call
required
string format: uuid

Call ID (UUID).

Action accepted.

Media typeapplication/json
object
ok
required
boolean

Example

{
"ok": true
}

Missing, invalid, expired or revoked API key.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

The key isn’t allowed to do this (e.g. a read-only key making a change).

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

call not found — the call doesn’t exist, belongs to another organization, or has already ended (or, for reorder, call not found in queue).

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

Too many requests for this API key. Retry after Retry-After seconds.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}
Retry-After
integer

Seconds until the rate-limit window resets.