Получение информации о каскадах

Обновлено: 12 января 2025

Для получения информации о каскадах используется метод api/cascade/get-all

Вызов метода api/cascade/get-all

Чтобы вызвать метод api/cascade/get-all, отправьте POST-запрос на URL-адрес https://app.edna.by/api/cascade/get-all.

Если запрос выполнен успешно, метод возвращает ответ с кодом 200 и массив JSON-объектов [{…}, {…}, {…}] с параметрами ответа.

Если у вас есть заблокированные подписи, формат ответа будет содержать информацию о блокировке.

Формат запроса

В теле запроса передается пустой JSON-объект в фигурных скобках {}

Параметры ответа

Параметр	Тип данных	Описание
id	number	Идентификатор каскада. Указывается при отправке сообщений в атрибуте cascadeId.
name	string	Имя каскада, указанное при создании каскада.
status	string	Статус каскада. Например, ACTIVE (активен) или DISABLED (отключен).
stagesCount	string	Количество шагов в каскаде.
stages	object	Информация о каскадах. Массив содержит описание о составе каскада.
order	number	Порядковый номер шага каскада.
uuid	string	Идентификатор шага, присвоенный системой.
decision	object	Описание шага. Может быть null или содержать type: "TTL", "ttl": "00:00:40", где ttl — время, по истечении которого нужно переходить на описываемый шаг, если сообщение на предыдущем шаге было не доставлено.
subject	object	Информация о канале.
subject.id	number	Идентификатор подписи.
subject.name	string	Имя канала, указанное при создании канала.
subject.subject	string	Имя подписи.
subject.description	string	Дополнительная информация о канале.
subject.type	string	Тип канала. Например, SMS, VIBER, WHATSAPP.
subject.tenantId	number	Идентификатор вашего аккаунта.

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

Пример ответа, если запрос выполнен успешно и все каскады активны

[
    {
        "id": 2563,
        "name": "sms-viber",
        "status": "ACTIVE",
        "stagesCount": 3,
        "stages": [
            {
                "order": 0,
                "uuid": "05c1203a-c77b-4cb4-acf2-e8ed1de4d8221",
                "subject": {
                    "id": 16451,
                    "name": "Test_MFMSCOM-4938",
                    "subject": "Test_MFMSCOM-4938",
                    "type": "SMS",
                    "tenantId": 334,
                    "testing": false,
                    "locked": false,
                    "approveStatus": "APPROVED"
                },
                "stages": [
                    {
                        "order": 1,
                        "uuid": "db80e215-2088-4782-9f73-c8f8b1e7d644",
                        "decision": {
                            "type": "TTL",
                            "ttl": "00:01:00"
                        },
                        "subject": {
                            "id": 16724,
                            "name": "RETAIL2_VIBER_EM",
                            "subject": "RETAIL2_VIBER_EM",
                            "type": "VIBER",
                            "tenantId": 334,
                            "testing": false,
                            "locked": false,
                            "approveStatus": "APPROVED"
                        },
                        "stages": []
                    }
                ]
            }
        ]
    }
]