Skip to main content
POST
/
campaigns
Create Campaign
curl --request POST \
  --url https://api.example.com/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "targets": [
    {
      "to_number": "<string>",
      "from_number": "<string>",
      "context": {}
    }
  ],
  "schedule_at": "2023-11-07T05:31:56Z",
  "concurrent_calls": 1,
  "retry_failed": false,
  "retry_attempts": 0,
  "context": {},
  "webhook_url": "<string>",
  "webhook_secret": "<string>",
  "notify_on_call_complete": false
}
'
import requests

url = "https://api.example.com/campaigns"

payload = {
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "targets": [
        {
            "to_number": "<string>",
            "from_number": "<string>",
            "context": {}
        }
    ],
    "schedule_at": "2023-11-07T05:31:56Z",
    "concurrent_calls": 1,
    "retry_failed": False,
    "retry_attempts": 0,
    "context": {},
    "webhook_url": "<string>",
    "webhook_secret": "<string>",
    "notify_on_call_complete": False
}
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({
    agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    name: '<string>',
    targets: [{to_number: '<string>', from_number: '<string>', context: {}}],
    schedule_at: '2023-11-07T05:31:56Z',
    concurrent_calls: 1,
    retry_failed: false,
    retry_attempts: 0,
    context: {},
    webhook_url: '<string>',
    webhook_secret: '<string>',
    notify_on_call_complete: false
  })
};

fetch('https://api.example.com/campaigns', 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.example.com/campaigns",
  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([
    'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'name' => '<string>',
    'targets' => [
        [
                'to_number' => '<string>',
                'from_number' => '<string>',
                'context' => [
                                
                ]
        ]
    ],
    'schedule_at' => '2023-11-07T05:31:56Z',
    'concurrent_calls' => 1,
    'retry_failed' => false,
    'retry_attempts' => 0,
    'context' => [
        
    ],
    'webhook_url' => '<string>',
    'webhook_secret' => '<string>',
    'notify_on_call_complete' => false
  ]),
  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.example.com/campaigns"

	payload := strings.NewReader("{\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"targets\": [\n    {\n      \"to_number\": \"<string>\",\n      \"from_number\": \"<string>\",\n      \"context\": {}\n    }\n  ],\n  \"schedule_at\": \"2023-11-07T05:31:56Z\",\n  \"concurrent_calls\": 1,\n  \"retry_failed\": false,\n  \"retry_attempts\": 0,\n  \"context\": {},\n  \"webhook_url\": \"<string>\",\n  \"webhook_secret\": \"<string>\",\n  \"notify_on_call_complete\": false\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.example.com/campaigns")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"targets\": [\n    {\n      \"to_number\": \"<string>\",\n      \"from_number\": \"<string>\",\n      \"context\": {}\n    }\n  ],\n  \"schedule_at\": \"2023-11-07T05:31:56Z\",\n  \"concurrent_calls\": 1,\n  \"retry_failed\": false,\n  \"retry_attempts\": 0,\n  \"context\": {},\n  \"webhook_url\": \"<string>\",\n  \"webhook_secret\": \"<string>\",\n  \"notify_on_call_complete\": false\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/campaigns")

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  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"targets\": [\n    {\n      \"to_number\": \"<string>\",\n      \"from_number\": \"<string>\",\n      \"context\": {}\n    }\n  ],\n  \"schedule_at\": \"2023-11-07T05:31:56Z\",\n  \"concurrent_calls\": 1,\n  \"retry_failed\": false,\n  \"retry_attempts\": 0,\n  \"context\": {},\n  \"webhook_url\": \"<string>\",\n  \"webhook_secret\": \"<string>\",\n  \"notify_on_call_complete\": false\n}"

response = http.request(request)
puts response.read_body
{
  "campaign_id": "<string>",
  "agent_id": "<string>",
  "name": "<string>",
  "total_targets": 123,
  "status": "<string>",
  "scheduled_at": "<string>",
  "started_at": "<string>",
  "calls_initiated": 123,
  "calls_completed": 123,
  "calls_failed": 123
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Campaign/batch calling request.

agent_id
string<uuid>
required
name
string
required
Required string length: 1 - 255
targets
CallTarget · object[]
required
Required array length: 1 - 1000 elements
schedule_at
string<date-time> | null
concurrent_calls
integer
default:1
Required range: 1 <= x <= 10
retry_failed
boolean
default:false
retry_attempts
integer
default:0
Required range: 0 <= x <= 3
context
Context · object | null
webhook_url
string | null

URL for campaign progress webhooks

webhook_secret
string | null

Secret for webhook signature verification

notify_on_call_complete
boolean
default:false

Send webhook for each call completion

Response

Successful Response

Campaign response.

campaign_id
string
required
agent_id
string
required
name
string
required
total_targets
integer
required
status
string
required
scheduled_at
string | null
required
started_at
string | null
required
calls_initiated
integer
required
calls_completed
integer
required
calls_failed
integer
required