API

Вы можете отправлять сообщения на ваш виджет чатбот. Для этого необходимо выполнить POST запрос по адресу: https://api.cavuer.com/messages/generateResponse.

В Headers запроса необходимо добавить ключ: x-cavuer-api-key. В качестве значения ключа необходимо использовать API ключ, который можно создать в личном кабинете в разделе Профиль (подробнее в разделе Начало работы).

Параметры запроса

Параметр Тип Обязательный Описание
chatId string Да Уникальный идентификатор чата. При последующих запросах по данному идентификатору сообщения будут отправляться в ранее созданный чат
text string Да Текст сообщения
uniqueIdentifier string Да Уникальный идентификатор чатбота. Идентификатор widget чатбота из личного кабинета
chatType string Нет Определение чата. Возможные значения: "user", "group". По умолчанию установлено значение “user”, если параметр не указан
participantId string если chatType: group Идентификатор участника группы
chatName string Нет Название чата

Пример тела запроса: 


                        {
                            "chatId": "1234567890",
                            "content": {
                                "text": "Привет. Вы используете Cavuer ИИ-бот"
                                },
                            "uniqueIdentifier": "CAV36pzjv4qwwlq",
                            "chatType": "user",
                            "chatName": "Widget"
                        }

При успешно выполненном запросе вы получите ответ сервера 200.

Возможные ошибки: