Dialer

Create Session Draft

CONTACTS NOBODY. Creates a DRAFT session and dials no one.

The safe first step: it resolves the list or sequence, snapshots the filter, and stops. POST /dialer/sessions/{id}/next-batch is what turns a draft into ringing telephones.

Not idempotent in the way it looks: voice REUSES a live session for the same list rather than creating a second one, so calling this twice does not double-dial - it returns the existing session. from_phone is optional here and enforced at dial time.

post/dialer/sessions/draft

Request

Base URL: https://be.graph8.com/api/v1
URL: https://be.graph8.com/api/v1/dialer/sessions/draft
Auth: HTTP bearer

Headers

Authorizationstring nullable

X-Target-Org-Idstring nullable

Request body

user_idstring required

user_emailstring nullable

list_idstring nullable

sequence_idstring nullable

sequence_step_orderinteger nullable

parallel_countinteger

from_phonestring nullable

agent_idstring nullable

entity_typestring nullable

dialing_mode'power' | 'parallel' nullable

campaign_idstring nullable

campaign_builder_campaign_idstring nullable

namestring nullable

user_timezonestring nullable

list_titlestring nullable

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