Skip to content

Call results for chosen contacts in a parallel session

POST
/dialer/parallel-calls/sessions/{session_id}/calls

SPENDS NOTHING. A read with a body (the contact ids). Another tenant’s session is a 404.

Authorizations

Parameters

Path Parameters

session_id
required

Dialer session id.

string
>= 1 characters

Dialer session id.

Query Parameters

group_by_contact

Latest call plus history per contact, or a flat list.

boolean
default: true

Latest call plus history per contact, or a flat list.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Voice SessionCallsRequest.

object
contact_ids
required
Array<string>
>= 1 items <= 500 items

Responses

200

Successful Response

object
data
required

One voice object - a collection, an agent, a route, a chat.

Open-shaped: voice adds fields to these bodies on its own release cadence and a dropped-or-added key must not be a 500 in this service.

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