This API allows you to send binary SMS messages, which can be used for sending encoded data, such as ringtones, WAP push messages, or binary data.

Request Headers

HeaderTypeDescriptionRequired
Content-TypestringMust be "application/json".Yes
AuthorizationstringAPI key for authentication (Bearer <your_api_key>).Yes

Request Body

Root Object

FieldTypeDescriptionRequired
bulkIdstringUnique identifier for the bulk request.No
messagesarray<object>List of binary SMS messages to be sent.Yes

messages (Array of Objects)

FieldTypeDescriptionRequired
binaryobjectEncoded binary message data.Yes
callbackDatastringData sent in the delivery report callback.No
destinationsarray<object>List of message recipients.Yes
fromstringSender name or number.Yes
intermediateReportbooleanWhether intermediate delivery reports should be sent.No
notifyContentTypestringContent type for notifications.No
notifyUrlstringURL for delivery report callbacks.No
validityPeriodintegerMessage validity period in minutes.No
campaignReferenceIdstringIdentifier for a campaign-related message.No
sendAtstring (ISO 8601)Scheduled time for sending the message.No
deliveryTimeWindowobjectSpecifies time restrictions for message delivery.No

binary Object

FieldTypeDescriptionRequired
dataCodingintegerData encoding scheme (e.g., 0 for default GSM encoding).Yes
esmClassintegerMessaging mode and type (e.g., 0 for default).Yes
hexstringEncoded binary data in hexadecimal format.Yes

destinations (Array of Objects)

FieldTypeDescriptionRequired
messageIdstringUnique identifier for the message.No
tostringRecipient phone number in international format.Yes

deliveryTimeWindow Object

FieldTypeDescriptionRequired
daysarray<string>List of allowed delivery days (e.g., "MONDAY", "TUESDAY").Yes
fromobjectStart time for delivery window.Yes
toobjectEnd time for delivery window.Yes

from / to Objects (Inside deliveryTimeWindow)

FieldTypeDescriptionRequired
hourintegerHour of the day (0-23).Yes
minuteintegerMinute of the hour (0-59).Yes
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!