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

Makes a retry safe. A 2xx response is stored for 24 hours per account, and a retry with the same key gets it back with Idempotent-Replay: true instead of running again. Errors aren't stored, so a retry after one runs fresh. The key isn't tied to a path or body: use a new key for every different request. A malformed key gets 400.

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.

Example:

"+14155551234"

test_lead_data
object

Lead data for testing a personalized script. The lead's phone is phone_number.

Response

Test call placed

status
enum<string>

pending comes with 202.

Available options:
success,
pending
test_call_id
string<uuid>

The call's id for GET /v1/calls/{id}.

provider_call_id
string | null

The telephony call id. Absent on 202.

message
string
Example:

"Test call initiated using campaign configuration"