Appearance
Отмена каскада или сообщения
Метод останавливает каскад: следующие шаги не выполняются и новые сообщения не отправляются. Уже отправленные сообщения не отзываются.
Одиночное сообщение можно отменить, только пока оно находится в очереди на отправку.
POST https://app.rees46.ru/api/v3/communications/transactional/cancelAPI находится на домене личного кабинета: app.rees46.ru для России и app.rees46.kz для Казахстана. В on-premise кластере у API свой домен.
Сценарий 2FA
Каскад с одноразовым кодом может ждать подтверждения доставки, прежде чем отправить код в следующий канал. Если клиент уже получил код и ввел его, ждать дальше не нужно:
- Запускаете каскад методом отправки и сохраняете
payload.codeиз ответа. - Клиент вводит код на сайте или в приложении.
- Сразу вызываете отмену с сохраненным кодом каскада.
Так клиент не получит тот же код в резервном канале, например в SMS.
Параметры
| Параметр | Тип | Обязателен? | Описание |
|---|---|---|---|
| shop_id | String | Да | API-ключ |
| shop_secret | String | Да | Секретный API-ключ |
| code | String | Да | Код каскада или сообщения из ответа отправки |
Запрос
shell
curl 'https://app.rees46.ru/api/v3/communications/transactional/cancel' \
-X 'POST' \
-H 'Content-Type: application/json' \
--data-raw '{"shop_id":"SHOP_ID", "shop_secret":"SHOP_SECRET", "code":"123-456-mu-a1b2c3d4"}'Ответ
json
{
"status": "success",
"payload": {
"code": "123-456-mu-a1b2c3d4",
"status": "cancelled",
"sent_channels": ["email"]
}
}| Свойство | Тип | Описание |
|---|---|---|
| code | String | Код каскада или сообщения |
| status | String | cancelled |
| sent_channels | Array | Каналы, в которые каскад успел отправить сообщения до отмены |
Повторная отмена уже отмененного каскада возвращает успешный ответ — метод идемпотентен.
Ошибки
В случае ошибки ответ будет в формате:
json
{
"status": "fail",
"message": "..."
}| Код | Причина |
|---|---|
| 400 | Неверные параметры запроса |
| 403 | Неверный shop_secret или проект неактивен |
| 404 | Каскад или сообщение с таким кодом не найден |
| 409 | Каскад уже завершен — в ответе будет его итоговый статус и finish_reason. Для одиночного сообщения: оно уже отправляется (Message is already being sent) или отправлено (Message is already sent) |
Ответ 409 в сценарии 2FA не является ошибкой интеграции: он означает, что каскад завершился раньше, чем клиент ввел код. Итог каскада можно посмотреть методом статуса.