Voice

Decline or hang up a ringing inbound call

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.

post/voice/inbound-calls/decline

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/voice/inbound-calls/decline
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

room_namestring required

The ringing call's room name.

actionstring

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

Response

Successful Response

dataVoicePayload 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.

Changes

No recorded changes to this operation across all 2 revisions of this API.