POST
Send bulk SMS messages

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Idempotency-Key
string

Body

application/json
messageType
enum<string>
required
Available options:
SMS,
FLASH,
BINARY,
WAP_PUSH,
UNICODE,
TRANSACTIONAL,
PROMOTIONAL,
OTP,
REMINDER,
TEXT,
TEMPLATE,
BULK,
MARKETING
callbackUrl
string
message
string
Maximum string length: 160
metadata
object
name
string
personalized
boolean
personalizedMessages
object[]
recipients
string[]
Minimum array length: 1
scheduledFor
string<date-time>
senderId
string
Minimum string length: 1
templateId
string

Response

SMS bulk request accepted

batchId
string
createdAt
string
duplicatesRemoved
integer<int32>
managementId
string
messageContent
string
name
string
originalRecipientsCount
integer<int32>
recipientCount
integer<int32>
scheduledFor
string
senderId
string
status
string
taskId
string
template
boolean
uniqueRecipientsCount
integer<int32>