API Reference

Create a Voice Broadcast

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

Create a voice broadcast.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The name of the Voice Broadcast.

string
required

The Phone Number to use when calling.

string
enum
required
Defaults to people

The recipient source.

Allowed:
segmentIds
array of uuids
required
length between 1 and 1
segmentIds*

The segment to use for broadcasting message.

boolean
required

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

file
object
string
enum
required
Defaults to fr-BE

The default language to use when using Text To Speech.

Allowed:
string
enum
required
Defaults to woman

The voice used for the Text To Speech.

Allowed:
string

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

integer
enum
required
Defaults to 0

The number of call retries to perform.

Allowed:
boolean
required
Defaults to false

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

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*
uuid

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

string
enum
required
Defaults to none

If a specific call distribution must be used.

Allowed:
string

The name of the dynamic load distribution for dynamic distribution.

voiceFlow
object
actions
object
Headers
string
Defaults to 2023-03-25

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

Responses

Updated 8 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago