Для получения информации о каскадах используется метод api/cascade/get-all
.
Вызов метода api/cascade/get-all
Чтобы вызвать метод api/cascade/get-all
, отправьте POST-запрос на URL-адрес https://app.edna.ru/api/cascade/get-all/
.
Если запрос выполнен успешно, метод возвращает ответ с кодом 200
и массив JSON-объектов [{…}, {…}, {…}]
с параметрами ответа.
Если у вас есть заблокированные подписи, формат ответа будет содержать информацию о блокировке.
Формат тела запроса
В теле запроса передается пустой JSON-объект в фигурных скобках {}
.
Пример ответа
Пример ответа, если запрос выполнен успешно и все каскады активны:
[ { "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 | Количество шагов в каскаде. |
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 | Идентификатор вашего аккаунта. |