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

В результате выполнения запроса будет возвращен ответ с перечнем всех заведенных ранее каскадов (в теле запроса требуется передать пустой JSON-объект в фигурных скобках {}). В случае успешного выполнения запроса вернется ответ от сервера с кодом 200, содержащий массив JSON-объектов [{…}, {…}, {…}] с параметрами, описанными ниже в таблице. В случае неуспешного выполнения запроса возвращается сообщение с кодом ошибки.

URL-адрес подключения

Для получения списка каскадов выполняется POST-запрос на URL-адрес: https://app.edna.io/api/cascade/get-all/

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

В теле запроса передается JSON-объект с параметрами сообщения.

{
    "offset":0,
    "limit":0
}

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

[
    {
        "id": 1000000,
        "name": "Достучаться до клиента",
        "status": "ACTIVE",
        "stagesCount": 3,
        "stages": [
            {
                "order": 0,
                "uuid": "001-test001",
                "decision": null,
                "subject": {
                    "id": 23215,
                    "name": "test",
                    "subject": "test_subject_WA",
                    "description": null,
                    "type": "WHATSAPP",
                    "tenantId": 100000
                },
                "stages": [
                    {
                        "order": 1,
                        "uuid": "2ede9313-0539-463a-9ec3-898506f4937a",
                        "decision": {
                            "type": "TTL",
                            "ttl": "00:00:40"
                        },
                        "subject": {
                            "id": 412365,
                            "name": "test_twoway",
                            "subject": "test_subject_twoway",
                            "description": null,
                            "type": "VIBER",
                            "tenantId": 100000
                        },
                        "stages": [
                            {
                                "order": 2,
                                "uuid": "66cdf240-ef82-403e-931d-b3deaf180a1e",
                                "decision": {
                                    "type": "TTL",
                                    "ttl": "00:01:00"
                                },
                                "subject": {
                                    "id": 585698,
                                    "name": "SMS",
                                    "subject": "test_subject_SMS",
                                    "description": null,
                                    "type": "SMS",
                                    "tenantId": 100000
                                },
                                "stages": []
                            }
                        ]
                    }
                ]
            }
        ]
    }
]

Описание атрибутов ответа

ПараметрТип данныхОписание
idlongИдентификатор каскада. Этот идентификатор нужно указывать при отправке сообщений в атрибуте cascadeId
namestringИмя каскада (имя, которое вы указали при создании каскада)
statusstring Статус каскада, например, ACTIVE
stagesCountstringКоличество шагов в каскаде, например, 2
stagesobject Информация о каскадах. Массив содержит описание о составе каскада
orderlongПорядковый номер шага
uuidstringИдентификатор шага, присвоенный системой
decisionobject Описание шага. Может быть null, либо может содержать «type»: «TTL»,
«ttl»: «00:00:40», где ttl количество единиц времени, после истечения которых нужно переходить на описываемый шаг, если сообщение на предыдущем шаге не было доставлено
subjectobject Информация о канале
subject.idlongИдентификатор подписи
subject.namestringИмя канала (имя, которое вы указали при создании канала)
subject.subjectstringИмя подписи
subject.descriptionstringДополнительная информация о канале
subject.typestringТип канала (например, SMS, VIBER, WHATSAPP)
subject.tenantIdlongИдентификатор вашего аккаунта
Получение списка каналов
Cледующая статья Создание шаблона