Campaigns
Create campaign
Create an outbound calling campaign.
POST
/
v1
/
calls
/
campaigns
Create campaign
curl --request POST \
--url https://api.persistence.dev/v1/calls/campaigns \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"agentId": "<string>",
"contactListIds": [
"<string>"
],
"fromNumber": "<string>",
"maxConcurrency": 2,
"name": "<string>",
"dndListIds": [
"<string>"
],
"numberPoolId": "<string>",
"retryPolicy": {},
"scheduleEnd": "<string>",
"scheduleStart": "<string>",
"scheduledAt": "2023-11-07T05:31:56Z",
"sendNow": true,
"timezone": "<string>"
}
'import requests
url = "https://api.persistence.dev/v1/calls/campaigns"
payload = {
"agentId": "<string>",
"contactListIds": ["<string>"],
"fromNumber": "<string>",
"maxConcurrency": 2,
"name": "<string>",
"dndListIds": ["<string>"],
"numberPoolId": "<string>",
"retryPolicy": {},
"scheduleEnd": "<string>",
"scheduleStart": "<string>",
"scheduledAt": "2023-11-07T05:31:56Z",
"sendNow": True,
"timezone": "<string>"
}
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({
agentId: '<string>',
contactListIds: ['<string>'],
fromNumber: '<string>',
maxConcurrency: 2,
name: '<string>',
dndListIds: ['<string>'],
numberPoolId: '<string>',
retryPolicy: {},
scheduleEnd: '<string>',
scheduleStart: '<string>',
scheduledAt: '2023-11-07T05:31:56Z',
sendNow: true,
timezone: '<string>'
})
};
fetch('https://api.persistence.dev/v1/calls/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.persistence.dev/v1/calls/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([
'agentId' => '<string>',
'contactListIds' => [
'<string>'
],
'fromNumber' => '<string>',
'maxConcurrency' => 2,
'name' => '<string>',
'dndListIds' => [
'<string>'
],
'numberPoolId' => '<string>',
'retryPolicy' => [
],
'scheduleEnd' => '<string>',
'scheduleStart' => '<string>',
'scheduledAt' => '2023-11-07T05:31:56Z',
'sendNow' => true,
'timezone' => '<string>'
]),
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://api.persistence.dev/v1/calls/campaigns"
payload := strings.NewReader("{\n \"agentId\": \"<string>\",\n \"contactListIds\": [\n \"<string>\"\n ],\n \"fromNumber\": \"<string>\",\n \"maxConcurrency\": 2,\n \"name\": \"<string>\",\n \"dndListIds\": [\n \"<string>\"\n ],\n \"numberPoolId\": \"<string>\",\n \"retryPolicy\": {},\n \"scheduleEnd\": \"<string>\",\n \"scheduleStart\": \"<string>\",\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"sendNow\": true,\n \"timezone\": \"<string>\"\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://api.persistence.dev/v1/calls/campaigns")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agentId\": \"<string>\",\n \"contactListIds\": [\n \"<string>\"\n ],\n \"fromNumber\": \"<string>\",\n \"maxConcurrency\": 2,\n \"name\": \"<string>\",\n \"dndListIds\": [\n \"<string>\"\n ],\n \"numberPoolId\": \"<string>\",\n \"retryPolicy\": {},\n \"scheduleEnd\": \"<string>\",\n \"scheduleStart\": \"<string>\",\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"sendNow\": true,\n \"timezone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.persistence.dev/v1/calls/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 \"agentId\": \"<string>\",\n \"contactListIds\": [\n \"<string>\"\n ],\n \"fromNumber\": \"<string>\",\n \"maxConcurrency\": 2,\n \"name\": \"<string>\",\n \"dndListIds\": [\n \"<string>\"\n ],\n \"numberPoolId\": \"<string>\",\n \"retryPolicy\": {},\n \"scheduleEnd\": \"<string>\",\n \"scheduleStart\": \"<string>\",\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"sendNow\": true,\n \"timezone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"agentId": "<string>",
"cancelledAt": "<string>",
"createdAt": "<string>",
"description": "<string>",
"direction": "<string>",
"endDate": "<string>",
"fromNumber": "<string>",
"id": "<string>",
"lists": [
{
"id": "<string>",
"role": "<string>"
}
],
"maxConcurrency": 123,
"meta": {
"failure": {
"reason": "<string>"
}
},
"name": "<string>",
"pausedAt": "<string>",
"resumedAt": "<string>",
"retryPolicy": [
123
],
"scheduleEnd": 123,
"scheduleStart": 123,
"scheduledAt": "<string>",
"startDate": "<string>",
"status": "<string>",
"stoppedAt": "<string>",
"targetCallCount": 123,
"targetConversionRate": 123,
"timezone": "<string>",
"totalContacts": 123,
"updatedAt": "<string>"
},
"success": true
}{
"code": "<string>",
"error": "<string>"
}{
"code": "<string>",
"error": "<string>"
}{
"code": "<string>",
"error": "<string>"
}{
"code": "<string>",
"error": "<string>"
}Authorizations
API key issued for your workspace.
Body
application/json
Campaign creation request
- Option 1
- Option 2
Minimum array length:
1Caller phone number in E.164 format. Mutually exclusive with numberPoolId.
Required range:
x >= 1Number pool used for caller ID rotation. Mutually exclusive with fromNumber.
Pattern:
^(?:[01][0-9]|2[0-3]):[0-5][0-9]$Pattern:
^(?:[01][0-9]|2[0-3]):[0-5][0-9]$⌘I
Create campaign
curl --request POST \
--url https://api.persistence.dev/v1/calls/campaigns \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"agentId": "<string>",
"contactListIds": [
"<string>"
],
"fromNumber": "<string>",
"maxConcurrency": 2,
"name": "<string>",
"dndListIds": [
"<string>"
],
"numberPoolId": "<string>",
"retryPolicy": {},
"scheduleEnd": "<string>",
"scheduleStart": "<string>",
"scheduledAt": "2023-11-07T05:31:56Z",
"sendNow": true,
"timezone": "<string>"
}
'import requests
url = "https://api.persistence.dev/v1/calls/campaigns"
payload = {
"agentId": "<string>",
"contactListIds": ["<string>"],
"fromNumber": "<string>",
"maxConcurrency": 2,
"name": "<string>",
"dndListIds": ["<string>"],
"numberPoolId": "<string>",
"retryPolicy": {},
"scheduleEnd": "<string>",
"scheduleStart": "<string>",
"scheduledAt": "2023-11-07T05:31:56Z",
"sendNow": True,
"timezone": "<string>"
}
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({
agentId: '<string>',
contactListIds: ['<string>'],
fromNumber: '<string>',
maxConcurrency: 2,
name: '<string>',
dndListIds: ['<string>'],
numberPoolId: '<string>',
retryPolicy: {},
scheduleEnd: '<string>',
scheduleStart: '<string>',
scheduledAt: '2023-11-07T05:31:56Z',
sendNow: true,
timezone: '<string>'
})
};
fetch('https://api.persistence.dev/v1/calls/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.persistence.dev/v1/calls/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([
'agentId' => '<string>',
'contactListIds' => [
'<string>'
],
'fromNumber' => '<string>',
'maxConcurrency' => 2,
'name' => '<string>',
'dndListIds' => [
'<string>'
],
'numberPoolId' => '<string>',
'retryPolicy' => [
],
'scheduleEnd' => '<string>',
'scheduleStart' => '<string>',
'scheduledAt' => '2023-11-07T05:31:56Z',
'sendNow' => true,
'timezone' => '<string>'
]),
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://api.persistence.dev/v1/calls/campaigns"
payload := strings.NewReader("{\n \"agentId\": \"<string>\",\n \"contactListIds\": [\n \"<string>\"\n ],\n \"fromNumber\": \"<string>\",\n \"maxConcurrency\": 2,\n \"name\": \"<string>\",\n \"dndListIds\": [\n \"<string>\"\n ],\n \"numberPoolId\": \"<string>\",\n \"retryPolicy\": {},\n \"scheduleEnd\": \"<string>\",\n \"scheduleStart\": \"<string>\",\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"sendNow\": true,\n \"timezone\": \"<string>\"\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://api.persistence.dev/v1/calls/campaigns")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agentId\": \"<string>\",\n \"contactListIds\": [\n \"<string>\"\n ],\n \"fromNumber\": \"<string>\",\n \"maxConcurrency\": 2,\n \"name\": \"<string>\",\n \"dndListIds\": [\n \"<string>\"\n ],\n \"numberPoolId\": \"<string>\",\n \"retryPolicy\": {},\n \"scheduleEnd\": \"<string>\",\n \"scheduleStart\": \"<string>\",\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"sendNow\": true,\n \"timezone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.persistence.dev/v1/calls/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 \"agentId\": \"<string>\",\n \"contactListIds\": [\n \"<string>\"\n ],\n \"fromNumber\": \"<string>\",\n \"maxConcurrency\": 2,\n \"name\": \"<string>\",\n \"dndListIds\": [\n \"<string>\"\n ],\n \"numberPoolId\": \"<string>\",\n \"retryPolicy\": {},\n \"scheduleEnd\": \"<string>\",\n \"scheduleStart\": \"<string>\",\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"sendNow\": true,\n \"timezone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"agentId": "<string>",
"cancelledAt": "<string>",
"createdAt": "<string>",
"description": "<string>",
"direction": "<string>",
"endDate": "<string>",
"fromNumber": "<string>",
"id": "<string>",
"lists": [
{
"id": "<string>",
"role": "<string>"
}
],
"maxConcurrency": 123,
"meta": {
"failure": {
"reason": "<string>"
}
},
"name": "<string>",
"pausedAt": "<string>",
"resumedAt": "<string>",
"retryPolicy": [
123
],
"scheduleEnd": 123,
"scheduleStart": 123,
"scheduledAt": "<string>",
"startDate": "<string>",
"status": "<string>",
"stoppedAt": "<string>",
"targetCallCount": 123,
"targetConversionRate": 123,
"timezone": "<string>",
"totalContacts": 123,
"updatedAt": "<string>"
},
"success": true
}{
"code": "<string>",
"error": "<string>"
}{
"code": "<string>",
"error": "<string>"
}{
"code": "<string>",
"error": "<string>"
}{
"code": "<string>",
"error": "<string>"
}