Skip to main content
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",
  "channel": "phone",
  "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
}
'
{
  "schedule": {
    "schedule": [
      {
        "contactPhoneNumber": "<string>",
        "scheduledTime": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://agent-docs.nineteen58.co.za/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
agent_id
string<uuid>
required

ID of the agent to use for the broadcast

​
channel
enum<string>
required

Communication channel for the broadcast

Available options:
phone,
advanced-voice
​
prompt_id
string<uuid>
required

ID of the prompt to use for the broadcast

​
voice_id
string
required

ID of the voice to use for the broadcast

​
contact_ids
string<uuid>[]
required

Array of contact IDs to include in the broadcast

​
schedule_config
object
required
​
first_sentence
string

First sentence the agent will say

​
name
string

Name of the broadcast

​
description
string

Description of the broadcast

​
test
boolean

Whether this is a test broadcast

Response

Broadcast created successfully

​
schedule
object