Skip to content

Skip Contact

POST
/dialer/sessions/{session_id}/calls/skip-contact

CONTACTS NOBODY. Marks a contact so the queue stops offering them.

Queue bookkeeping. Reversible with unskip-contact, which is why this is an ordinary write and not a destructive tier.

Authorizations

Parameters

Path Parameters

session_id
required

Session id.

string

Session id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirrors DialerSkipContact. Queue bookkeeping - dials nobody.

object
contact_id
required
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