Appearance
Счетчик отправленных и прочитанных сообщений
Метод позволяет получить счетчик отправленных и прочитанных сообщений для центра уведомлений.
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
}
}
}Расшифровка свойств ответа:
| Property | Type | Description |
|---|---|---|
| status | String | Текстовый статус результата обработки запроса |
| payload | Object | Объект с ответом |
| payload.counters | Object | Объект со счетчиками |
| payload.counters.sent | Integer | Количество отправленных сообщений |
| payload.counters.opened | Integer | Количество просмотренных сообщений |
В случае ошибки ответ будет в формате:
json
{
"status": "error",
"payload": {
"message": "Invalid secret key"
}
}