Skip to content

Статус сообщения

Имея уникальный код сообщения, вы можете запросить список действий, совершенных с этим сообщением: отправки, клики, открытия, жалобы, отписки и пр.

GET https://api.rees46.ru/notifications/:code

Параметры

ПараметрОбязателен?Описание
codeДаУникальный код сообщения, вставляется прямо в часть пути запроса :code
typeДаТип сообщения: bulk, chain или transactional

Значение типа сообщения type вы получаете, например, при отправке транзакционного сообщения методом https://api.rees46.ru/transact.

Запрос

Пример запроса:

shell
curl 'https://api.rees46.ru/notifications/12345-em-1113376715979342-viwy7fig7fkgf8?type=bulk'

Ответ

TODO

Описать структуру элемента сообщения.

Пример ответа сервера:

json
{
  "status": "success",
  "payload": {
    "messages": [
      ...
    ]
  }
}

Расшифровка свойств ответа:

PropertyTypeDescription
statusStringТекстовый статус результата обработки запроса
payloadObjectОбъект с ответом
payload.messages[]ArrayМассив событий, связанных с кодом сообщения

В случае ошибки ответ будет в формате:

json
{
  "status": "error",
  "payload": {
    "message": "Invalid secret key"
  }
}