Dialer

Check Session Number

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

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

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/dialer/sessions/{session_id}/number-check
  • Auth: HTTP bearer

Path parameters

session_idstring required

Session id.

Query parameters

contact_idinteger required

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

phone_fieldstring required

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

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

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

Changes

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