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 using campaign configuration"
}{
"status": "success",
"test_call_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider_call_id": "<string>",
"message": "Test call initiated using campaign configuration"
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"code": "<string>",
"instance": "<string>",
"errors": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{
"status": 401,
"title": "Unauthorized",
"detail": "Invalid API key"
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"code": "insufficient_quota",
"instance": "<string>",
"errors": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"available": 3.5,
"required": 2,
"requested": 2
}{
"status": 403,
"title": "Forbidden",
"detail": "Missing required scope(s): calls:write"
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"code": "<string>",
"instance": "<string>",
"errors": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{
"status": 409,
"title": "Conflict: request in-flight",
"detail": "Another request with the same Idempotency-Key is currently being processed. Retry once it completes."
}{
"type": "https://api.topcalls.ai/errors/destination_not_allowed",
"title": "Destination Not Allowed",
"status": 422,
"code": "destination_not_allowed",
"detail": "Calls to this destination are not enabled for your account. Contact support to enable it."
}{
"type": "https://api.topcalls.ai/errors/concurrency_limit",
"title": "Concurrency Limit Reached",
"status": 429,
"code": "concurrency_limit",
"detail": "Every concurrent-call slot on this account is in use. Place the call again once a call in progress ends."
}{
"type": "https://api.topcalls.ai/errors/destination_policy_unavailable",
"title": "Service Unavailable",
"status": 503,
"code": "destination_policy_unavailable",
"detail": "The destination check is temporarily unavailable. No call was placed. Retry shortly."
}Campaigns
Place a test call for a campaign
Places a real call to phone_number with the campaign’s current config, in any campaign status. It holds credit and is billed like any other call. It isn’t linked to the campaign, a lead or a run, and stats don’t count it.
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 using campaign configuration"
}{
"status": "success",
"test_call_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider_call_id": "<string>",
"message": "Test call initiated using campaign configuration"
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"code": "<string>",
"instance": "<string>",
"errors": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{
"status": 401,
"title": "Unauthorized",
"detail": "Invalid API key"
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"code": "insufficient_quota",
"instance": "<string>",
"errors": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"available": 3.5,
"required": 2,
"requested": 2
}{
"status": 403,
"title": "Forbidden",
"detail": "Missing required scope(s): calls:write"
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"code": "<string>",
"instance": "<string>",
"errors": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{
"status": 409,
"title": "Conflict: request in-flight",
"detail": "Another request with the same Idempotency-Key is currently being processed. Retry once it completes."
}{
"type": "https://api.topcalls.ai/errors/destination_not_allowed",
"title": "Destination Not Allowed",
"status": 422,
"code": "destination_not_allowed",
"detail": "Calls to this destination are not enabled for your account. Contact support to enable it."
}{
"type": "https://api.topcalls.ai/errors/concurrency_limit",
"title": "Concurrency Limit Reached",
"status": 429,
"code": "concurrency_limit",
"detail": "Every concurrent-call slot on this account is in use. Place the call again once a call in progress ends."
}{
"type": "https://api.topcalls.ai/errors/destination_policy_unavailable",
"title": "Service Unavailable",
"status": 503,
"code": "destination_policy_unavailable",
"detail": "The destination check is temporarily unavailable. No call was placed. Retry shortly."
}Authorizations
Use Authorization: Bearer tc_live_xxxxx
Headers
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 - 255Pattern:
^[A-Za-z0-9_-]+$Example:
"a1b2c3d4-e5f6-7890-abcd-ef0123456789"
Path Parameters
Campaign UUID
Body
application/json
Response
Test call placed
⌘I