Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

id
string
required

Agent id returned by the Agents API.

Minimum string length: 1

Body

application/json

Test call request.

fromNumber
string
required

Phone number that should place the test call. E.164 format is recommended.

Example:

"+14155551234"

toNumber
string
required

Phone number to dial. E.164 format is recommended.

Example:

"+14155559876"

contact
object
locationId
string
Example:

"loc_9f7a123"

campaignId
string
Example:

"campaign_speed_to_lead_123"

{key}
any

Response

Test call started.

success
boolean
required
call
object
required