Start Parallel Session

POST

/dialer/parallel-calls/sessions/start

• Production
• QA

*** CALLS REAL PEOPLE. *** Dials every contact in the body, at once.

One request can ring a lot of telephones. The only ceiling is voice’s per-org MAX_LIMIT_OF_CALLS_PER_ORG_ID; this contract does not cap contacts itself, because a cap here that disagreed with voice’s would reject batches voice would have accepted.

Contacts whose number cannot be parsed are SKIPPED, not rejected - the batch proceeds without them and the response names who was dropped. Read it; do not assume every contact you sent was dialed.

Attempts reserve credits and connected minutes charge more. Tiered external: this reaches strangers on the customer’s behalf.

Authorizations

• BearerAuth

Parameters

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

Mirrors ParallelDialRequest minus org_id. THIS DIALS EVERY CONTACT.

object

campaign_builder_campaign_id

Any of:

string

string

null

null

campaign_id

Any of:

string

string

null

null

contacts

required

Array<object>

One person to call. to_phone is a REAL phone number of a REAL human.

An unparseable number is SKIPPED rather than rejecting the batch, so read the response to learn who was actually dialed.

object

all_phones

Any of:

Array<object>

Array<object>

object

key

additional properties

any

null

null

company

Any of:

string

string

null

null

contact_id

required

string

default_region

Any of:

string

string

null

null

dynamic_columns

Any of:

object

object

key

additional properties

any

null

null

email

Any of:

string

string

null

null

first_name

Any of:

string

string

null

null

is_redial

Any of:

boolean

boolean

null

null

last_name

Any of:

string

string

null

null

original_call_id

Any of:

string

string

null

null

phone_index

Any of:

integer

integer

null

null

redial_count

Any of:

integer

integer

null

null

timezone

string

default: America/New_York

title

Any of:

string

string

null

null

to_phone

required

string

from_phone

required

string

name

Any of:

string

string

null

null

session_id

Any of:

string

string

null

null

session_metadata

Any of:

SessionMetadataIn

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

object

key

additional properties

any

null

null

user_email

Any of:

string

string

null

null

user_id

required

string

Responses

200

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:

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