Create campaign
curl --request POST \
--url https://www.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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variable_mappings": {},
"from_phone_number": "<string>",
"campaign_timezone": "America/Los_Angeles",
"scheduled_date": "2023-12-25",
"scheduled_time": "09:00",
"scheduled_timezone_input": "America/Los_Angeles",
"working_hours": {
"weekly": {
"monday": [
{
"start": "09:00",
"end": "17:00"
}
],
"tuesday": [
{
"start": "09:00",
"end": "17:00"
}
],
"wednesday": [
{
"start": "09:00",
"end": "17:00"
}
],
"thursday": [
{
"start": "09:00",
"end": "17:00"
}
],
"friday": [
{
"start": "09:00",
"end": "17:00"
}
],
"saturday": [
{
"start": "09:00",
"end": "17:00"
}
],
"sunday": [
{
"start": "09:00",
"end": "17:00"
}
]
}
},
"working_hours_timezone": "America/New_York",
"workflow_config": {
"retryOutcomes": [
"CALLEE_DID_NOT_PICKUP",
"VOICE_MAIL"
],
"attempts": [
{
"day": 0,
"startTime": "00:00",
"doubleDial": false
},
{
"day": 1,
"startTime": "16:00",
"doubleDial": true
},
{
"day": 3,
"startTime": "10:00",
"doubleDial": false
}
],
"timezone": "America/Los_Angeles"
},
"max_concurrent_calls": 3,
"call_spacing_seconds": 1,
"api_contacts_enabled": true
}
'import requests
url = "https://www.agentcallback.com/api/campaigns"
payload = {
"name": "<string>",
"script_id": "<string>",
"description": "<string>",
"file_upload_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variable_mappings": {},
"from_phone_number": "<string>",
"campaign_timezone": "America/Los_Angeles",
"scheduled_date": "2023-12-25",
"scheduled_time": "09:00",
"scheduled_timezone_input": "America/Los_Angeles",
"working_hours": { "weekly": {
"monday": [
{
"start": "09:00",
"end": "17:00"
}
],
"tuesday": [
{
"start": "09:00",
"end": "17:00"
}
],
"wednesday": [
{
"start": "09:00",
"end": "17:00"
}
],
"thursday": [
{
"start": "09:00",
"end": "17:00"
}
],
"friday": [
{
"start": "09:00",
"end": "17:00"
}
],
"saturday": [
{
"start": "09:00",
"end": "17:00"
}
],
"sunday": [
{
"start": "09:00",
"end": "17:00"
}
]
} },
"working_hours_timezone": "America/New_York",
"workflow_config": {
"retryOutcomes": ["CALLEE_DID_NOT_PICKUP", "VOICE_MAIL"],
"attempts": [
{
"day": 0,
"startTime": "00:00",
"doubleDial": False
},
{
"day": 1,
"startTime": "16:00",
"doubleDial": True
},
{
"day": 3,
"startTime": "10:00",
"doubleDial": False
}
],
"timezone": "America/Los_Angeles"
},
"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: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
variable_mappings: {},
from_phone_number: '<string>',
campaign_timezone: 'America/Los_Angeles',
scheduled_date: '2023-12-25',
scheduled_time: '09:00',
scheduled_timezone_input: 'America/Los_Angeles',
working_hours: {
weekly: {
monday: [{start: '09:00', end: '17:00'}],
tuesday: [{start: '09:00', end: '17:00'}],
wednesday: [{start: '09:00', end: '17:00'}],
thursday: [{start: '09:00', end: '17:00'}],
friday: [{start: '09:00', end: '17:00'}],
saturday: [{start: '09:00', end: '17:00'}],
sunday: [{start: '09:00', end: '17:00'}]
}
},
working_hours_timezone: 'America/New_York',
workflow_config: {
retryOutcomes: ['CALLEE_DID_NOT_PICKUP', 'VOICE_MAIL'],
attempts: [
{day: 0, startTime: '00:00', doubleDial: false},
{day: 1, startTime: '16:00', doubleDial: true},
{day: 3, startTime: '10:00', doubleDial: false}
],
timezone: 'America/Los_Angeles'
},
max_concurrent_calls: 3,
call_spacing_seconds: 1,
api_contacts_enabled: true
})
};
fetch('https://www.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://www.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' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'variable_mappings' => [
],
'from_phone_number' => '<string>',
'campaign_timezone' => 'America/Los_Angeles',
'scheduled_date' => '2023-12-25',
'scheduled_time' => '09:00',
'scheduled_timezone_input' => 'America/Los_Angeles',
'working_hours' => [
'weekly' => [
'monday' => [
[
'start' => '09:00',
'end' => '17:00'
]
],
'tuesday' => [
[
'start' => '09:00',
'end' => '17:00'
]
],
'wednesday' => [
[
'start' => '09:00',
'end' => '17:00'
]
],
'thursday' => [
[
'start' => '09:00',
'end' => '17:00'
]
],
'friday' => [
[
'start' => '09:00',
'end' => '17:00'
]
],
'saturday' => [
[
'start' => '09:00',
'end' => '17:00'
]
],
'sunday' => [
[
'start' => '09:00',
'end' => '17:00'
]
]
]
],
'working_hours_timezone' => 'America/New_York',
'workflow_config' => [
'retryOutcomes' => [
'CALLEE_DID_NOT_PICKUP',
'VOICE_MAIL'
],
'attempts' => [
[
'day' => 0,
'startTime' => '00:00',
'doubleDial' => false
],
[
'day' => 1,
'startTime' => '16:00',
'doubleDial' => true
],
[
'day' => 3,
'startTime' => '10:00',
'doubleDial' => false
]
],
'timezone' => 'America/Los_Angeles'
],
'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://www.agentcallback.com/api/campaigns"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"script_id\": \"<string>\",\n \"description\": \"<string>\",\n \"file_upload_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variable_mappings\": {},\n \"from_phone_number\": \"<string>\",\n \"campaign_timezone\": \"America/Los_Angeles\",\n \"scheduled_date\": \"2023-12-25\",\n \"scheduled_time\": \"09:00\",\n \"scheduled_timezone_input\": \"America/Los_Angeles\",\n \"working_hours\": {\n \"weekly\": {\n \"monday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"sunday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ]\n }\n },\n \"working_hours_timezone\": \"America/New_York\",\n \"workflow_config\": {\n \"retryOutcomes\": [\n \"CALLEE_DID_NOT_PICKUP\",\n \"VOICE_MAIL\"\n ],\n \"attempts\": [\n {\n \"day\": 0,\n \"startTime\": \"00:00\",\n \"doubleDial\": false\n },\n {\n \"day\": 1,\n \"startTime\": \"16:00\",\n \"doubleDial\": true\n },\n {\n \"day\": 3,\n \"startTime\": \"10:00\",\n \"doubleDial\": false\n }\n ],\n \"timezone\": \"America/Los_Angeles\"\n },\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://www.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\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variable_mappings\": {},\n \"from_phone_number\": \"<string>\",\n \"campaign_timezone\": \"America/Los_Angeles\",\n \"scheduled_date\": \"2023-12-25\",\n \"scheduled_time\": \"09:00\",\n \"scheduled_timezone_input\": \"America/Los_Angeles\",\n \"working_hours\": {\n \"weekly\": {\n \"monday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"sunday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ]\n }\n },\n \"working_hours_timezone\": \"America/New_York\",\n \"workflow_config\": {\n \"retryOutcomes\": [\n \"CALLEE_DID_NOT_PICKUP\",\n \"VOICE_MAIL\"\n ],\n \"attempts\": [\n {\n \"day\": 0,\n \"startTime\": \"00:00\",\n \"doubleDial\": false\n },\n {\n \"day\": 1,\n \"startTime\": \"16:00\",\n \"doubleDial\": true\n },\n {\n \"day\": 3,\n \"startTime\": \"10:00\",\n \"doubleDial\": false\n }\n ],\n \"timezone\": \"America/Los_Angeles\"\n },\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://www.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\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variable_mappings\": {},\n \"from_phone_number\": \"<string>\",\n \"campaign_timezone\": \"America/Los_Angeles\",\n \"scheduled_date\": \"2023-12-25\",\n \"scheduled_time\": \"09:00\",\n \"scheduled_timezone_input\": \"America/Los_Angeles\",\n \"working_hours\": {\n \"weekly\": {\n \"monday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"sunday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ]\n }\n },\n \"working_hours_timezone\": \"America/New_York\",\n \"workflow_config\": {\n \"retryOutcomes\": [\n \"CALLEE_DID_NOT_PICKUP\",\n \"VOICE_MAIL\"\n ],\n \"attempts\": [\n {\n \"day\": 0,\n \"startTime\": \"00:00\",\n \"doubleDial\": false\n },\n {\n \"day\": 1,\n \"startTime\": \"16:00\",\n \"doubleDial\": true\n },\n {\n \"day\": 3,\n \"startTime\": \"10:00\",\n \"doubleDial\": false\n }\n ],\n \"timezone\": \"America/Los_Angeles\"\n },\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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "<string>",
"script_id": "<string>",
"file_upload_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"api_contacts_enabled": true,
"campaign_timezone": "<string>",
"working_hours": {
"weekly": {
"monday": [
{
"start": "09:00",
"end": "17:00"
}
],
"tuesday": [
{
"start": "09:00",
"end": "17:00"
}
],
"wednesday": [
{
"start": "09:00",
"end": "17:00"
}
],
"thursday": [
{
"start": "09:00",
"end": "17:00"
}
],
"friday": [
{
"start": "09:00",
"end": "17:00"
}
],
"saturday": [
{
"start": "09:00",
"end": "17:00"
}
],
"sunday": [
{
"start": "09:00",
"end": "17:00"
}
]
}
},
"working_hours_timezone": "<string>",
"scheduled_start_time": "2023-11-07T05:31:56Z",
"scheduled_timezone": "<string>",
"workflow_config": {
"retryOutcomes": [
"CALLEE_DID_NOT_PICKUP",
"VOICE_MAIL"
],
"attempts": [
{
"day": 0,
"startTime": "00:00",
"doubleDial": false
},
{
"day": 1,
"startTime": "16:00",
"doubleDial": true
},
{
"day": 3,
"startTime": "10:00",
"doubleDial": false
}
],
"timezone": "America/Los_Angeles"
},
"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://www.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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variable_mappings": {},
"from_phone_number": "<string>",
"campaign_timezone": "America/Los_Angeles",
"scheduled_date": "2023-12-25",
"scheduled_time": "09:00",
"scheduled_timezone_input": "America/Los_Angeles",
"working_hours": {
"weekly": {
"monday": [
{
"start": "09:00",
"end": "17:00"
}
],
"tuesday": [
{
"start": "09:00",
"end": "17:00"
}
],
"wednesday": [
{
"start": "09:00",
"end": "17:00"
}
],
"thursday": [
{
"start": "09:00",
"end": "17:00"
}
],
"friday": [
{
"start": "09:00",
"end": "17:00"
}
],
"saturday": [
{
"start": "09:00",
"end": "17:00"
}
],
"sunday": [
{
"start": "09:00",
"end": "17:00"
}
]
}
},
"working_hours_timezone": "America/New_York",
"workflow_config": {
"retryOutcomes": [
"CALLEE_DID_NOT_PICKUP",
"VOICE_MAIL"
],
"attempts": [
{
"day": 0,
"startTime": "00:00",
"doubleDial": false
},
{
"day": 1,
"startTime": "16:00",
"doubleDial": true
},
{
"day": 3,
"startTime": "10:00",
"doubleDial": false
}
],
"timezone": "America/Los_Angeles"
},
"max_concurrent_calls": 3,
"call_spacing_seconds": 1,
"api_contacts_enabled": true
}
'import requests
url = "https://www.agentcallback.com/api/campaigns"
payload = {
"name": "<string>",
"script_id": "<string>",
"description": "<string>",
"file_upload_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variable_mappings": {},
"from_phone_number": "<string>",
"campaign_timezone": "America/Los_Angeles",
"scheduled_date": "2023-12-25",
"scheduled_time": "09:00",
"scheduled_timezone_input": "America/Los_Angeles",
"working_hours": { "weekly": {
"monday": [
{
"start": "09:00",
"end": "17:00"
}
],
"tuesday": [
{
"start": "09:00",
"end": "17:00"
}
],
"wednesday": [
{
"start": "09:00",
"end": "17:00"
}
],
"thursday": [
{
"start": "09:00",
"end": "17:00"
}
],
"friday": [
{
"start": "09:00",
"end": "17:00"
}
],
"saturday": [
{
"start": "09:00",
"end": "17:00"
}
],
"sunday": [
{
"start": "09:00",
"end": "17:00"
}
]
} },
"working_hours_timezone": "America/New_York",
"workflow_config": {
"retryOutcomes": ["CALLEE_DID_NOT_PICKUP", "VOICE_MAIL"],
"attempts": [
{
"day": 0,
"startTime": "00:00",
"doubleDial": False
},
{
"day": 1,
"startTime": "16:00",
"doubleDial": True
},
{
"day": 3,
"startTime": "10:00",
"doubleDial": False
}
],
"timezone": "America/Los_Angeles"
},
"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: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
variable_mappings: {},
from_phone_number: '<string>',
campaign_timezone: 'America/Los_Angeles',
scheduled_date: '2023-12-25',
scheduled_time: '09:00',
scheduled_timezone_input: 'America/Los_Angeles',
working_hours: {
weekly: {
monday: [{start: '09:00', end: '17:00'}],
tuesday: [{start: '09:00', end: '17:00'}],
wednesday: [{start: '09:00', end: '17:00'}],
thursday: [{start: '09:00', end: '17:00'}],
friday: [{start: '09:00', end: '17:00'}],
saturday: [{start: '09:00', end: '17:00'}],
sunday: [{start: '09:00', end: '17:00'}]
}
},
working_hours_timezone: 'America/New_York',
workflow_config: {
retryOutcomes: ['CALLEE_DID_NOT_PICKUP', 'VOICE_MAIL'],
attempts: [
{day: 0, startTime: '00:00', doubleDial: false},
{day: 1, startTime: '16:00', doubleDial: true},
{day: 3, startTime: '10:00', doubleDial: false}
],
timezone: 'America/Los_Angeles'
},
max_concurrent_calls: 3,
call_spacing_seconds: 1,
api_contacts_enabled: true
})
};
fetch('https://www.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://www.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' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'variable_mappings' => [
],
'from_phone_number' => '<string>',
'campaign_timezone' => 'America/Los_Angeles',
'scheduled_date' => '2023-12-25',
'scheduled_time' => '09:00',
'scheduled_timezone_input' => 'America/Los_Angeles',
'working_hours' => [
'weekly' => [
'monday' => [
[
'start' => '09:00',
'end' => '17:00'
]
],
'tuesday' => [
[
'start' => '09:00',
'end' => '17:00'
]
],
'wednesday' => [
[
'start' => '09:00',
'end' => '17:00'
]
],
'thursday' => [
[
'start' => '09:00',
'end' => '17:00'
]
],
'friday' => [
[
'start' => '09:00',
'end' => '17:00'
]
],
'saturday' => [
[
'start' => '09:00',
'end' => '17:00'
]
],
'sunday' => [
[
'start' => '09:00',
'end' => '17:00'
]
]
]
],
'working_hours_timezone' => 'America/New_York',
'workflow_config' => [
'retryOutcomes' => [
'CALLEE_DID_NOT_PICKUP',
'VOICE_MAIL'
],
'attempts' => [
[
'day' => 0,
'startTime' => '00:00',
'doubleDial' => false
],
[
'day' => 1,
'startTime' => '16:00',
'doubleDial' => true
],
[
'day' => 3,
'startTime' => '10:00',
'doubleDial' => false
]
],
'timezone' => 'America/Los_Angeles'
],
'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://www.agentcallback.com/api/campaigns"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"script_id\": \"<string>\",\n \"description\": \"<string>\",\n \"file_upload_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variable_mappings\": {},\n \"from_phone_number\": \"<string>\",\n \"campaign_timezone\": \"America/Los_Angeles\",\n \"scheduled_date\": \"2023-12-25\",\n \"scheduled_time\": \"09:00\",\n \"scheduled_timezone_input\": \"America/Los_Angeles\",\n \"working_hours\": {\n \"weekly\": {\n \"monday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"sunday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ]\n }\n },\n \"working_hours_timezone\": \"America/New_York\",\n \"workflow_config\": {\n \"retryOutcomes\": [\n \"CALLEE_DID_NOT_PICKUP\",\n \"VOICE_MAIL\"\n ],\n \"attempts\": [\n {\n \"day\": 0,\n \"startTime\": \"00:00\",\n \"doubleDial\": false\n },\n {\n \"day\": 1,\n \"startTime\": \"16:00\",\n \"doubleDial\": true\n },\n {\n \"day\": 3,\n \"startTime\": \"10:00\",\n \"doubleDial\": false\n }\n ],\n \"timezone\": \"America/Los_Angeles\"\n },\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://www.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\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variable_mappings\": {},\n \"from_phone_number\": \"<string>\",\n \"campaign_timezone\": \"America/Los_Angeles\",\n \"scheduled_date\": \"2023-12-25\",\n \"scheduled_time\": \"09:00\",\n \"scheduled_timezone_input\": \"America/Los_Angeles\",\n \"working_hours\": {\n \"weekly\": {\n \"monday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"sunday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ]\n }\n },\n \"working_hours_timezone\": \"America/New_York\",\n \"workflow_config\": {\n \"retryOutcomes\": [\n \"CALLEE_DID_NOT_PICKUP\",\n \"VOICE_MAIL\"\n ],\n \"attempts\": [\n {\n \"day\": 0,\n \"startTime\": \"00:00\",\n \"doubleDial\": false\n },\n {\n \"day\": 1,\n \"startTime\": \"16:00\",\n \"doubleDial\": true\n },\n {\n \"day\": 3,\n \"startTime\": \"10:00\",\n \"doubleDial\": false\n }\n ],\n \"timezone\": \"America/Los_Angeles\"\n },\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://www.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\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variable_mappings\": {},\n \"from_phone_number\": \"<string>\",\n \"campaign_timezone\": \"America/Los_Angeles\",\n \"scheduled_date\": \"2023-12-25\",\n \"scheduled_time\": \"09:00\",\n \"scheduled_timezone_input\": \"America/Los_Angeles\",\n \"working_hours\": {\n \"weekly\": {\n \"monday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ],\n \"sunday\": [\n {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n ]\n }\n },\n \"working_hours_timezone\": \"America/New_York\",\n \"workflow_config\": {\n \"retryOutcomes\": [\n \"CALLEE_DID_NOT_PICKUP\",\n \"VOICE_MAIL\"\n ],\n \"attempts\": [\n {\n \"day\": 0,\n \"startTime\": \"00:00\",\n \"doubleDial\": false\n },\n {\n \"day\": 1,\n \"startTime\": \"16:00\",\n \"doubleDial\": true\n },\n {\n \"day\": 3,\n \"startTime\": \"10:00\",\n \"doubleDial\": false\n }\n ],\n \"timezone\": \"America/Los_Angeles\"\n },\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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "<string>",
"script_id": "<string>",
"file_upload_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"api_contacts_enabled": true,
"campaign_timezone": "<string>",
"working_hours": {
"weekly": {
"monday": [
{
"start": "09:00",
"end": "17:00"
}
],
"tuesday": [
{
"start": "09:00",
"end": "17:00"
}
],
"wednesday": [
{
"start": "09:00",
"end": "17:00"
}
],
"thursday": [
{
"start": "09:00",
"end": "17:00"
}
],
"friday": [
{
"start": "09:00",
"end": "17:00"
}
],
"saturday": [
{
"start": "09:00",
"end": "17:00"
}
],
"sunday": [
{
"start": "09:00",
"end": "17:00"
}
]
}
},
"working_hours_timezone": "<string>",
"scheduled_start_time": "2023-11-07T05:31:56Z",
"scheduled_timezone": "<string>",
"workflow_config": {
"retryOutcomes": [
"CALLEE_DID_NOT_PICKUP",
"VOICE_MAIL"
],
"attempts": [
{
"day": 0,
"startTime": "00:00",
"doubleDial": false
},
{
"day": 1,
"startTime": "16:00",
"doubleDial": true
},
{
"day": 3,
"startTime": "10:00",
"doubleDial": false
}
],
"timezone": "America/Los_Angeles"
},
"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.
ID returned by POST /api/file-uploads.
Available options:
single, geographic, random Example:
"America/Los_Angeles"
Provide with scheduled_time to create a scheduled campaign; omit both to create a draft.
Provide with scheduled_date to create a scheduled campaign; omit both to create a draft.
Example:
"09:00"
Example:
"America/Los_Angeles"
Show child attributes
Show child attributes
Optional IANA override; otherwise uses campaign_timezone.
Example:
"America/New_York"
Optional multi-attempt workflow. When configured, it supersedes simple retry settings.
Show child attributes
Show child attributes
Example:
{
"retryOutcomes": ["CALLEE_DID_NOT_PICKUP", "VOICE_MAIL"],
"attempts": [
{
"day": 0,
"startTime": "00:00",
"doubleDial": false
},
{
"day": 1,
"startTime": "16:00",
"doubleDial": true
},
{
"day": 3,
"startTime": "10:00",
"doubleDial": false
}
],
"timezone": "America/Los_Angeles"
}
Required range:
1 <= x <= 6Required range:
x >= 0For outbound campaigns without a CSV. Start the campaign, then submit contacts through POST /api/make-calls with campaign_id.
⌘I