Create a new broadcast
curl --request POST \
--url https://agents.nineteen58.co.za/public-api/broadcasts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"voice_id": "<string>",
"contact_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"schedule_config": {
"timezoneAsInteger": 123,
"start_hour": 11,
"end_hour": 11,
"days_of_week": [
"<string>"
],
"interval": 3
},
"first_sentence": "<string>",
"name": "<string>",
"description": "<string>",
"test": true
}
'import requests
url = "https://agents.nineteen58.co.za/public-api/broadcasts"
payload = {
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"voice_id": "<string>",
"contact_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"schedule_config": {
"timezoneAsInteger": 123,
"start_hour": 11,
"end_hour": 11,
"days_of_week": ["<string>"],
"interval": 3
},
"first_sentence": "<string>",
"name": "<string>",
"description": "<string>",
"test": 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({
agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
prompt_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
voice_id: '<string>',
contact_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
schedule_config: {
timezoneAsInteger: 123,
start_hour: 11,
end_hour: 11,
days_of_week: ['<string>'],
interval: 3
},
first_sentence: '<string>',
name: '<string>',
description: '<string>',
test: true
})
};
fetch('https://agents.nineteen58.co.za/public-api/broadcasts', 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://agents.nineteen58.co.za/public-api/broadcasts",
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([
'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'prompt_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'voice_id' => '<string>',
'contact_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'schedule_config' => [
'timezoneAsInteger' => 123,
'start_hour' => 11,
'end_hour' => 11,
'days_of_week' => [
'<string>'
],
'interval' => 3
],
'first_sentence' => '<string>',
'name' => '<string>',
'description' => '<string>',
'test' => 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://agents.nineteen58.co.za/public-api/broadcasts"
payload := strings.NewReader("{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prompt_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"voice_id\": \"<string>\",\n \"contact_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"schedule_config\": {\n \"timezoneAsInteger\": 123,\n \"start_hour\": 11,\n \"end_hour\": 11,\n \"days_of_week\": [\n \"<string>\"\n ],\n \"interval\": 3\n },\n \"first_sentence\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"test\": 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://agents.nineteen58.co.za/public-api/broadcasts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prompt_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"voice_id\": \"<string>\",\n \"contact_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"schedule_config\": {\n \"timezoneAsInteger\": 123,\n \"start_hour\": 11,\n \"end_hour\": 11,\n \"days_of_week\": [\n \"<string>\"\n ],\n \"interval\": 3\n },\n \"first_sentence\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"test\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://agents.nineteen58.co.za/public-api/broadcasts")
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 \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prompt_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"voice_id\": \"<string>\",\n \"contact_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"schedule_config\": {\n \"timezoneAsInteger\": 123,\n \"start_hour\": 11,\n \"end_hour\": 11,\n \"days_of_week\": [\n \"<string>\"\n ],\n \"interval\": 3\n },\n \"first_sentence\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"test\": true\n}"
response = http.request(request)
puts response.read_body{
"schedule": {
"schedule": [
{
"contactPhoneNumber": "<string>",
"scheduledTime": "2023-11-07T05:31:56Z"
}
]
}
}Broadcasts
Create Broadcast
Creates a new broadcast campaign
POST
/
public-api
/
broadcasts
Create a new broadcast
curl --request POST \
--url https://agents.nineteen58.co.za/public-api/broadcasts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"voice_id": "<string>",
"contact_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"schedule_config": {
"timezoneAsInteger": 123,
"start_hour": 11,
"end_hour": 11,
"days_of_week": [
"<string>"
],
"interval": 3
},
"first_sentence": "<string>",
"name": "<string>",
"description": "<string>",
"test": true
}
'import requests
url = "https://agents.nineteen58.co.za/public-api/broadcasts"
payload = {
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"voice_id": "<string>",
"contact_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"schedule_config": {
"timezoneAsInteger": 123,
"start_hour": 11,
"end_hour": 11,
"days_of_week": ["<string>"],
"interval": 3
},
"first_sentence": "<string>",
"name": "<string>",
"description": "<string>",
"test": 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({
agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
prompt_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
voice_id: '<string>',
contact_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
schedule_config: {
timezoneAsInteger: 123,
start_hour: 11,
end_hour: 11,
days_of_week: ['<string>'],
interval: 3
},
first_sentence: '<string>',
name: '<string>',
description: '<string>',
test: true
})
};
fetch('https://agents.nineteen58.co.za/public-api/broadcasts', 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://agents.nineteen58.co.za/public-api/broadcasts",
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([
'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'prompt_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'voice_id' => '<string>',
'contact_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'schedule_config' => [
'timezoneAsInteger' => 123,
'start_hour' => 11,
'end_hour' => 11,
'days_of_week' => [
'<string>'
],
'interval' => 3
],
'first_sentence' => '<string>',
'name' => '<string>',
'description' => '<string>',
'test' => 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://agents.nineteen58.co.za/public-api/broadcasts"
payload := strings.NewReader("{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prompt_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"voice_id\": \"<string>\",\n \"contact_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"schedule_config\": {\n \"timezoneAsInteger\": 123,\n \"start_hour\": 11,\n \"end_hour\": 11,\n \"days_of_week\": [\n \"<string>\"\n ],\n \"interval\": 3\n },\n \"first_sentence\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"test\": 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://agents.nineteen58.co.za/public-api/broadcasts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prompt_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"voice_id\": \"<string>\",\n \"contact_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"schedule_config\": {\n \"timezoneAsInteger\": 123,\n \"start_hour\": 11,\n \"end_hour\": 11,\n \"days_of_week\": [\n \"<string>\"\n ],\n \"interval\": 3\n },\n \"first_sentence\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"test\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://agents.nineteen58.co.za/public-api/broadcasts")
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 \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prompt_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"voice_id\": \"<string>\",\n \"contact_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"schedule_config\": {\n \"timezoneAsInteger\": 123,\n \"start_hour\": 11,\n \"end_hour\": 11,\n \"days_of_week\": [\n \"<string>\"\n ],\n \"interval\": 3\n },\n \"first_sentence\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"test\": true\n}"
response = http.request(request)
puts response.read_body{
"schedule": {
"schedule": [
{
"contactPhoneNumber": "<string>",
"scheduledTime": "2023-11-07T05:31:56Z"
}
]
}
}Authorizations
Body
application/json
ID of the agent to use for the broadcast
Communication channel for the broadcast
Available options:
phone, advanced-voice ID of the prompt to use for the broadcast
ID of the voice to use for the broadcast
Array of contact IDs to include in the broadcast
Show child attributes
Show child attributes
First sentence the agent will say
Name of the broadcast
Description of the broadcast
Whether this is a test broadcast
Response
Broadcast created successfully
Show child attributes
Show child attributes
⌘I

