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

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

Канал доступен на тарифах Developer, Bussines Standard, Bussines Pro.

Как подключить канал Чат API

Зайдите в настройки каналов вашего бота и нажмите на кнопку Чат виджет. Откроется окно настроек виджета.



Заполните поля:
Название канала, название канала, которое будет отображено для канала, в списке подключенных каналов бота.
Токен, секретный ключ для запроса. Вы можете оставить его пустым, и aimylogic сгенерирует ключ автоматически.

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



Токен

Токен конфигурируется при создании канала и необходим для предоставляемых методов Чат API.
Для получить токен можно кнопкой "Скопировать токен" в созданном канале чат API в списке всех каналов.
Или открыть в окно редактирования созданного канала Чат API. Значение будет доступно в поле Токен, скопируйте его и используйте для доступа к API.

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

Методы API

Чат API предоставляет следующие методы:

Отправка запроса клиента. Метод вернет ответ бота. Либо сообщение о том, что разговор переведен на оператора. POST /chatapi/{token}

Отправка запроса. Упрощенный метод отправки запроса клиента GET /chatapi/{token}

Получение событий. Получение асинхронных сообщений от сервера. Предназначен для получения ответов от оператора GET /chatapi/{token}/events?clientId={clientId}

Получение истории. Запрос истории переписки клиента GET /chatapi/{token}/client/{clientId}/history

Получение состояния. Получение состояния чата. Используется чатвиджетом для сохранения состояния свернут/развернут GET /chatapi/{token}/client/{clientId}/state

Сохранение состояния. Запрос истории переписки клиента POST /chatapi/{token}/client/{clientId}/state

Пример GET запроса:
https://bot.aimylogic.com/chatapi/<token>?clientId=test&query=/start

Пример POST запроса:
curl -H "Content-Type: application/json" -X POST -d '{"clientId":"test","query":"test"}' https://bot.aimylogic.com/chatapi/<token>
Была ли эта статья полезна?
отменить
Спасибо!