Skip to content

Decline or hang up a ringing inbound call

POST
/voice/inbound-calls/decline

ENDS A CALL A REAL PERSON IS ON. There is no undo.

Declining sends the caller onward - to voicemail or the next rule - rather than simply dropping them, which is the difference from action: hangup.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
action

“hangup” ends the call. Voice treats anything else as a decline.

string
default: hangup
room_name
required

The ringing call’s room name.

string

Responses

200

Successful Response

object
data
required

One voice object - a collection, an agent, a route, a chat.

Open-shaped: voice adds fields to these bodies on its own release cadence and a dropped-or-added key must not be a 500 in this service.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string