Skip to main content
POST
voice.call.end

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by voice.call.start-agent or a row of voice.calls.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

status
enum<string>
required

End request accepted, or call already ended.

Available options:
ending,
ended
stopsRingingBy
string

Set when the call was still ringing and cannot be cancelled while it rings: it is not cancelled yet, and stops ringing by this time at the latest, ISO 8601. If the person answers first they are hung up at once and that connected time is charged.