Sequences

Place Voice Test Call

Place ONE real test call from a voice step. A REAL PHONE RINGS.

The call runs on the organisation's voice plan and is logged as a dry run, not against any contact or sequence enrolment. Returns the call's room_name; the outcome arrives through the call logs, not this response. Send an Idempotency-Key header so a retried request cannot ring twice.

post/sequencer/content/voice/test-call

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/sequencer/content/voice/test-call
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

from_phonestring required

One of the organisation's numbers to call from.

to_phonestring required

The number to ring. A REAL phone rings.

agent_idstring required

The voice agent that runs the call.

first_namestring required

How the agent addresses the person it rings.

last_namestring required
emailstring required

The test contact's email, as the agent would see it.

Response

Successful Response

dataSequencerPayload required

An open envelope around one sequencer record.

Open because templates, schedules and channels carry nested step data and configuration that grows as channels are added.

Changes

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