Skip to content

Расширенный счетчик отправленных и прочитанных сообщений

Метод позволяет получить счетчик отправленных и прочитанных сообщений для центра уведомлений. Это расширенная версия метода notifications/counters, поддерживающая несколько каналов и типов рассылок в одном запросе.

GET https://api.rees46.ru/notifications/counters/extended

Параметры

ПараметрОбязателен?Описание
shop_idДаAPI-ключ
shop_secretДаСекретный API-ключ
did*ДаИдентификатор устройства
phone*ДаТелефон клиента
email*ДаEmail клиента
loyalty_id*ДаИдентификатор участника программы лояльности
external_id*ДаВнешний идентификатор клиента
date_fromДаДата, с которой проверять отправленные сообщения в формате YYYY-MM-DD
channelДаКаналы сообщений через запятую: email, sms, web_push, mobile_push, telegram, whatsapp, max, wallet
typeДаТипы сообщений через запятую: bulk, chain или transactional

Идентификаторы

Параметры, отмеченные [*] — обязателен хотя бы один из них.

Запрос

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

shell
curl 'https://api.rees46.ru/notifications/counters/extended?type=bulk,chain&channel=email&email=...&shop_id=...&shop_secret=...'

Ответ

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

json
{
  "status": "success",
  "payload":{
    "counters": {
      "channels": {
        "email": {
          "bulk": {
            "sent": 2,
            "opened": 2,
            "clicked": 1
          },
          "chain": {},
          "transactional": {}
        },
        "web_push": {},
        "mobile_push": {},
        "whatsapp": {},
        "sms": {}
      }
    }
  }
}

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

PropertyTypeDescription
statusStringТекстовый статус результата обработки запроса
payloadObjectОбъект с ответом
payload.countersObjectОбъект со счетчиками
payload.counters.channelsObjectОбъект со счетчиками, где ключом выступает значение каждого канала из параметра channel

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

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