Skip to main content
POST
Place a test call for a campaign

Authorizations

Authorization
string
header
required

Use Authorization: Bearer tc_live_xxxxx

Headers

Idempotency-Key
string

Optional client-supplied idempotency key. When present, the gateway caches the response for 24 hours and returns the same response on retried requests with the same key (account-scoped). Safe for retries on network blips. Format: 8-255 ASCII characters from [A-Za-z0-9_-].

Required string length: 8 - 255
Pattern: ^[A-Za-z0-9_-]+$
Example:

"a1b2c3d4-e5f6-7890-abcd-ef0123456789"

Path Parameters

campaign_id
string<uuid>
required

Campaign UUID

Body

application/json
phone_number
string
required

Number to dial, in E.164 format

Example:

"+14155551234"

test_lead_data
object

Optional lead-like context injected into the call for testing personalized scripts

Response

Test call placed

status
enum<string>
Available options:
success
test_call_id
string<uuid>

Internal call record ID. Use with GET /v1/calls/{id} to check status.

provider_call_id
string | null

Telephony provider's call identifier, if dispatch succeeded.

message
string
Example:

"Test call initiated successfully"