In-app Messages

deliverychannel

String

Yes

Specifies the channel to send a message.Real Time channel sends messages to enable mobile apps to provide App-Messaging.

It supports rich multimedia messages with text and optional multimedia items.

destination

JSONArray

Yes

The destination parameter is an array of up to 1,000 entries. Messages can be sent to single or multiple recipients in a single request. For more details, refer to destination array.

channels

JSONArray

Yes

For more details, refer to channels array.

message

JSONObject

No

The 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":"<Template ID>",      "parameters":{           "parameter1":"<value>",         "parameter2":"<value>",         "parameter3":"<value>"      },   }

Note: If you use message templates, then the parameter name should match with the parameter specified in the template. The parameters in this message block are overridden if a channel specific parameter block is also used.

expiry

String

No

Expiry 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.

correlationid

String

No

A client-side identifier chosen by the Service Provider to correlate requests and their subsequent responses. The correlationid can be up to 50 bytes long.

notifyurl

String

No

The 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.

For more information on notify URL formats, click Message Receipts.

callbackData

String

No

An identifier or data that will be sent alongside notifications to the notifyurl. This can serve as identifying notifications.

priority

String

No

This parameter is used to specify the message priority. The priority is defined while creating the client in the admin screen. All the services that are created under this client will have same priority. 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
  If any invalid option or text is passed, then the priority is set as configured while creating the client.

text

String

Yes

Specifies the message.

attachment

JSONObject

No

The attachments parameter is in itself an object parameter block for the following sub-parameters:

• contentType
• file
• preview
• size
• duration
• latitude
• longitude

For more information on attachment, see attachment.

contentType

String

Yes

MIME content type, such as image/jpg for JPEG images.

Supported content types:

• file

• image

• video

• audio

• location

title

String

Yes

Specifies the notification title.

text

String

Yes

Specifies the notification text.

android_extras

JSONObject

No

The following keys are available under android_extras:

• collapse_key
• sound
• iconurl
• customtag
  --imageurl
• notificationaction
  --action
  -- value

For detailed information, see Push:Android.

ios_extras

JSONObject

No

The following keys are available under ios_extras:

• attachmenturl
• collapse_key
• sound
• badge
• notificationaction
  -- action
  -- value

For detailed information, see
Push:iOS.

windows_extras

JSONObject

No

The following keys are available under windows_extras:

• logo
• sound
• image
• badge
• notificationaction
  -- action
  -- value

For detailed information, see
Push:Windows.

web_extras

JSONObject

No

The following keys are available under web_extras:

• collapsekey
• action
• url

For detailed information, see
Push:Web.

action

String

No

Following are the actions you can configure:

• OPEN_URL: Requires a URL as action value.
• OPEN_WEBVIEW: Requires a URL as action value.
• OPEN_HTML: Requires a html code to render as action value.
• DEEPLINK: Requires a deeplink URL as action value.
• OPEN_APP: Does not require an action value.

pushref

String

No

Define if the sender intends to use the message interaction result as a trigger for rules.

category

String

Yes

The category can be one of the following:

• SINGLE_DISMISS

• SINGLE_OPEN

• SINGLE_SUBSCRIBE

• SINGLE_UNSUBSCRIBE

• SINGLE_SHARE

• SINGLE_DEEPLINK

• SINGLE_REPLY

• DOUBLE_YES_NO

• DOUBLE_ACCEPT_CANCEL

• DOUBLE_SHARE_CANCEL

• DOUBLE_SHOPNOW_CANCEL

• DOUBLE_LATER_NOW

• DOUBLE_PLAY_NOW_PLAY_LATER

• DOUBLE_OK_LEARN_MORE

• DOUBLE_SUBSCRIBE_UNSUBSCRIBE

• DOUBLE_BUY_NOW_BUY_LATER

• DOUBLE_LIKE_SHARE

• DOUBLE_REPLY_DISMISS

• DOUBLE_REPLY_NO_DISMISS

• DOUBLE_REPLY_YES_DISMISS

• DOUBLE_REPLY_YES_NO

Where the option is prefixed with SINGLE, only one choice is available. In the case of DOUBLE, two choices are available. In either case the actions parameter depends on the parameter set for category.

actions

JSONArray

Yes

Using the actions parameter, interactive actions can be built.

The actions parameter is a parameter array block consisting of:

• pos

• action

• value

Note: Depending on the category choice, the outcome of the actions parameter varies.

pos

String

Yes

A numerical value that places the interactive element in the position specified.

action

String

Yes

Action to perform when interaction takes place, for instance:

• DISMISS

• OPEN_URL (Requires URL to be opened in value parameter)

• OPEN_APP

• DEEPLINK (Requires app page to be opened in value parameter)

• OPENWEBVIEW (Requires URL to be opened in value parameter)

• SHARE (Requires the content to be shared)

• TRIVIAL_REPLY

• INLINE_REPLY