Comment on page
Лия API
Инструмент для программного взаимодействия с ботом.
Взаимодействие осуществляется по протоколу HTTPS с использованием POST-запросов. Максимальное время обработки одного запроса — 30 секунд. Обмен данными осуществляется в формате JSON.
API предоставляет один метод для обмена событиями между пользователями и роботом:
https://app.lia.chat/api/v1/handling/event?key=API_KEY
Чтобы запросы к API проходили, необходимо опубликовать проект.
Для работы с необходимо получить ключ API_KEY. Для этого в разделе “Каналы” необходимо нажать кнопку “Добавить” и в выпадающем списке выбрать пункт “API”. Полученный ключ API_KEY будет отображен в центральной части страницы.
Взаимодействие между пользователем API и платформой построено на основе событий. Различают два класса событий:
- Входящие события инициированы действиями пользователя, к ним относятся: события старта диалога, текстовые события, медиа события, системные события.
- Исходящие события возникают со стороны платформы как ответная реакция на входящие события.
Тип | Описание |
---|---|
string | Текстовая строка, длина не превышает 1024 символов. Пр необходимости передачи сообщения с большим количеством символов рекомендуем разделить его на несколько сообщений |
float | Вещественное число |
Any | Любые данные в формате JSON. |
Параметры входящего события.
Элемент JSON | Тип | Описание |
---|---|---|
user_id | | |
string | Обязательный параметр. | |
Идентификатор пользователя, с которым происходит взаимодействие. | | |
Разрешенные символы для user_id — английские буквы, цифры и дефис. В остальных случаях вы будете получать ошибки. | | |
event | JSON-объект | |
Обязательный параметр. | | |
Входящее событие, базовый элемент взаимодействия между пользователем и платформой. | | |
Описание объекта приведено ниже | | |
facts | JSON-объект | Необязательный параметр. |
Факты о пользователе, которые могут быть использованы при выполнении сценариев. | | |
JSON-объект с ключами типа string и значениями типа Any. | | |
Объект event — базовый элемент взаимодействия, в котором передаются тип события и необходимые для его обработки параметры. Объект event для входящих событий отличается от объекта event для исходящих событий возможными значениями параметров
type
и params
.Элемент JSON | Тип | Описание |
---|---|---|
type | string | Обязательный параметр. |
Тип события, от которого зависит набор параметров входящего сообщения. | | |
Возможные значения: | | |
• text — текстовое сообщение; | | |
• image — изображение; | | |
• audio — аудиозапись; | | |