В результате выполнения запроса будет возвращен ответ с перечнем всех активных каскадов. В случае успешного выполнения запроса вернется ответ от сервера с кодом 200, содержащий массив JSON-объектов [{…}, {…}, {…}] с параметрами, описанными ниже в таблице. Если у вас есть заблокированные подписи, формат ответа изменится и будет содержать информацию о блокировке. Примеры возможных ответов также представлены ниже.
В теле запроса необходимо передать пустой JSON-объект в фигурных скобках {}.
URL-адрес подключения
Для получения списка каскадов выполняется POST-запрос на URL-адрес: https://app.edna.ru/api/cascade/get-all/
Формат запроса
{ "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": [] } ] } ] } ] } ]
- Запрос выполнен, но есть заблокированные подписи:
{ "title": "cascade-not-valid", "status": 400, "detail": "One or more cascades are not valid. Details: Subject is locked. Template cascade id: 5,432, stage uuids: [365e6191-1111-464a-af9e-2789f8b6a42c], subject id: 123" }
Описание атрибутов ответа
Параметр | Тип данных | Описание |
id | long | Идентификатор каскада. Этот идентификатор необходимо указывать при отправке сообщений в атрибуте cascadeId |
name | string | Имя каскада (имя, которое вы указали при создании каскада) |
status | string | Статус каскада, например, ACTIVE |
stagesCount | string | Количество шагов в каскаде, например, 2 |
stages | object | Информация о каскадах. Массив содержит описание о составе каскада |
order | long | Порядковый номер шага |
uuid | string | Идентификатор шага, присвоенный системой |
decision | object | Описание шага. Может быть null, либо может содержать «type»: «TTL», «ttl»: «00:00:40», где ttl количество единиц времени, после истечения которых нужно переходить на описываемый шаг, если сообщение на предыдущем шаге не было доставлено |
subject | object | Информация о канале |
subject.id | long | Идентификатор подписи |
subject.name | string | Имя канала (имя, которое вы указали при создании канала) |
subject.subject | string | Имя подписи |
subject.description | string | Дополнительная информация о канале |
subject.type | string | Тип канала (например, SMS , VIBER , WHATSAPP ) |
subject.tenantId | long | Идентификатор вашего аккаунта |