Custom¶

Быстрый старт¶

Запустите агента за три шага.

Шаг 1 — Создайте агента в Cavuer¶

Агент — это ИИ-профиль, который управляет вашими каналами. К одному агенту можно подключить несколько каналов связи одновременно.

1. Зарегистрируйтесь в console.cavuer.com

2. На главной странице нажмите «Создать агента», задайте имя и выберите языковую модель

   

3. После создания агента откройте его настройки и добавьте инструкцию — правила поведения агента при общении с клиентами

Ты — вежливый ассистент службы поддержки компании «МояКомпания».
Всегда обращайся к клиенту по имени.
Отвечай только на вопросы, связанные с нашими услугами.
Если не знаешь ответа — предложи связаться с оператором.

Шаг 2 — Подключите канал Custom¶

1. На главной странице рядом с агентом нажмите «Добавить канал» и выберите Custom

   

2. После создания канала скопируйте Идентификатор канала — он понадобится для отправки запросов к API

Шаг 3 — Включите канал и начните работу¶

1. Перейдите в настройки созданного канала
2. Переключите ползунок в разделе «Статус»

3. Нажмите «Сохранить»

   

Готово! Канал Custom создан и активен. Теперь вы можете отправлять сообщения через API — агент будет обрабатывать их автоматически.

API Документация¶

Аутентификация¶

В Headers каждого запроса необходимо добавить ключ:

x-cavuer-api-key: <ваш API ключ>

API ключ можно создать в личном кабинете в разделе Профиль. Узнайте, как создать API ключ.

Отправка сообщений¶

Отправьте POST-запрос по адресу:

https://api.cavuer.com/custom/{{uniqueIdentifier}}/send

Параметр {{uniqueIdentifier}} — идентификатор вашего канала Custom, скопированный на шаге 2.

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

Пример запроса¶

{
    "chatId": "unique-chat-123",
    "content": {
        "text": "Привет! Это сообщение от ИИ-агента."
    },
    "chatType": "user",
    "chatName": "Support Chat"
}

{
    "chatId": "group-789",
    "content": {
        "text": "Посмотрите этот документ",
        "url": "https://example.com/file.pdf",
        "fileName": "instruction.pdf"
    },
    "chatType": "group",
    "participantId": "user-456"
}

Коды ответов¶

Дополнительная настройка¶

Настройка агента в личном кабинете Cavuer¶

Настройте поведение агента в console.cavuer.com:

Полное описание параметров: Настройка агента и канала

Наполнение базы знаний¶

Перейдите в раздел База знаний → нажмите Загрузить данные → укажите название статьи и выберите файл.

Затем в настройках агента установите чек-бокс напротив загруженных статей и сохраните изменения. Подробная информация по работе с Базой знаний.