Create Batch Job
curl --request POST \
--url https://api.vogent.ai/api/batch_dial_jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"callAgentId": "<string>",
"maxConcurrentDials": 123,
"name": "<string>",
"rows": [
{
"toNumber": "<string>",
"inputs": {}
}
],
"fromPhoneNumberIds": [
"<string>"
],
"schedule": {
"days": [
{
"dayOfWeek": 123,
"timeSlots": [
{
"startTime": "<string>",
"endTime": "<string>"
}
]
}
],
"timezone": "<string>",
"disableSchedule": true
}
}
'import requests
url = "https://api.vogent.ai/api/batch_dial_jobs"
payload = {
"callAgentId": "<string>",
"maxConcurrentDials": 123,
"name": "<string>",
"rows": [
{
"toNumber": "<string>",
"inputs": {}
}
],
"fromPhoneNumberIds": ["<string>"],
"schedule": {
"days": [
{
"dayOfWeek": 123,
"timeSlots": [
{
"startTime": "<string>",
"endTime": "<string>"
}
]
}
],
"timezone": "<string>",
"disableSchedule": True
}
}
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({
callAgentId: '<string>',
maxConcurrentDials: 123,
name: '<string>',
rows: [{toNumber: '<string>', inputs: {}}],
fromPhoneNumberIds: ['<string>'],
schedule: {
days: [{dayOfWeek: 123, timeSlots: [{startTime: '<string>', endTime: '<string>'}]}],
timezone: '<string>',
disableSchedule: true
}
})
};
fetch('https://api.vogent.ai/api/batch_dial_jobs', 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.vogent.ai/api/batch_dial_jobs",
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([
'callAgentId' => '<string>',
'maxConcurrentDials' => 123,
'name' => '<string>',
'rows' => [
[
'toNumber' => '<string>',
'inputs' => [
]
]
],
'fromPhoneNumberIds' => [
'<string>'
],
'schedule' => [
'days' => [
[
'dayOfWeek' => 123,
'timeSlots' => [
[
'startTime' => '<string>',
'endTime' => '<string>'
]
]
]
],
'timezone' => '<string>',
'disableSchedule' => true
]
]),
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.vogent.ai/api/batch_dial_jobs"
payload := strings.NewReader("{\n \"callAgentId\": \"<string>\",\n \"maxConcurrentDials\": 123,\n \"name\": \"<string>\",\n \"rows\": [\n {\n \"toNumber\": \"<string>\",\n \"inputs\": {}\n }\n ],\n \"fromPhoneNumberIds\": [\n \"<string>\"\n ],\n \"schedule\": {\n \"days\": [\n {\n \"dayOfWeek\": 123,\n \"timeSlots\": [\n {\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n }\n ],\n \"timezone\": \"<string>\",\n \"disableSchedule\": true\n }\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.vogent.ai/api/batch_dial_jobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"callAgentId\": \"<string>\",\n \"maxConcurrentDials\": 123,\n \"name\": \"<string>\",\n \"rows\": [\n {\n \"toNumber\": \"<string>\",\n \"inputs\": {}\n }\n ],\n \"fromPhoneNumberIds\": [\n \"<string>\"\n ],\n \"schedule\": {\n \"days\": [\n {\n \"dayOfWeek\": 123,\n \"timeSlots\": [\n {\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n }\n ],\n \"timezone\": \"<string>\",\n \"disableSchedule\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vogent.ai/api/batch_dial_jobs")
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 \"callAgentId\": \"<string>\",\n \"maxConcurrentDials\": 123,\n \"name\": \"<string>\",\n \"rows\": [\n {\n \"toNumber\": \"<string>\",\n \"inputs\": {}\n }\n ],\n \"fromPhoneNumberIds\": [\n \"<string>\"\n ],\n \"schedule\": {\n \"days\": [\n {\n \"dayOfWeek\": 123,\n \"timeSlots\": [\n {\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n }\n ],\n \"timezone\": \"<string>\",\n \"disableSchedule\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"maxConcurrentDials": 123,
"name": "<string>",
"callAgentId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"fromPhoneNumberIds": [
"<string>"
],
"schedule": {
"days": [
{
"dayOfWeek": 123,
"timeSlots": [
{
"startTime": "<string>",
"endTime": "<string>"
}
]
}
],
"timezone": "<string>"
}
}Batch Dials
Create Batch Job
Creates a new batch dial job. You must start the job with the /paused endpoint for calls to begin.
POST
/
batch_dial_jobs
Create Batch Job
curl --request POST \
--url https://api.vogent.ai/api/batch_dial_jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"callAgentId": "<string>",
"maxConcurrentDials": 123,
"name": "<string>",
"rows": [
{
"toNumber": "<string>",
"inputs": {}
}
],
"fromPhoneNumberIds": [
"<string>"
],
"schedule": {
"days": [
{
"dayOfWeek": 123,
"timeSlots": [
{
"startTime": "<string>",
"endTime": "<string>"
}
]
}
],
"timezone": "<string>",
"disableSchedule": true
}
}
'import requests
url = "https://api.vogent.ai/api/batch_dial_jobs"
payload = {
"callAgentId": "<string>",
"maxConcurrentDials": 123,
"name": "<string>",
"rows": [
{
"toNumber": "<string>",
"inputs": {}
}
],
"fromPhoneNumberIds": ["<string>"],
"schedule": {
"days": [
{
"dayOfWeek": 123,
"timeSlots": [
{
"startTime": "<string>",
"endTime": "<string>"
}
]
}
],
"timezone": "<string>",
"disableSchedule": True
}
}
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({
callAgentId: '<string>',
maxConcurrentDials: 123,
name: '<string>',
rows: [{toNumber: '<string>', inputs: {}}],
fromPhoneNumberIds: ['<string>'],
schedule: {
days: [{dayOfWeek: 123, timeSlots: [{startTime: '<string>', endTime: '<string>'}]}],
timezone: '<string>',
disableSchedule: true
}
})
};
fetch('https://api.vogent.ai/api/batch_dial_jobs', 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.vogent.ai/api/batch_dial_jobs",
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([
'callAgentId' => '<string>',
'maxConcurrentDials' => 123,
'name' => '<string>',
'rows' => [
[
'toNumber' => '<string>',
'inputs' => [
]
]
],
'fromPhoneNumberIds' => [
'<string>'
],
'schedule' => [
'days' => [
[
'dayOfWeek' => 123,
'timeSlots' => [
[
'startTime' => '<string>',
'endTime' => '<string>'
]
]
]
],
'timezone' => '<string>',
'disableSchedule' => true
]
]),
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.vogent.ai/api/batch_dial_jobs"
payload := strings.NewReader("{\n \"callAgentId\": \"<string>\",\n \"maxConcurrentDials\": 123,\n \"name\": \"<string>\",\n \"rows\": [\n {\n \"toNumber\": \"<string>\",\n \"inputs\": {}\n }\n ],\n \"fromPhoneNumberIds\": [\n \"<string>\"\n ],\n \"schedule\": {\n \"days\": [\n {\n \"dayOfWeek\": 123,\n \"timeSlots\": [\n {\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n }\n ],\n \"timezone\": \"<string>\",\n \"disableSchedule\": true\n }\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.vogent.ai/api/batch_dial_jobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"callAgentId\": \"<string>\",\n \"maxConcurrentDials\": 123,\n \"name\": \"<string>\",\n \"rows\": [\n {\n \"toNumber\": \"<string>\",\n \"inputs\": {}\n }\n ],\n \"fromPhoneNumberIds\": [\n \"<string>\"\n ],\n \"schedule\": {\n \"days\": [\n {\n \"dayOfWeek\": 123,\n \"timeSlots\": [\n {\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n }\n ],\n \"timezone\": \"<string>\",\n \"disableSchedule\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vogent.ai/api/batch_dial_jobs")
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 \"callAgentId\": \"<string>\",\n \"maxConcurrentDials\": 123,\n \"name\": \"<string>\",\n \"rows\": [\n {\n \"toNumber\": \"<string>\",\n \"inputs\": {}\n }\n ],\n \"fromPhoneNumberIds\": [\n \"<string>\"\n ],\n \"schedule\": {\n \"days\": [\n {\n \"dayOfWeek\": 123,\n \"timeSlots\": [\n {\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n }\n ],\n \"timezone\": \"<string>\",\n \"disableSchedule\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"maxConcurrentDials": 123,
"name": "<string>",
"callAgentId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"fromPhoneNumberIds": [
"<string>"
],
"schedule": {
"days": [
{
"dayOfWeek": 123,
"timeSlots": [
{
"startTime": "<string>",
"endTime": "<string>"
}
]
}
],
"timezone": "<string>"
}
}Authorizations
In the form Bearer <api_key_here>. You can find your api key in your dashboard.
Body
application/json
Response
Successful operation
⌘I