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

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

Затем в правом меню выберите нужный тип API — «Чат-боты».

• Scenario methods
  • POST/get_scenario_scheme - Get visual scheme — Получить визуальную схему сценария.
  • POST/set_scenario_scheme - Update scenario scheme — Обновить визуальную схему сценария.
  • POST/get_scenarios - Get all scenarios — Получить список всех сценариев.
  • GET/get_scenarios/phone - Get all scenarios — Получить список сценариев для телефонных взаимодействий.
  • POST/create_scenario - Create new scenario — Создать новый сценарий.
  • POST/delete_scenario - Delete scenario — Удалить сценарий.
  • POST/edit_scenario - Edit scenario metadata — Редактировать метаданные сценария.
  • POST/copy_scenario - Copy scenario — Скопировать сценарий.
  • POST/get_scenario_backup - Get scenario backups — Получить резервные копии сценария.
  • POST/get_scenario_variables - Get scenario variable names — Получить имена переменных сценария.
  • GET/scenario/variable/search - Get specified variable from scenario — Найти указанную переменную в сценарии.
  • GET/scenario/text/search - Get specified text from scenario — Найти указанный текст в сценарии.

• Block scenario 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 — Получить список пользователей, которые могут видеть заблокированный сценарий по его ID.

• Trash bin scenario methods

  • GET/scenario_trash_bin - Get scenario from basket — Получить сценарий из корзины (список удалённых сценариев).
  • POST/scenario_trash_bin/restore - Restore scenario from basket — Восстановить сценарий из корзины.
  • POST/scenario_trash_bin/delete - Delete scenario from basket — Удалить сценарий из корзины окончательно.

• Connectors

• POST/chat/library/get_platform - Get platform settings — Получить настройки платформы для коннекторов.

• POST/get_chat - Get connector — Получить информацию о конкретном коннекторе.

• POST/get_all_chats - Get all connectors — Получить список всех коннекторов.

• POST/get_chats_by_scenario - Get all connectors of scenario — Получить все коннекторы, связанные с определённым сценарием.

• POST/create_chat - Create new connector — Создать новый коннектор.

• POST/delete_chat - Delete connector — Удалить коннектор.

• DELETE/chat/test/{id} - Delete test connector — Удалить тестовый коннектор по его идентификатору.

• POST/set_chat_settings - Update connector settings — Обновить настройки существующего коннектора.

• Bot users

  • GET/dialogs - Get users in scenario — Получить список пользователей, связанных с определённым сценарием.
  • DELETE/chat_user - Delete specified user — Удалить указанного пользователя.
  • GET/chat_user - Get specified user by id — Получить информацию о пользователе по его идентификатору.
  • POST/clear_variables - Delete variables for users in scenario — Удалить переменные, связанные с пользователями в рамках сценария.
  • GET/chat_user/is_exists - Get user_id by platform_user_id — Получить user_id на основании platform_user_id.

• Static media assets methods

  • POST/set_asset - Create static media asset — Создать статический медиа-актив.
  • GET/get_asset - Get static media asset — Получить информацию о статическом медиа-активе.
  • GET/get_asset/{asset_id} - Get static media asset — Получить статический медиа-актив по его ID.
  • POST/get_asset_info - Get information about static media content — Получить информацию о контенте статического медиа-актива.

• Billing and service methods

  • POST/get_service - Check if service is enabled — Проверить, включена ли услуга для клиента. Этот метод возвращает статус конкретной услуги.

• Statistics methods

  • POST/get_messages - Get messages — возвращает список сообщений, отправленных пользователями.
  • GET/dialogs - Get users in scenario — Получить список пользователей, связанных с определённым сценарием.
  • POST/get_users - Get users — Получить пользователей, участвующих в чате или сценарии.
  • POST/get_messages_count - Get statistics about messages count — Получить статистику по количеству сообщений.
  • POST/get_new_users - Get new user statistics — Получить статистику по новым пользователям (например, впервые использующим сценарий).
  • POST/get_users_count - Get number of users in chat or scenario — Получить количество пользователей в чате или сценарии.

• Templates methods

  • POST/create_template - Create template — Создать новый шаблон.
  • POST/get_templates - Get templates list — Получить список всех доступных шаблонов.
  • POST/apply_template - Get template data — Применить данные шаблона к сценарию или другому объекту.
  • PATCH/template - Update template — Обновить существующий шаблон.

• Analytics methods

  • POST/analytics/get - Get analytics — Получить данные аналитики.
  • POST/analytics/clear - Clear analytics — Очистить данные аналитики.
  • POST/analytics/get_analytics_file - Get analytics file — Получить файл с данными аналитики.
  • POST/analytics/get_in_details - Get analytics in details — Получить детализированные данные аналитики.
  • POST/analytics/get_as_csv - Get analytics in csv — Получить данные аналитики в формате CSV.

• Action methods

  • POST/action/send_message - Send message — Отправляет сообщение пользователю.
  • POST/action/send_first_message - Send message — Отправляет первое сообщение новому пользователю.
  • POST/action/move - Move users to element — Перемещает пользователей к указанному элементу в сценарии.
  • POST/get_users_by_file - Download users — Загружает список пользователей из файла.
  • POST/action/set_variable - Change variable — Устанавливает или изменяет значение переменной для пользователя.
  • POST/action/check_bot_block - Check if user blocked bot — Проверяет, заблокировал ли пользователь бота.
  • GET/action/check/phone - Check available phone numbers — Проверяет доступность номеров телефонов для пользователя.

• Vpbx proxy methods

  • POST/vpbx/list - List vpbx — Получает список доступных виртуальных АТС.

• Marketplace scenario methods

  • GET/scenario_marketplaces - Get all marketplace scenarios — Возвращает список всех сценариев из маркетплейса.
  • GET/scenario_marketplace/{id} - Get specific marketplace scenario — Возвращает данные о конкретном сценарии из маркетплейса по его ID.
  • DELETE/scenario_marketplace/{id} - Delete specific marketplace scenario — Удаляет указанный сценарий из маркетплейса по его ID.
  • PATCH/scenario_marketplace/{id} - Update specific marketplace scenario — Обновляет указанный сценарий из маркетплейса по его ID.
  • POST/scenario_marketplace - Create new marketplace scenario — Создать новый сценарий в маркетплейсе.
  • POST/copy_scenario_marketplace - Copy marketplace scenario — Создает копию существующего сценария в маркетплейсе.

• Scenario allow internal requests methods

  • GET/scenario_allow_internal_request - Get specific allow internal request scenarios — Получить разрешенные сценарии внутренних запросов.
  • POST/scenario_allow_internal_request - Create new allow internal request scenarios — Создать сценарий с разрешенными внутренними запросами.
  • DELETE/scenario_allow_internal_request - Delete specific allow internal request scenarios — Удалить сценарий с разрешенными внутренними запросами.
  • GET/scenario_allow_internal_request/url - Get url type for specific allow internal request scenarios (local - true, global - false) — Получить тип URL для сценария (локальный или глобальный).

• Scenario logs methods

  • GET/scenario_logs - Get scenarios logs — Получить логи сценариев.
  • DELETE/scenario_logs - Delete scenarios logs — Удалить логи сценариев.
  • GET/scenario_logs/count - Get element logs count — Получить количество логов для элементов.

• Payment methods

  • GET/payment/config - Get all payments — Получить все платежи.
  • POST/payment/config - Create new payment — Создать новый платеж.
  • GET/payment/config/{id} - Get specific payment — Получить данные о конкретном платеже.
  • PATCH/payment/config/{id} - Update specific payment — Обновить данные платежа.
  • DELETE/payment/config/{id} - Delete specific payment — Удалить платеж.
  • GET/payment/fields/{platform} - Get all payment fields — Получить все поля для платежной платформы.
  • POST/payment/init/{payment_platform}/{id} - Init payment webhook — Инициализировать платежный вебхук.

• Payment check methods

  • GET/payment/checks - Get all payment checks — Получить все платежные проверки.
  • GET/payment/check - Get specific payment check — Получить конкретную платежную проверку.
  • DELETE/payment/check - Delete specific payment check — Удалить платежную проверку.

• File

  • POST/set_file - Create static media file — Создать статический медиафайл.
  • POST/delete_unused_files - Create static media file — Удалить неиспользуемые файлы.
  • POST/delete_file - Create static media file — Удалить статический медиафайл.
  • POST/get_file_list - Create static media file — Получить список файлов.

• Global_variable

  • POST/create_global_variable - Create global variable for scenario — Создать глобальную переменную для сценария.
  • POST/get_global_variable - Get global variable — Получить глобальную переменную.
  • POST/update_global_variable - Update global variable for scenario — Обновить глобальную переменную для сценария.
  • POST/delete_global_variable - Delete global variable for scenario — Удалить глобальную переменную для сценария.

• Attachment

  • POST/delete_attachment - Deletes attachment — Удалить вложение.
  • POST/get_attachment_list - Deletes attachment — Получить список вложений.

• Message

  • POST/get_message_status - Returns message sending status — Получить статус отправки сообщения.

Также см.:

Методы API → Интеграция

Методы API → Автозвонки

Методы API → API ЛК

Методы API → Интеграции v2

Методы API → Адресная книга

Методы API → Виртуальная АТС

Методы API → Коллтрекинг