Описание
Получить список сценариев.
URL-адрес
Метод: POST
https://example.com/api/v1.1/workflows/list
Параметры запроса
| Параметр | Тип | Пример | Обязательный | Описание |
|---|---|---|---|---|
| token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
| format | string | "json" | Нет | Формат возвращаемых данных по умолчанию – "json" |
| from_id | int | 1 | Нет | Идентификатор первого сценария в списке по умолчанию – 1 |
| limit | int | 1 | Нет | Лимит на количество возвращаемых сценариев по умолчанию – 1000 |
| groups | []string | [ "group1", "group2" ] | Нет | Список групп для поиска по умолчанию – [] |
| groups_id | []int | [ 0, 1 ] | Нет | Список ID групп для поиска по умолчанию – [] |
| ui_tags | []string | ["tag1", "tag2"] | Нет | Список тегов для поиска по умолчанию – [] |
Пример запроса
{
"from_id": 1,
"limit": 1,
"token": "abcdefghijklmnqrstuvwxyz",
"ui_tags": ["tag1", "tag2"]
}
Пример ответа
{
"data": [
{
"id": 15,
"name": "Test scenario",
"list_id": 1,
"is_active": true,
"ui_tags": [
"tag1",
"tag2"
],
"mode": "skip_in_any_case",
"groups": [
{
"id": 1,
"name": "Test group"
},
],
"nodes": [
{
"name": "Node 1",
"type": "campaign"
},
{
"name": "Node 2",
"type": "condition"
},
{
"name": "Node 3",
"type": "update"
}
]
}
],
"error": 0,
"error_text": "Successful operation",
"total_count": 1
}
Возвращаемые параметры
| Параметр | Тип | Описание |
|---|---|---|
| error | int | Код ошибки |
| error_text | string | Текст ошибки |
| id | int | Идентификатор сценария |
| name | string | Название сценария |
| list_id | int | Идентификатор базы профилей |
| is_active | bool | Активный сценарий или нет |
| mode | string | Режим при неоднократном попадании профиля в сценарий |
| ui_tags | array | Список тегов |
| groups | array of objects | Список групп |
| nodes | array of objects | Список элементов сценария |
| total_count | int | Общее количество полученных сценариев |