These docs are for v2023.08. Click to read the latest docs for v2023.12.

send message table

ParameterTypeMandatoryDescription
deliverychannelstringyes sms
voice
appmessaging
push
fb
twitter
wechat
whatsapp
* AppleMessagesforBusiness
correlationidstringnoA client-side identifier chosen by the Service Provider to correlate requests and their subsequent responses. The correlation-id can be up to 50 bytes long.
notifyurlstringnoThe imiconnect platform will send notifications to the URL specified in the notifyurl parameter. The URL is used to retrieve the status of the message sent. The notifyurl can also be configured while creating a service. If the URL is specified in both the service and the messaging API, preference will be given to the messaging API request.
callbackDataStringnoAn identifier or data that will be sent alongside notifications to the notifyurl. This can serve as identifying notifications.
expirystringnoExpiry time in UTC format, after which messages will not be pushed. For example, 2015-04-12T13:00:19.456Z or 2015-04-12T18:30:19.456+5:30.
prioritystringnoThis parameter is used to specify the message priority. The priority is defined while creating the client in the admin screen. Messages of equal priorities are delivered in the natural order of their arrival at their destinations. The options for this parameter are:

1 - low
2 - Medium
_ 3 - High

_API requests that contain invalid values in priority fields will be rejected.*
messageJSONObjectnoThe message parameter block references a template via the template ID which is created within the imiconnect platform.

The amount of sub-parameters in the parameters block depends on the number of parameters expected in the template. These parameters are supplied to the template for substitution in the final message.

"message":{
"template":"

©2023. Prime Industries, Services, and Trinkets LLC. We are not responsible