Skip to content

List voice agents available for a dialer session

GET
/voice/dialer/agents

List voice agents that can be assigned to a parallel-dialer session.

The chat layer uses this to populate the picker before calling POST /voice/dialer/sessions - feed the returned agent_id into the create body.

Returns up to _AGENT_LIST_CAP rows (no pagination on the public surface; the picker is meant to fit in one chat turn).

Authorizations

Parameters

Query Parameters

role
Any of:
string

Filter by agent role (e.g. “SDR”, “AE”, “Receptionist”, “CSM”).

agent_status
Any of:
string

Filter by status (e.g. “active”). Defaults to all.

entity_type
Any of:
string

“agent” or “twin”. Defaults to all.

search
Any of:
string

Substring match on agent name.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

List wrapper for the agents picker.

object
agents
Array<object>

One row from the agents list.

Trimmed to the fields a chat picker needs (name, role, status, and the UUID to feed back into create_dialer_session). Anything else the voice service returns (knowledge collections, voice/calendar) stays server-side - the chat layer doesn’t need it for the picker UX.

object
agent_id
required

Agent UUID - feed this into create_dialer_session.

string
agent_name
Any of:
string
agent_status
Any of:
string
description
Any of:
string
entity_type
Any of:
string
is_template
boolean
phone
Any of:
string
role
Any of:
string
total_count
integer
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