REreteno
Messages

Search for App Inbox messages

The method is used to search for mobile App Inbox messages using a part of the name or a tag. <br/>The method returns a maximum of 500 messages per request.<br/>The <b>TotalCount</b> header contains the number of messages returned by the query.

get/api/v1/messages/appinbox

Request

Query parameters

searchstring

Search condition (a part of the message name or a tag)

startindexinteger
maxrowsinteger

Response

idinteger

Message ID.

namestring required

Message name.

languageCodestring

Language code.

tagsstring[]

List of tags.

subscriptionsKeysstring[]

Subscription categories keys, assigned to a message.

languagesstring[]

An array with the language codes for multilingual messages. Available for the GET method only.

titlestring required

Message title.

textstring required

Message text.

linkstring

The link that will open after the click on the message body.

imageSourcestring

The logo image in JPEG, PNG or GIF format.

customDatastring

Additional parameters in JSON format to be used in the message.

ttlSecinteger

Time-to-live for the message, in seconds.

Example response

[
  {
    "title": "Account created",
    "text": "Thank you for signing up!",
    "link": "https://www.example.com",
    "ttlSec": 3600,
    "translations": [
      {
        "title": "Account created",
        "text": "Thank you for signing up!",
        "link": "https://www.example.com",
        "ttlSec": 3600
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 2 revisions of this API.