Create campaign
curl --request POST \
--url https://agentcallback.com/api/campaigns \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"script_id": "<string>",
"description": "<string>",
"file_upload_id": "<string>",
"variable_mappings": {},
"from_phone_number": "<string>",
"campaign_timezone": "America/Los_Angeles",
"start_immediately": true,
"scheduled_date": "2023-12-25",
"scheduled_time": "09:00",
"working_hours": {},
"max_concurrent_calls": 3,
"call_spacing_seconds": 1,
"api_contacts_enabled": true
}
'import requests
url = "https://agentcallback.com/api/campaigns"
payload = {
"name": "<string>",
"script_id": "<string>",
"description": "<string>",
"file_upload_id": "<string>",
"variable_mappings": {},
"from_phone_number": "<string>",
"campaign_timezone": "America/Los_Angeles",
"start_immediately": True,
"scheduled_date": "2023-12-25",
"scheduled_time": "09:00",
"working_hours": {},
"max_concurrent_calls": 3,
"call_spacing_seconds": 1,
"api_contacts_enabled": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
script_id: '<string>',
description: '<string>',
file_upload_id: '<string>',
variable_mappings: {},
from_phone_number: '<string>',
campaign_timezone: 'America/Los_Angeles',
start_immediately: true,
scheduled_date: '2023-12-25',
scheduled_time: '09:00',
working_hours: {},
max_concurrent_calls: 3,
call_spacing_seconds: 1,
api_contacts_enabled: true
})
};
fetch('https://agentcallback.com/api/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://agentcallback.com/api/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([
'name' => '<string>',
'script_id' => '<string>',
'description' => '<string>',
'file_upload_id' => '<string>',
'variable_mappings' => [
],
'from_phone_number' => '<string>',
'campaign_timezone' => 'America/Los_Angeles',
'start_immediately' => true,
'scheduled_date' => '2023-12-25',
'scheduled_time' => '09:00',
'working_hours' => [
],
'max_concurrent_calls' => 3,
'call_spacing_seconds' => 1,
'api_contacts_enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://agentcallback.com/api/campaigns"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"script_id\": \"<string>\",\n \"description\": \"<string>\",\n \"file_upload_id\": \"<string>\",\n \"variable_mappings\": {},\n \"from_phone_number\": \"<string>\",\n \"campaign_timezone\": \"America/Los_Angeles\",\n \"start_immediately\": true,\n \"scheduled_date\": \"2023-12-25\",\n \"scheduled_time\": \"09:00\",\n \"working_hours\": {},\n \"max_concurrent_calls\": 3,\n \"call_spacing_seconds\": 1,\n \"api_contacts_enabled\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://agentcallback.com/api/campaigns")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"script_id\": \"<string>\",\n \"description\": \"<string>\",\n \"file_upload_id\": \"<string>\",\n \"variable_mappings\": {},\n \"from_phone_number\": \"<string>\",\n \"campaign_timezone\": \"America/Los_Angeles\",\n \"start_immediately\": true,\n \"scheduled_date\": \"2023-12-25\",\n \"scheduled_time\": \"09:00\",\n \"working_hours\": {},\n \"max_concurrent_calls\": 3,\n \"call_spacing_seconds\": 1,\n \"api_contacts_enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://agentcallback.com/api/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"script_id\": \"<string>\",\n \"description\": \"<string>\",\n \"file_upload_id\": \"<string>\",\n \"variable_mappings\": {},\n \"from_phone_number\": \"<string>\",\n \"campaign_timezone\": \"America/Los_Angeles\",\n \"start_immediately\": true,\n \"scheduled_date\": \"2023-12-25\",\n \"scheduled_time\": \"09:00\",\n \"working_hours\": {},\n \"max_concurrent_calls\": 3,\n \"call_spacing_seconds\": 1,\n \"api_contacts_enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"campaign": {
"id": "<string>",
"name": "<string>",
"status": "<string>",
"script_id": "<string>",
"total_calls": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"error": "<string>",
"details": "<string>",
"code": "<string>"
}{
"success": false,
"error": "<string>",
"details": "<string>",
"code": "<string>"
}{
"success": false,
"error": "<string>",
"details": "<string>",
"code": "<string>"
}{
"success": false,
"error": "<string>",
"details": "<string>",
"code": "<string>"
}{
"success": false,
"error": "<string>",
"details": "<string>",
"code": "<string>"
}POST
/
api
/
campaigns
Create campaign
curl --request POST \
--url https://agentcallback.com/api/campaigns \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"script_id": "<string>",
"description": "<string>",
"file_upload_id": "<string>",
"variable_mappings": {},
"from_phone_number": "<string>",
"campaign_timezone": "America/Los_Angeles",
"start_immediately": true,
"scheduled_date": "2023-12-25",
"scheduled_time": "09:00",
"working_hours": {},
"max_concurrent_calls": 3,
"call_spacing_seconds": 1,
"api_contacts_enabled": true
}
'import requests
url = "https://agentcallback.com/api/campaigns"
payload = {
"name": "<string>",
"script_id": "<string>",
"description": "<string>",
"file_upload_id": "<string>",
"variable_mappings": {},
"from_phone_number": "<string>",
"campaign_timezone": "America/Los_Angeles",
"start_immediately": True,
"scheduled_date": "2023-12-25",
"scheduled_time": "09:00",
"working_hours": {},
"max_concurrent_calls": 3,
"call_spacing_seconds": 1,
"api_contacts_enabled": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
script_id: '<string>',
description: '<string>',
file_upload_id: '<string>',
variable_mappings: {},
from_phone_number: '<string>',
campaign_timezone: 'America/Los_Angeles',
start_immediately: true,
scheduled_date: '2023-12-25',
scheduled_time: '09:00',
working_hours: {},
max_concurrent_calls: 3,
call_spacing_seconds: 1,
api_contacts_enabled: true
})
};
fetch('https://agentcallback.com/api/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://agentcallback.com/api/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([
'name' => '<string>',
'script_id' => '<string>',
'description' => '<string>',
'file_upload_id' => '<string>',
'variable_mappings' => [
],
'from_phone_number' => '<string>',
'campaign_timezone' => 'America/Los_Angeles',
'start_immediately' => true,
'scheduled_date' => '2023-12-25',
'scheduled_time' => '09:00',
'working_hours' => [
],
'max_concurrent_calls' => 3,
'call_spacing_seconds' => 1,
'api_contacts_enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://agentcallback.com/api/campaigns"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"script_id\": \"<string>\",\n \"description\": \"<string>\",\n \"file_upload_id\": \"<string>\",\n \"variable_mappings\": {},\n \"from_phone_number\": \"<string>\",\n \"campaign_timezone\": \"America/Los_Angeles\",\n \"start_immediately\": true,\n \"scheduled_date\": \"2023-12-25\",\n \"scheduled_time\": \"09:00\",\n \"working_hours\": {},\n \"max_concurrent_calls\": 3,\n \"call_spacing_seconds\": 1,\n \"api_contacts_enabled\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://agentcallback.com/api/campaigns")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"script_id\": \"<string>\",\n \"description\": \"<string>\",\n \"file_upload_id\": \"<string>\",\n \"variable_mappings\": {},\n \"from_phone_number\": \"<string>\",\n \"campaign_timezone\": \"America/Los_Angeles\",\n \"start_immediately\": true,\n \"scheduled_date\": \"2023-12-25\",\n \"scheduled_time\": \"09:00\",\n \"working_hours\": {},\n \"max_concurrent_calls\": 3,\n \"call_spacing_seconds\": 1,\n \"api_contacts_enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://agentcallback.com/api/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"script_id\": \"<string>\",\n \"description\": \"<string>\",\n \"file_upload_id\": \"<string>\",\n \"variable_mappings\": {},\n \"from_phone_number\": \"<string>\",\n \"campaign_timezone\": \"America/Los_Angeles\",\n \"start_immediately\": true,\n \"scheduled_date\": \"2023-12-25\",\n \"scheduled_time\": \"09:00\",\n \"working_hours\": {},\n \"max_concurrent_calls\": 3,\n \"call_spacing_seconds\": 1,\n \"api_contacts_enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"campaign": {
"id": "<string>",
"name": "<string>",
"status": "<string>",
"script_id": "<string>",
"total_calls": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"error": "<string>",
"details": "<string>",
"code": "<string>"
}{
"success": false,
"error": "<string>",
"details": "<string>",
"code": "<string>"
}{
"success": false,
"error": "<string>",
"details": "<string>",
"code": "<string>"
}{
"success": false,
"error": "<string>",
"details": "<string>",
"code": "<string>"
}{
"success": false,
"error": "<string>",
"details": "<string>",
"code": "<string>"
}Authorizations
Create and manage API keys in your AgentCallback account under Dashboard > API Keys.
Body
application/json
Campaign configuration.
Available options:
single, geographic, random Example:
"America/Los_Angeles"
Example:
"09:00"
Required range:
1 <= x <= 6Required range:
x >= 0⌘I