Skip to main content
POST
/
v1
/
campaigns
/
{campaign_id}
/
test
Place a test call for a campaign
curl --request POST \
  --url https://api.topcalls.ai/v1/campaigns/{campaign_id}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number": "+14155551234",
  "test_lead_data": {
    "name": "<string>",
    "email": "<string>",
    "notes": "<string>",
    "status": "<string>",
    "metadata": {}
  }
}
'
import requests

url = "https://api.topcalls.ai/v1/campaigns/{campaign_id}/test"

payload = {
"phone_number": "+14155551234",
"test_lead_data": {
"name": "<string>",
"email": "<string>",
"notes": "<string>",
"status": "<string>",
"metadata": {}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
phone_number: '+14155551234',
test_lead_data: {
name: '<string>',
email: '<string>',
notes: '<string>',
status: '<string>',
metadata: {}
}
})
};

fetch('https://api.topcalls.ai/v1/campaigns/{campaign_id}/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.topcalls.ai/v1/campaigns/{campaign_id}/test",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'phone_number' => '+14155551234',
'test_lead_data' => [
'name' => '<string>',
'email' => '<string>',
'notes' => '<string>',
'status' => '<string>',
'metadata' => [

]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.topcalls.ai/v1/campaigns/{campaign_id}/test"

payload := strings.NewReader("{\n \"phone_number\": \"+14155551234\",\n \"test_lead_data\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"notes\": \"<string>\",\n \"status\": \"<string>\",\n \"metadata\": {}\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.topcalls.ai/v1/campaigns/{campaign_id}/test")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"phone_number\": \"+14155551234\",\n \"test_lead_data\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"notes\": \"<string>\",\n \"status\": \"<string>\",\n \"metadata\": {}\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.topcalls.ai/v1/campaigns/{campaign_id}/test")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone_number\": \"+14155551234\",\n \"test_lead_data\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"notes\": \"<string>\",\n \"status\": \"<string>\",\n \"metadata\": {}\n }\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "test_call_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "provider_call_id": "<string>",
  "message": "Test call initiated successfully"
}
{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"code": "<string>",
"instance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"errors": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"details": "<string>"
}
{
"status": 401,
"title": "Unauthorized",
"detail": "Invalid or missing API key"
}
{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"code": "<string>",
"instance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"errors": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"details": "<string>",
"available": 3.5,
"required": 5,
"welcome_bonus_remaining": 0
}
{
"status": 403,
"title": "Forbidden",
"detail": "Missing required scope: calls:write"
}
{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"code": "<string>",
"instance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"errors": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"details": "<string>"
}
{
"status": 409,
"title": "Conflict: request in-flight",
"detail": "Another request with the same Idempotency-Key is currently being processed."
}

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"