Chat API

JAICP предоставляет REST API для интеграции в сторонние приложения. Например, для реализации чата в мобильном приложении, на сайте или в игре.

API предоставляет возможность вести диалог как с ботом, так и с оператором.

подсказка

Подробнее о методах Chat API

Подключение канала Chat API

Авторизуйтесь на JAICP, перейдите в проект. Нажмите на панели управления Каналы → Входящие → Подключить канал. Выберите канал для подключения Chat API.

Заполните поля:

• Название — укажите название канала.
• Токен — оставьте пустым.
• Блокировать ввод текста при использовании кнопок — выберите Да, если хотите заблокировать клиенту возможность ввода текстовых сообщений, когда используете кнопки в сценарии.
• Ветка — укажите ветку проекта, которую вы хотите развернуть в канал, по умолчанию master. Вы также можете выбрать Git-тег или ввести хеш конкретного коммита.
• Оператор — выберите операторский канал или оставьте пустым.
• Публикация — автоматически (после каждого сохранения внесенных в проект изменений) или вручную (с помощью кнопки Опубликовать в строке с описанием канала).

предупреждение

Публикацию сценария нужно выполнять перед запуском бота. На этом этапе происходит сборка бота, проверка синтаксиса сценариев и скриптов, а также проверка прохождения тестов.

Нажмите Создать. Дождитесь всплывающего окна с результатом публикации. После успешной публикации бот готов к использованию.

Токен для доступа к API

подсказка

Токен конфигурируется при создании канала и необходим для предоставляемых методов Chat API.

Для получения токена перейдите в окно редактирования созданного канала Chat API. Здесь автоматически заполнилось поле Токен, скопируйте его и используйте для доступа к API.

Также здесь представлены примеры GET и POST запросов.

Вебхук для асинхронных запросов

При работе с каналом Chat API вы можете использовать асинхронные запросы. Они позволяют получать сообщения бота или события на указанный вебхук.

Асинхронность позволяет обрабатывать несколько запросов одновременно: вы можете отправлять новые запросы, не ожидая, пока сервер закончит обрабатывать предыдущие. Например, с асинхронными запросами вы можете отправлять рассылки без задержек и получать асинхронные события без дополнительных запросов.

Чтобы указать вебхук:

1. Нажмите  в строке канала Chat API, затем Редактировать.
2. Введите URL в поле Адрес вебхука.