Skip to content

Create Paused Parallel Session

POST
/dialer/parallel-calls/sessions

CONTACTS NOBODY. Creates a PAUSED parallel session.

The session exists and is configured, and not one telephone rings. This is the safe half of the pair - POST /dialer/parallel-calls/sessions/start is the half that dials.

Published as a POST to the collection precisely because that is what a customer will reach for first, and the harmless operation should be the one they land on by guessing.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirrors CreateSessionRequest minus org_id. Dials NOBODY.

object
campaign_builder_campaign_id
Any of:
string
campaign_id
Any of:
string
dialing_mode
Any of:
string
Allowed values: power parallel
from_phone
required
string
name
Any of:
string
parallel_count
Any of:
integer
session_id
Any of:
string
session_metadata
Any of:

Free-form session context. Open: voice grows this per release.

object
key
additional properties
any
user_email
Any of:
string
user_id
required
string

Responses

201

Successful Response

object
data
required

An open envelope for one dialer result.

Open because voice owns the shape of a session, a call stub and a queue stat, and it grows them without a contract bump here. A dropped field would otherwise turn an added upstream field into a removed public one.

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
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