Документация для версии v72
Получить список сценариев
Описание
Получить список сценариев.
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"] | Нет | Список тегов для поиска По умолчанию – []. |
| attributes | JSON object | "attributes": { | Нет | Значения атрибутов для поиска |
Пример запроса
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"from_id": 10,
"limit": 1,
"ui_tags": [
"B2C"
]
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<from_id>10</from_id>
<limit>1</limit>
<ui_tags array='true'>B2C</ui_tags>
</xml>
Пример ответа
- JSON
- XML
{
"data": [
{
"id": 10,
"updated_user": "ivan_ivanov",
"update_time": "2025-05-21T09:17:53.362Z",
"name": "Приветственная цепочка",
"list_id": 1,
"is_active": true,
"ui_tags": [
"B2C"
],
"mode": "skip",
"groups": [
{
"id": 2,
"name": "Sales and promotion"
}
],
"attributes": {
"season": "spring_2024",
"branch": "marketing"
},
"nodes": [
{
"name": "DEFAULT_START_NODE_TITLE",
"type": "start",
"node_id": 0
},
{
"name": "ANY_IMPORT_START_NODE_TITLE",
"type": "start",
"node_id": 2
},
{
"templates": [
1
],
"name": "Приветственное письмо",
"type": "campaign",
"node_id": 3,
"campaign_id": 17
},
{
"name": "1 д.0 ч.0 м.",
"type": "delay",
"node_id": 4
},
{
"name": "Подтвердил подписку?",
"type": "condition",
"node_id": 5
},
{
"name": "Получил SMS-напоминание?",
"type": "condition",
"node_id": 6
},
{
"templates": [
5
],
"name": "SMS-напоминание",
"type": "campaign",
"node_id": 7,
"campaign_id": 30
},
{
"name": "1 д.0 ч.0 м.",
"type": "delay",
"node_id": 8
},
{
"name": "Заявка в колл-центр или отдел продаж ",
"type": "feedback",
"node_id": 9
},
{
"name": "Приветственные бонусы",
"type": "feedback",
"node_id": 10
},
{
"name": "Назначить промокод",
"type": "promocode_attach",
"node_id": 11
},
{
"templates": [
22
],
"name": "Промо-предложение",
"type": "campaign",
"node_id": 12,
"campaign_id": 39
}
{
"name": "Переход в сценарий #29",
"type": "workflow_jump",
"node_id": 13,
"next_workflow_id": 29,
"next_node_id": 0
}
]
}
],
"error": 0,
"error_text": "Successful operation",
"next_from_id": 11,
"total_count": 20
}
<xml>
<data>
<groups>
<id>2</id>
<updated_user>ivan_ivanov</updated_user>
<update_time>2025-05-21T09:17:53.362Z</update_time>
<name>Sales and promotion</name>
</groups>
<id>10</id>
<is_active>true</is_active>
<list_id>1</list_id>
<mode>skip</mode>
<name>Приветственная цепочка</name>
<attributes>
<season>spring_2024</season>
<branch>marketing</branch>
</attributes>
<nodes>
<name>DEFAULT_START_NODE_TITLE</name>
<node_id>0</node_id>
<type>start</type>
</nodes>
<nodes>
<name>ANY_IMPORT_START_NODE_TITLE</name>
<node_id>2</node_id>
<type>start</type>
</nodes>
<nodes>
<campaign_id>17</campaign_id>
<name>Приветственное письмо</name>
<node_id>3</node_id>
<templates>1</templates>
<type>campaign</type>
</nodes>
<nodes>
<name>1 д.0 ч.0 м.</name>
<node_id>4</node_id>
<type>delay</type>
</nodes>
<nodes>
<name>Подтвердил подписку?</name>
<node_id>5</node_id>
<type>condition</type>
</nodes>
<nodes>
<name>Получил SMS напоминание?</name>
<node_id>6</node_id>
<type>condition</type>
</nodes>
<nodes>
<campaign_id>30</campaign_id>
<name>SMS-напоминание</name>
<node_id>7</node_id>
<templates>5</templates>
<type>campaign</type>
</nodes>
<nodes>
<name>1 д.0 ч.0 м.</name>
<node_id>8</node_id>
<type>delay</type>
</nodes>
<nodes>
<name>Заявка в колл-центр или отдел продаж </name>
<node_id>9</node_id>
<type>feedback</type>
</nodes>
<nodes>
<name>Приветственные бонусы</name>
<node_id>10</node_id>
<type>feedback</type>
</nodes>
<nodes>
<name>Назначить промокод</name>
<node_id>11</node_id>
<type>promocode_attach</type>
</nodes>
<nodes>
<campaign_id>39</campaign_id>
<name>Промо-предложение</name>
<node_id>12</node_id>
<templates>22</templates>
<type>campaign</type>
</nodes>
<nodes>
<name>Переход в сценарий #29</name>
<next_node_id>0</next_node_id>
<next_workflow_id>29</next_workflow_id>
<node_id>13</node_id>
<type>workflow_jump</type>
</nodes>
<ui_tags>B2C</ui_tags>
</data>
<error>0</error>
<error_text>Successful operation</error_text>
<next_from_id>11</next_from_id>
<total_count>20</total_count>
</xml>
Возвращаемые параметры
| Параметр | Тип | Описание |
|---|---|---|
| error | int | Код ошибки |
| error_text | string | Текст ошибки |
| next_from_id | int | Идентификатор следующего сценария. Указатель можно передать в следующем запросе для получения ещё одной порции данных. |
| total_count | int | Общее количество полученных сценариев |
| Объект data | ||
| id | int | Идентификатор сценария |
| name | string | Название сценария |
| list_id | int | Идентификатор базы профилей |
| is_active | bool | Активный сценарий или нет |
| mode | string | Режим при неоднократном попадании профиля в сценарий |
| ui_tags | array | Список тегов |
| groups | array of objects | Список групп |
| attributes | object | Атрибуты, назначенные сценарию, и их значения |
| nodes | array of objects | Список элементов сценария |
| node_id | int | Идентификатор ноды |
| campaign_id | int | Идентификатор кампании (для ноды "Каналы") |
| templates | int | Идентификатор шаблона (для ноды "Каналы") |
| next_workflow_id | int | Идентификатор следующего сценария (для ноды перехода в сценарий) |
| next_node_id | int | Идентификатор следующей ноды (для перехода в сценарий) |
| updated_user | string | Кем был обновлён сценарий |
| update_time | string | Когда был обновлён сценарий |