Calls
Start outbound batch
Start or schedule a batch of outbound calls.
POST
/
v1
/
calls
/
batch
Start outbound batch
curl --request POST \
--url https://api.persistence.dev/v1/calls/batch \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"callerId": "<string>",
"recipients": [
{
"phoneNumber": "<string>",
"metadata": {},
"reason": "<string>"
}
],
"agentId": "<string>",
"maxConcurrency": 123,
"scheduledAt": "2023-11-07T05:31:56Z",
"scheduleStart": "09:30",
"scheduleEnd": "09:30",
"timezone": "<string>"
}
'import requests
url = "https://api.persistence.dev/v1/calls/batch"
payload = {
"callerId": "<string>",
"recipients": [
{
"phoneNumber": "<string>",
"metadata": {},
"reason": "<string>"
}
],
"agentId": "<string>",
"maxConcurrency": 123,
"scheduledAt": "2023-11-07T05:31:56Z",
"scheduleStart": "09:30",
"scheduleEnd": "09:30",
"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({
callerId: '<string>',
recipients: [{phoneNumber: '<string>', metadata: {}, reason: '<string>'}],
agentId: '<string>',
maxConcurrency: 123,
scheduledAt: '2023-11-07T05:31:56Z',
scheduleStart: '09:30',
scheduleEnd: '09:30',
timezone: '<string>'
})
};
fetch('https://api.persistence.dev/v1/calls/batch', 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/batch",
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([
'callerId' => '<string>',
'recipients' => [
[
'phoneNumber' => '<string>',
'metadata' => [
],
'reason' => '<string>'
]
],
'agentId' => '<string>',
'maxConcurrency' => 123,
'scheduledAt' => '2023-11-07T05:31:56Z',
'scheduleStart' => '09:30',
'scheduleEnd' => '09:30',
'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/batch"
payload := strings.NewReader("{\n \"callerId\": \"<string>\",\n \"recipients\": [\n {\n \"phoneNumber\": \"<string>\",\n \"metadata\": {},\n \"reason\": \"<string>\"\n }\n ],\n \"agentId\": \"<string>\",\n \"maxConcurrency\": 123,\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"scheduleStart\": \"09:30\",\n \"scheduleEnd\": \"09:30\",\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/batch")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"callerId\": \"<string>\",\n \"recipients\": [\n {\n \"phoneNumber\": \"<string>\",\n \"metadata\": {},\n \"reason\": \"<string>\"\n }\n ],\n \"agentId\": \"<string>\",\n \"maxConcurrency\": 123,\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"scheduleStart\": \"09:30\",\n \"scheduleEnd\": \"09:30\",\n \"timezone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.persistence.dev/v1/calls/batch")
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 \"callerId\": \"<string>\",\n \"recipients\": [\n {\n \"phoneNumber\": \"<string>\",\n \"metadata\": {},\n \"reason\": \"<string>\"\n }\n ],\n \"agentId\": \"<string>\",\n \"maxConcurrency\": 123,\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"scheduleStart\": \"09:30\",\n \"scheduleEnd\": \"09:30\",\n \"timezone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"status": "<string>",
"acceptedRecipients": 123,
"rejectedRecipients": [
{
"phoneNumber": "<string>",
"metadata": {},
"reason": "<string>"
}
],
"batchCallId": "<string>"
}
}{
"code": "<string>",
"error": "<string>"
}{
"code": "<string>",
"error": "<string>"
}{
"code": "<string>",
"error": "<string>"
}Authorizations
API key issued for the workspace.
Body
application/json
Phone number presented as caller ID.
Required array length:
1 - 1000 elementsShow child attributes
Show child attributes
Optional agent override. When omitted, the phone number's outbound agent is used.
Maximum calls processed concurrently.
Zero-padded HH:MM time in the selected timezone.
Pattern:
^(?:[01][0-9]|2[0-3]):[0-5][0-9]$Example:
"09:30"
Zero-padded HH:MM time in the selected timezone.
Pattern:
^(?:[01][0-9]|2[0-3]):[0-5][0-9]$Example:
"09:30"
IANA time zone used for the schedule.
⌘I
Start outbound batch
curl --request POST \
--url https://api.persistence.dev/v1/calls/batch \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"callerId": "<string>",
"recipients": [
{
"phoneNumber": "<string>",
"metadata": {},
"reason": "<string>"
}
],
"agentId": "<string>",
"maxConcurrency": 123,
"scheduledAt": "2023-11-07T05:31:56Z",
"scheduleStart": "09:30",
"scheduleEnd": "09:30",
"timezone": "<string>"
}
'import requests
url = "https://api.persistence.dev/v1/calls/batch"
payload = {
"callerId": "<string>",
"recipients": [
{
"phoneNumber": "<string>",
"metadata": {},
"reason": "<string>"
}
],
"agentId": "<string>",
"maxConcurrency": 123,
"scheduledAt": "2023-11-07T05:31:56Z",
"scheduleStart": "09:30",
"scheduleEnd": "09:30",
"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({
callerId: '<string>',
recipients: [{phoneNumber: '<string>', metadata: {}, reason: '<string>'}],
agentId: '<string>',
maxConcurrency: 123,
scheduledAt: '2023-11-07T05:31:56Z',
scheduleStart: '09:30',
scheduleEnd: '09:30',
timezone: '<string>'
})
};
fetch('https://api.persistence.dev/v1/calls/batch', 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/batch",
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([
'callerId' => '<string>',
'recipients' => [
[
'phoneNumber' => '<string>',
'metadata' => [
],
'reason' => '<string>'
]
],
'agentId' => '<string>',
'maxConcurrency' => 123,
'scheduledAt' => '2023-11-07T05:31:56Z',
'scheduleStart' => '09:30',
'scheduleEnd' => '09:30',
'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/batch"
payload := strings.NewReader("{\n \"callerId\": \"<string>\",\n \"recipients\": [\n {\n \"phoneNumber\": \"<string>\",\n \"metadata\": {},\n \"reason\": \"<string>\"\n }\n ],\n \"agentId\": \"<string>\",\n \"maxConcurrency\": 123,\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"scheduleStart\": \"09:30\",\n \"scheduleEnd\": \"09:30\",\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/batch")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"callerId\": \"<string>\",\n \"recipients\": [\n {\n \"phoneNumber\": \"<string>\",\n \"metadata\": {},\n \"reason\": \"<string>\"\n }\n ],\n \"agentId\": \"<string>\",\n \"maxConcurrency\": 123,\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"scheduleStart\": \"09:30\",\n \"scheduleEnd\": \"09:30\",\n \"timezone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.persistence.dev/v1/calls/batch")
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 \"callerId\": \"<string>\",\n \"recipients\": [\n {\n \"phoneNumber\": \"<string>\",\n \"metadata\": {},\n \"reason\": \"<string>\"\n }\n ],\n \"agentId\": \"<string>\",\n \"maxConcurrency\": 123,\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"scheduleStart\": \"09:30\",\n \"scheduleEnd\": \"09:30\",\n \"timezone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"status": "<string>",
"acceptedRecipients": 123,
"rejectedRecipients": [
{
"phoneNumber": "<string>",
"metadata": {},
"reason": "<string>"
}
],
"batchCallId": "<string>"
}
}{
"code": "<string>",
"error": "<string>"
}{
"code": "<string>",
"error": "<string>"
}{
"code": "<string>",
"error": "<string>"
}