Skip to content

Decline Transfer

POST
/dialer/transfer/{call_id}/decline

AFFECTS A LIVE CALL WITH A PERSON ON IT, but places no new call.

The colleague passes on the transfer. The CALLER - a real human - STAYS ON HOLD until the ring times out; declining does not hang up on them and does not tell them anything. Worth knowing before wiring this to an auto-decline rule.

Authorizations

Parameters

Path Parameters

call_id
required

Call being transferred.

string

Call being transferred.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for one dialer result.

Open because voice owns the shape of a session, a call stub and a queue stat, and it grows them without a contract bump here. A dropped field would otherwise turn an added upstream field into a removed public one.

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
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

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