Методы API → Чат-боты

Чтобы воспользоваться методами API, перейдите в раздел «Интеграции» → вкладка «Методы API» → «Чат-боты» или без авторизаци по ссылке.

scenarioScenario methods

• GET /scenario — Получение списка всех сценариев — Get all scenarios
• POST /scenario — Создание нового сценария — Create new scenario
• GET /scenario/chats — Получение чатов сценариев по ID сценариев — Get scenarios chats by scenario ids
• GET /scenario/integrations — Получение интеграций сценариев — Get scenarios integrations by scenario ids
• GET /scenario/edit_block — Получение блокировок редактирования сценариев — Get scenarios edit_block by scenario ids
• GET /scenario/light — Получение списка ID сценариев — Get all scenarios ids
• GET /scenario/phones — Получение телефонов сценариев — Get all scenario phones
• GET /scenario/{scenario_id} — Получение информации о сценарии — Get scenario info
• DELETE /scenario/{scenario_id} — Удаление сценария — Delete scenario
• PATCH /scenario/{scenario_id} — Обновление сценария — Update scenario
• POST /scenario/{scenario_id}/copy — Копирование сценария — Copy scenario
• GET /scenario/{scenario_id}/variables — Получение всех переменных сценария — Get all scenario variable names
• GET /scenario/{scenario_id}/variables/search — Поиск переменной в сценарии — Get specified variable from scenario
• GET /scenario/{scenario_id}/queues — Получение очередей, используемых в сценарии — Get queues used in scenario

scenario_schemeScenario scheme methods

• GET /scenario/{scenario_id}/scheme — Получение полной визуальной схемы сценария — This method returns the scheme full visual data
• POST /scenario/{scenario_id}/scheme — Массовое создание элементов и связей — This method is for multiple creation of elements and edges
• PUT /scenario/{scenario_id}/scheme/backup/{backup_id} — Восстановление схемы из бэкапа — This method is for multiple creation of elements and edges from backup
• GET /scenario/{scenario_id}/scheme/preview — Получение превью схемы — This method returns a preview of the scheme

scenario_scheme_elements Scenario scheme elements methods

• POST /scenario/{scenario_id}/scheme/elements — Создание элемента схемы — This method creates an element in the scheme and returns its id
• DELETE /scenario/{scenario_id}/scheme/elements — Массовое удаление элементов — The method deletes many elements in the scheme and returns their id
• PATCH /scenario/{scenario_id}/scheme/elements/{id} — Обновление элемента схемы — This method updates an element in the scheme
• GET /scenario/{scenario_id}/scheme/elements/visual/search — Поиск текста в визуальных элементах — Get specified text from elements visual
• PATCH /scenario/{scenario_id}/scheme/elements/ch/coordinates — Массовое обновление координат элементов — This method massively updates the coordinates of the elements

scenario_scheme_edgesScenario scheme edges methods

• POST /scenario/{scenario_id}/scheme/edges — Создание связи между элементами — This method creates an edge in the scheme and returns its id
• DELETE /scenario/{scenario_id}/scheme/edges/{id} — Удаление связи — The method delete edge in the scheme and returns id

scenario_scheme_favorite_elementsScenario scheme favorite elements methods

• GET /scheme/elements/favorite — Получение избранных элементов — The method return favorite elements
• POST /scheme/elements/favorite — Добавление элемента в избранное — This method creates an favorite element returns its id
• GET /scheme/elements/favorite/{id} — Получение избранного элемента — The method return favorite element by id
• DELETE /scheme/elements/favorite/{id} — Удаление избранного элемента — The method delete favorite element and returns their id

scenario_backupsScenario scheme backups methods

• GET /scenario/{scenario_id}/backups — Получение бэкапов сценария — Get scenario backups
• GET /scenario/{scenario_id}/backups/{id} — Получение бэкапа с данными — Get scenario backup with data

scenario_changesScenario scheme changes methods

• GET /scenario/{scenario_id}/changes — Получение истории изменений — Get all scenarios changes
• POST /scenario/{scenario_id}/changes/{id}/undo — Отмена изменения — Undo scenarios changes (Ctrl + Z)
• POST /scenario/{scenario_id}/changes/{id}/redo — Повтор изменения — Redo scenarios changes (Ctrl + Y)

scenario_blockScenario block methods

• POST /block_scenario_edits — Блокировка редактирования сценария — Block scenario edits
• PATCH /block_scenario_edits — Обновление блокировки — Update block scenario edits
• POST /unblock_scenario_edits — Разблокировка сценария — Unblock scenario edits
• POST /block_scenario_edits/users — Добавление пользователей с доступом к блокировке — Added users who can see blocking scenario
• DELETE /block_scenario_edits/users — Удаление пользователей из блокировки — Delete users who can see blocking scenario
• GET /block_scenario_edits/users/{scenario_id} — Получение пользователей блокировки — Get users who can see blocking scenario

scenario_trash_binScenario trashbin methods

• POST /scenario/{scenario_id}/trash_bin/restore — Восстановление сценария из корзины — Restore scenario from trashbin
• DELETE /scenario/{scenario_id}/trash_bin — Удаление сценария из корзины — Delete scenario from trashbin

scenario_groupScenario groups methods

• POST /scenario_groups — Создание группы сценариев — Create scenario group
• GET /scenario_groups — Получение групп сценариев — Get scenario groups
• PATCH /scenario_groups/{id} — Обновление группы — Update scenario group
• DELETE /scenario_groups/{id} — Удаление группы — Delete scenario group
• POST /scenario_groups/{id}/scenarios — Добавление сценария в группу — Add scenario to group
• DELETE /scenario_groups/{id}/scenarios — Удаление сценария из группы — Remove scenario from group

Также см.:
Методы API → Интеграция
Методы API → Base

Была ли эта статья полезной

Да, полезнаНет, не полезна