Appearance
Статус сообщения или каскада
Метод возвращает текущий статус транзакционного сообщения или каскада и историю событий по нему. Используйте код, полученный в ответе метода отправки.
POST https://app.rees46.ru/api/v3/communications/transactional/statusAPI находится на домене личного кабинета: app.rees46.ru для России и app.rees46.kz для Казахстана. В on-premise кластере у API свой домен.
Параметры
| Параметр | Тип | Обязателен? | Описание |
|---|---|---|---|
| shop_id | String | Да | API-ключ |
| shop_secret | String | Да | Секретный API-ключ |
| code | String | Да | Код сообщения или каскада из ответа отправки |
Запрос
shell
curl 'https://app.rees46.ru/api/v3/communications/transactional/status' \
-X 'POST' \
-H 'Content-Type: application/json' \
--data-raw '{"shop_id":"SHOP_ID", "shop_secret":"SHOP_SECRET", "code":"123-456-em-a1b2c3d4"}'Ответ для сообщения
json
{
"status": "success",
"payload": {
"type": "message",
"code": "123-456-em-a1b2c3d4",
"campaign_code": "order_paid",
"channel": "email",
"status": "opened",
"events": [
{ "event": "send", "at": "2026-11-12T10:00:00Z" },
{ "event": "open", "at": "2026-11-12T10:03:12Z" }
]
}
}| Свойство | Тип | Описание |
|---|---|---|
| type | String | message |
| code | String | Код сообщения |
| campaign_code | String | Код транзакционной рассылки |
| channel | String | Канал отправки |
| status | String | Итоговый статус сообщения, см. справочник |
| events | Array | Хронология событий по сообщению |
| events.event | String | Событие |
| events.at | String | Время события |
Ответ для каскада
json
{
"status": "success",
"payload": {
"type": "cascade",
"code": "123-456-mu-a1b2c3d4",
"campaign_code": "otp_login",
"status": "finished",
"finish_reason": "delivered",
"delivered_channel": "email",
"messages": [
{ "node": "m1", "channel": "mobile_push", "code": "...", "status": "sent", "delivery": "not_delivered" },
{ "node": "m2", "channel": "email", "code": "...", "status": "opened", "delivery": "delivered" }
]
}
}| Свойство | Тип | Описание |
|---|---|---|
| type | String | cascade |
| code | String | Код каскада |
| campaign_code | String | Код каскада в личном кабинете |
| status | String | Статус каскада, см. справочник |
| finish_reason | String | Причина завершения, см. справочник |
| delivered_channel | String | Канал, в который сообщение было доставлено |
| messages | Array | Сообщения, которые каскад уже отправил |
| messages.node | String | Узел дерева правил, который отправил сообщение |
| messages.channel | String | Канал |
| messages.code | String | Код сообщения. По нему можно запросить статус отдельного сообщения |
| messages.status | String | Статус сообщения, см. справочник |
| messages.delivery | String | Результат проверки доставки: pending, delivered, not_delivered |
Справочник
Статусы сообщения
| Статус | Описание |
|---|---|
queued | Сообщение в очереди на отправку |
sent | Сообщение отправлено |
delivered | Сообщение доставлено |
opened | Сообщение открыто |
clicked | По ссылке в сообщении был клик |
bounced | Отказ в доставке |
failed | Отправка завершилась ошибкой |
Статусы каскада
| Статус | Описание |
|---|---|
running | Каскад выполняет шаги |
waiting | Каскад ждет результата проверки доставки или задержки |
finished | Каскад завершен |
cancelled | Каскад отменен |
failed | Каскад завершился ошибкой |
Причины завершения каскада
| Значение | Описание |
|---|---|
delivered | Сообщение доставлено |
exhausted | Каналы закончились, доставка не подтверждена |
no_channels | Ни одна проверка не пройдена — отправлять было некуда |
cancelled | Каскад отменен |
error | Ошибка при выполнении каскада |
Ошибки
В случае ошибки ответ будет в формате:
json
{
"status": "fail",
"message": "..."
}| Код | Причина |
|---|---|
| 400 | Неверные параметры запроса |
| 403 | Неверный shop_secret или проект неактивен |
| 404 | Сообщение или каскад с таким кодом не найден |