Create a Voice Broadcast

post

https://api.naxai.com/voice/broadcasts

Create a voice broadcast.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

The name of the Voice Broadcast.

type

string

enum

required

Defaults to default

The type of the broadcast.

Allowed:

from

string

required

The Phone Number to use when calling.

source

string

enum

required

Defaults to people

The recipient source.

Allowed:

segmentIds

array of uuids

length between 1 and 1

segmentIds

includeUnsubscribed

boolean

Indicates if the broadcast must be sent to unsubscribed people, default value is false). Mandatory when the source is people

file

object

The file used for broadcasting calls. Mandatory when the source is file.

scheduledAt

integer

Indicates when the broadcast should start in unix time, null if not scheduled

retries

integer

enum

required

Defaults to 0

The number of call retries to perform.

Allowed:

retryOnNoInput

boolean

required

Defaults to false

Indicate if retry must be performed when not getting the user input.

retryOnFailed

boolean

required

Defaults to false

Indicate if retry must be performed when call failed.

retryDelays

array of integers

required

length between 0 and 3

The delay to wait before retries in minutes (max 3 days = 4320 minutes), number of items must match retries.

retryDelays*

calendarId

uuid

The calendar to use, can be omitted, See Calendars to define Time Windows.

distribution

string

enum

Defaults to none

If a specific call distribution must be used.

Allowed:

dynamicName

string

The name of the dynamic load distribution for dynamic distribution.

allowDuplicates

boolean

If set to true, allow sending multiple calls to the same destination (when source is file).

actions

object

language

string

enum

Defaults to fr-BE

The default language to use when using Text To Speech.

Allowed:

voice

string

enum

Defaults to woman

The voice used for the Text To Speech.

Allowed:

voiceFlow

object

required

Headers

x-version

string

Defaults to 2023-03-25

The version of API, by default use the last version.

Responses

200A successful request returns the broadcast object.

401Unauthorized request. Make sure that you provided the right credentials.

404The Voice Broadcast does not exist with the given id.

422The request is invalid.

429Too Many Requests.