POST
Send a single message

Authorizations

Authorization
string
header
required

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

Body

application/json
content
string
Minimum string length: 1
messageType
enum<string>
Available options:
SMS,
FLASH,
BINARY,
WAP_PUSH,
UNICODE,
TRANSACTIONAL,
PROMOTIONAL,
OTP,
REMINDER,
TEXT,
TEMPLATE,
BULK,
MARKETING
phoneNumber
string
Minimum string length: 1
scheduledFor
string<date-time>
senderId
string
templateId
string

Response

200 - */*

OK

channel
enum<string>
Available options:
UI,
API,
EMAIL2SMS
completed
boolean
completedAt
string<date-time>
createdAt
string<date-time>
createdBy
string
deliveryType
enum<string>
Available options:
SINGLE,
BULK,
IMMEDIATE,
SCHEDULED
failureCount
integer<int64>
id
string
message
string
metadata
object
name
string
ownerId
string
ownerName
string
ownerType
string
recipient
string
recipients
string[]
scheduledFor
string<date-time>
senderId
string
status
enum<string>
Available options:
DRAFT,
SCHEDULED,
IN_PROGRESS,
COMPLETED,
FAILED,
PROCESSING,
PENDING,
PAUSED,
CANCELLED
successCount
integer<int64>
taskId
string
templateId
string
totalMessages
integer<int64>
type
enum<string>
Available options:
SMS,
FLASH,
BINARY,
WAP_PUSH,
UNICODE,
TRANSACTIONAL,
PROMOTIONAL,
OTP,
REMINDER,
TEXT,
TEMPLATE,
BULK,
MARKETING
updatedAt
string<date-time>
userId
string