Skip to content

Check Session Number

GET
/dialer/sessions/{session_id}/number-check

CONTACTS NOBODY. Pre-dial warning for a number picked by hand.

Says whether the dialer would skip that number and why, and which of the contact’s numbers to offer instead. The answer contains the contact’s PHONE NUMBERS, so the contact must be visible to the key (404 otherwise, before voice is called); voice itself only checks that the session belongs to the key’s organisation. Advisory: any problem answers “no warning”.

Authorizations

Parameters

Path Parameters

session_id
required

Session id.

string

Session id.

Query Parameters

contact_id
required

Contact primary key (mashup_contacts.id) in this session’s list.

integer

Contact primary key (mashup_contacts.id) in this session’s list.

phone_field
required

Which of the contact’s phone fields the rep picked.

string
>= 1 characters <= 64 characters

Which of the contact’s phone fields the rep picked.

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