Skip to content

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

Метод позволяет получить счетчик отправленных и прочитанных сообщений для центра уведомлений.

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

Параметры

ПараметрОбязателен?Описание
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

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

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

Ограничения параметров

В этом методе параметры type и channel поддерживают только одно значение. Если вам нужна выборка по нескольким типам или каналам, используйте расширенную версию этого метода notifications/counters/extended

Запрос

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

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

Ответ

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

json
{
    "status": "success",
    "payload": {
      "counters": {
        "sent": 1,
        "opened": 1
      }
    }
}

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

PropertyTypeDescription
statusStringТекстовый статус результата обработки запроса
payloadObjectОбъект с ответом
payload.countersObjectОбъект со счетчиками
payload.counters.sentIntegerКоличество отправленных сообщений
payload.counters.openedIntegerКоличество просмотренных сообщений

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

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