Skip to content

Read Session Grid

POST
/dialer/sessions/{session_id}/grid

CONTACTS NOBODY. Reads a page of the session’s contact grid.

A POST because the filter and sort specification is too large for a query string, not because it changes anything - it mutates nothing and dials nobody. Tiered read by an explicit rule for that reason, so a read-only key can page through a queue.

Authorizations

Parameters

Path Parameters

session_id
required

Session id.

string

Session id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body

Mirrors GridPageRequest. A read - it paginates the queue grid.

object
filter_spec
Any of:

Which contacts in the list are eligible to be dialed.

Narrowing this on a RUNNING session changes who gets called next. It is not a display filter.

object
exclude_dispositions
Array<string>
predicates
Array<object>

One clause of a queue filter. conditions nests for AND/OR groups.

conditions is typed as a list of plain objects rather than as a list of FilterPredicate, ON PURPOSE. Voice’s own model IS recursive, and this one was too, which made it the only self-referencing schema in the published contract - and the developer-docs renderer recurses on a self-referencing schema with no depth limit until Node runs out of memory (verify-help-docs and User help coverage and rendering both died with exit 134 on every head that carried it). The wire format is unchanged: each entry has this same shape (field, op, value, values, conditions) and is forwarded to voice as-is, which validates it against its recursive model. The parity test compares field NAMES, so it still pins this model to voice’s.

object
conditions
Any of:
Array<object>
object
key
additional properties
any
field
required
string
op
required
string
value
Any of:
values
Any of:
Array
search
Any of:
string
include_contact_data
boolean
limit
integer
default: 100
offset
integer
order_spec
Any of:

The order the queue is worked in, and which phone field is tried first.

object
mode
string
default: natural_skip_dialed
Allowed values: natural_skip_dialed dialed_first
phone_priority
Array<string>
sort_model
Array<object>
object
key
additional properties
string
sort_model
Any of:
Array<object>
object
key
additional properties
string
valid_phones_only
boolean

Responses

200

Successful Response

object
data
required

An open envelope for a LIST result, so a bare list keeps its shape.

object
items
Array
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