Voice

Create a parallel-dialer session in PAUSED state

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.

post/voice/dialer/sessions

Request

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

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

namestring required

Session display name.

from_phonestring required

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

list_idstring nullable

Contact list ID the SDR will dial from. Stored in session metadata.

list_titlestring nullable

Display title for the list (e.g. 'Q4 ICP'). Stored in metadata.

agent_idstring nullable

Voice agent UUID. Use GET /voice/dialer/agents to look up.

agent_namestring nullable

Legacy V1 agent name fallback (defaults to "default_agent" upstream).

entity_typestring nullable

V2 agent entity type ("agent" or "twin"). Optional.

studio_campaign_idstring nullable

Campaign Builder (Studio) campaign UUID. Optional linkage.

user_timezonestring nullable

IANA timezone for analytics grouping (e.g. "America/New_York").

skip_voicemailsboolean nullable

Per-session override for voicemail-skip behaviour. None = use SDR default.

parallel_countinteger nullable

Legs to dial per batch once the SDR opens the dialer UI (1 = power mode, 2-5 = parallel). None keeps voice's own default (2). Bug fix (graph8-com/g8 dev-API voice parity): this field previously had no effect - it was accepted by neither this DTO nor the upstream call, so any value a caller sent was silently dropped rather than forwarded.

dialing_mode'power' | 'parallel' nullable

Override the session's dialing mode. None keeps voice's default ('power'). Same bug-fix note as parallel_count above - now forwarded instead of dropped.

Response

Successful Response

Changes

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