Create Broadcast

post

https://elastic.messangi.me/thenightswatch/v2/broadcasts

This endpoint allows you to create a new Broadcast depending on the type of communication channel you want to send (SMS, WhatsApp, Email, RCS).Certain factors must be considered when you want to send Broadcasts:The Broadcast scheduler configures the Broadcast sending depending on the communication channel and the delivery date.The deliveryMethod parameter allows us to differentiate the type of communication channel between SMS, WhatsApp, Email or RCS. That's why only this endpoint is used for the creation of Broadcasts because the deliveryMethod help us to send each type of communication channel, but there are several variations in the request body depending on the delivery type.You can configure the broadcast delivery date through three different status:

Broadcast Status	Parameter	Value	Description
Now	`scheduleWithoutDate`	`false`	Broadcast is sent at the moment.
Scheduled	`broadcastDate`	UTC Zulu format date	Broadcast is scheduled to be sent later.
Pending	`scheduleWithoutDate`	`true`	Indicates that Broadcast does not have a set delivery Date

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

deliveryMethod

string

enum

delivery method must be SMS

Allowed:

campaignName

string

broadcast campaign name

description

string

length ≤ 512

broadcast campaign description

listId

int32

list ID used in broadcast campaign

listField

string

field from list used in broadcast campaign

filters

string

filters in URLEncode format, applied to the list used in the broadcast campaign

filterName

string

filter name

segmentId

string

segment id

message

string

broadcast campaign description

origin

string

shortcode used to address the broadcast messages

broadcastDate

date-time

broadcast campaign date in UTC in case of schedule broadcast

scheduleWithoutDate

boolean

flag to trigger now (false) or create a pending broadcast (true)

throttle

int32

throttle rate

callbacks

array of strings

callbacks list

callbacks

emailField

string

list email field - data used in BigQuery reports

clientId

string

client Id field - user additional field to be used in BigQuery reports

fallback

object

Configuration to trigger the fallback mechanism

requestDR

boolean

enable delivery receipts: set this value to true if you want to receive DRs for messages

Responses

201Broadcast creation request accepted

400bad request

401unauthorized: malformed jwt

410gone: expired jwt

412a precondition is not met

500internal server error