Skip to content

Place Voice Test Call

POST
/sequencer/content/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.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Place one test call from a voice step. Mirrors DryRunCallPayload.

object
agent_id
required

The voice agent that runs the call.

string
>= 1 characters
email
required

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

string
first_name
required

How the agent addresses the person it rings.

string
from_phone
required

One of the organisation’s numbers to call from.

string
>= 1 characters
last_name
required
string
to_phone
required

The number to ring. A REAL phone rings.

string
>= 1 characters

Responses

202

Successful Response

object
data
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.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string