Skip to content

Create a parallel-dialer session in PAUSED state

POST
/voice/dialer/sessions

Create a new parallel-dialer session bound to the caller’s org.

The session is created in PAUSED state - no calls are placed until the SDR opens the dialer UI and joins the Twilio conference. The chat caller can then use PATCH /voice/dialer/sessions/{id}/status or any frontend control to pause / resume / stop later.

Org and user are pinned server-side from the API key. The caller cannot override them.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Body for creating a parallel-dialer session in PAUSED state.

The session is created paused so the SDR can open the dialer UI and start dialing on their own time. Org and user are pinned server-side from the API key - any value supplied here is ignored.

Required: name, from_phone. Optional: list_id / list_title (carried in session metadata), agent_id (V2 agent UUID - use GET /voice/dialer/agents to look up), studio_campaign_id (Campaign Builder UUID for studio campaign linkage).

object
agent_id
Any of:
string
agent_name
Any of:
string
dialing_mode
Any of:
string
Allowed values: power parallel
entity_type
Any of:
string
from_phone
required

Caller-ID phone number. Must be one of the org’s dialer numbers.

string
>= 9 characters <= 16 characters
list_id
Any of:
string
list_title
Any of:
string
name
required

Session display name.

string
>= 1 characters <= 200 characters
parallel_count
Any of:
integer
>= 1 <= 5
skip_voicemails
Any of:
boolean
studio_campaign_id
Any of:
string
user_timezone
Any of:
string

Responses

201

Successful Response

object
data
required

Echo of the voice service’s ParallelDialResponse for a paused-create.

We deliberately drop twilio_token from the public shape - it is SDR-frontend-specific and is regenerated by the dialer UI on join, so re-publishing it here would only confuse a chat caller.

object
created_at
Any of:
from_phone
Any of:
string
message
Any of:
string
name
Any of:
string
org_id
Any of:
string
session_id
required
string
session_metadata
Any of:
object
key
additional properties
any
status
required
string
total_calls
integer
user_email
Any of:
string
user_id
Any of:
string
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