An array of message objects of a single message or multiple messages sent under one bulk ID.
Array
sender
required
string
The sender ID. It can be alphanumeric or numeric (e.g., CompanyName). Make sure you don't exceed character limit.
destinations
required
Array of objects
An array of destination objects for where messages are being sent. A valid destination is required.
Array
to
required
string
The destination address of the message.
messageId
string [ 0 .. 200 ] characters
The ID that uniquely identifies the message sent.
content
required
object
Message content.
type
string
TEXT
text
required
string [ 0 .. 1000 ] characters
options
object
Message options.
platform
object
Platform options. For more details, see documentation.
entityId
string [ 0 .. 255 ] characters
Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the documentation.
applicationId
string [ 0 .. 255 ] characters
Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the documentation.
validityPeriod
object
Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h.
amount
required
integer <int32>
Message validity period's value. If timeUnit is not set, it will default to MINUTES.
timeUnit
string
Default: "MINUTES"
Enum:"SECONDS""MINUTES""HOURS"
Message validity period time unit.
deliveryTimeWindow
object
Sets specific message delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent. The exact time of the day to start sending messages can be defined using the from property. The exact time of the day to end sending messages can be defined using the to property. Properties from and to should be both provided with the minimum 1 hour difference or omitted.
Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
from
object
The exact time of the day. The time is expressed in the UTC time zone.
hour
required
integer <int32> [ 0 .. 23 ]
Hour when the time window opens when used in the from property or closes when used in the to property.
minute
required
integer <int32> [ 0 .. 59 ]
Minute when the time window opens when used in the from property or closes when used in the to property.
to
object
The exact time of the day. The time is expressed in the UTC time zone.
hour
required
integer <int32> [ 0 .. 23 ]
Hour when the time window opens when used in the from property or closes when used in the to property.
minute
required
integer <int32> [ 0 .. 59 ]
Minute when the time window opens when used in the from property or closes when used in the to property.
campaignReferenceId
string [ 0 .. 255 ] characters
ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
webhooks
object
Provides options for configuring message webhooks.
delivery
object
Provides options for configuring the delivery report behavior.
url
string
The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the retry cycle uses the following formula: 1min + (1min * retryNumber * retryNumber).
intermediateReport
boolean
The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to false.
notify
boolean
Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to 'true' or not defined, your Subscription settings will apply.
contentType
string
Preferred delivery report content type, application/json or application/xml.
callbackData
string [ 0 .. 4000 ] characters
Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.
options
object
Options applicable to all messages in the request.
schedule
object
Options for scheduling a message.
bulkId
string [ 0 .. 100 ] characters
Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response.
sendAt
string <date-time>
Date and time when the message is to be sent. Used for scheduled messages. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ, and can only be scheduled for no later than 180 days in advance.
sendingSpeedLimit
object
Limits the send speed when sending messages in bulk to deliver messages over a longer period of time. You may wish to use this to allow your systems or agents to handle large amounts of incoming traffic, e.g., if you are expecting recipients to follow through with a call-to-action option from a message you sent. Not setting a send speed limit can overwhelm your resources with incoming traffic.
amount
required
integer <int32>
The number of messages to be sent per timeUnit. By default, the system sends messages as fast as the infrastructure allows. Use this parameter to adapt sending capacity to your needs. The system is only able to work against its maximum capacity for ambitious message batches.
timeUnit
string
Default: "MINUTE"
Enum:"MINUTE""HOUR""DAY"
The time unit to define when setting a messaging speed limit. Defaults to MINUTE.
Service status'%3E %3Cpath d='M11.9047 8.47667L19.3513 0H17.5873L11.1187 7.35867L5.956 0H0L7.80867 11.1287L0 20.0167H1.764L8.59067 12.244L14.044 20.0167H20M2.40067 1.30267H5.11067L17.586 18.778H14.8753' fill='%23424B5C'/%3E %3C/g%3E %3Cdefs%3E %3CclipPath id='clip0_3438_1744'%3E %3Crect width='20' height='20.0167' fill='white'/%3E %3C/clipPath%3E %3C/defs%3E %3C/svg%3E)
