Dialer

Start Parallel Session

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

post/dialer/parallel-calls/sessions/start

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/dialer/parallel-calls/sessions/start
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

user_idstring required
user_emailstring nullable
from_phonestring required
session_idstring nullable
campaign_idstring nullable
campaign_builder_campaign_idstring nullable
session_metadataSessionMetadataIn

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

namestring nullable

Response

Successful Response

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

Changes

No recorded changes to this operation across all 2 revisions of this API.