В результате выполнения запроса будет возвращен ответ с перечнем всех активных каскадов. В случае успешного выполнения запроса вернется ответ от сервера с кодом 200, содержащий массив JSON-объектов [{…}, {…}, {…}] с параметрами, описанными ниже в таблице.
Если у вас есть заблокированные подписи, формат ответа изменится и будет содержать информацию о блокировке. Примеры возможных ответов также представлены ниже.
В теле запроса необходимо передать пустой JSON-объект в фигурных скобках {}.
URL-адрес подключения
Для получения списка каскадов выполняется POST-запрос на URL-адрес: https://app.edna.io/api/cascade/get-all/
Формат запроса
{ "offset":0, "limit":0 }
Примеры ответа
- Запрос выполнен успешно. Все каскады активны.
[ { "id": 2563, "name": "wa-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": "55cf6d4b-2e99-4b25-8930-c81cd66bd114", "decision": { "type": "TTL", "ttl": "00:01:00" }, "subject": { "id": 18532, "name": "RETAIL2_WA_EM_temp", "subject": "RETAIL2_WA_EM_temp", "type": "WHATSAPP", "tenantId": 334, "testing": false, "locked": false, "approveStatus": "APPROVED" }, "stages": [ { "order": 2, "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": [] } ] } ] } ] }, ]
- Запрос выполнен успешно. Возвращен отключенный каскад:
[ { "id": 2533, "name": "whatsapp-conversation", "status": "DISABLED", "stagesCount": 1, "stages": [ { "order": 0, "uuid": "85e891e5-c6e4-430c-a687-c5beefd270b4", "subject": { "id": 18532, "name": "RETAIL2_WA_EM_temp", "subject": "RETAIL2_WA_EM_temp", "type": "WHATSAPP", "tenantId": 334, "testing": false, "locked": false, "approveStatus": "APPROVED" }, "stages": [] } ] }, ]
Описание атрибутов ответа
Параметр | Тип данных | Описание |
id | long | Идентификатор каскада. Этот идентификатор необходимо указывать при отправке сообщений в атрибуте cascadeId |
name | string | Имя каскада (имя, которое вы указали при создании каскада) |
status | string | Статус каскада, например, ACTIVE (активен) или DISABLED (отключен) |
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 | Идентификатор вашего аккаунта |