An array of event objects of the events to be sent.
Array
content
object
Event content.
type
required
string
TYPING_INDICATOR
typingIndicatorType
required
string
Enum:"TYPING_START""TYPING_END"
Type of the indicator being sent
options
object
Event 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.
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 the event is 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.
options
object
Options applicable to all events 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)
