List parallel dialer sessions

GET

/voice/dialer/sessions

• Production
• QA

List parallel dialer sessions for the authenticated org.

Forwards to the voice service’s GET /api/parallel-calls/sessions endpoint with org_id pinned to the API key’s org. All filtering / paging arguments map 1:1 to the upstream contract.

Authorizations

• BearerAuth

Parameters

Query Parameters

page

Page number (1-indexed).

integer

default: 1 >= 1

Page number (1-indexed).

page_size

Sessions per page (max 200).

integer

default: 50 >= 1 <= 200

Sessions per page (max 200).

status

Any of:

string

string

null

null

Comma-separated session statuses (e.g. “ACTIVE,PAUSED”).

user_email

Any of:

string

string

null

null

Filter by SDR email (substring).

name

Any of:

string

string

null

null

Filter by session name (substring).

campaign_id

Any of:

string

string

null

null

Filter by campaign id (substring).

list_id

Any of:

string

string

null

null

Filter by list id stored in session metadata.

list_name

Any of:

string

string

null

null

Filter by list title (substring).

date_from

Any of:

string

string

null

null

ISO timestamp - sessions created on/after.

date_to

Any of:

string

string

null

null

ISO timestamp - sessions created on/before.

sort_by

Any of:

string

string

null

null

Column to sort on (e.g. “created_at”, “updated_at”, “total_calls”).

sort_order

“asc” or “desc”. Defaults to desc.

string

default: desc

“asc” or “desc”. Defaults to desc.

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Responses

200

Successful Response

object

data

required

List wrapper for dialer sessions.

Top-level matches the voice payload (data + pagination) so the public API caller sees the exact same shape they would get if voice were exposed directly. The standard ApiResponse envelope wraps THIS object as its data field.

object

pagination

Pagination block returned by the voice list-sessions endpoint.

Mirrored verbatim so the field names match what voice already ships (total_items / total_pages / current_page / page_size). Keeping voice’s field names here avoids a renaming layer that would have to be updated every time voice extends the block.

object

current_page

integer

default: 1

page_size

integer

default: 50

total_items

integer

total_pages

integer

sessions

Array<object>

One row from the dialer-sessions list.

The voice service returns a flat dict per session built from ParallelDialSession columns plus an aggregated contact_ids array. We surface every documented column directly so that read-only consumers can introspect a session without a follow-up call.

object

campaign_builder_campaign_id

Any of:

string

string

null

null

campaign_id

Any of:

string

string

null

null

contact_ids

Array

created_at

Any of:

unknown

null

null

from_phone

Any of:

string

string

null

null

name

Any of:

string

string

null

null

org_id

Any of:

string

string

null

null

session_id

required

string

session_metadata

Any of:

object

object

key

additional properties

any

null

null

status

Any of:

string

string

null

null

total_calls

Any of:

integer

integer

null

null

updated_at

Any of:

unknown

null

null

user_email

Any of:

string

string

null

null

user_id

Any of:

string

string

null

null

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string