Для AI-агентов: markdown этой страницы — /docs-content/chats/copilot/vote.md индекс документации — /llms.txt

Оценить ответ

POST /v1/chats/messages/:messageId/vote

Ставит сообщению оценку «нравится» или «не нравится». Предназначен для оценки ответов CoPilot.

Параметры

Параметр Тип Обяз. Описание
messageId (path) number да ID сообщения. Получить: data.messages[].id чернового чата или ленты в режиме v2

Параметры строки запроса не принимаются и отклоняются с 400 INVALID_PARAMS.

Поля запроса (body)

Поле Тип Обяз. Описание
value string да Оценка: like или dislike

Другие поля тела отклоняются с 400 INVALID_PARAMS.

Примеры

curl — личный ключ

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/chats/messages/9002/vote \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"value": "like"}'

curl — OAuth-приложение

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/chats/messages/9002/vote \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"value": "like"}'

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/messages/9002/vote', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ value: 'like' }),
})

const { success, data } = await res.json()
console.log('Оценка отправлена:', data.result)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/messages/9002/vote', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ value: 'like' }),
})

const { success, data } = await res.json()
console.log('Оценка отправлена:', data.result)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.result boolean true — оценка отправлена

Пример ответа

JSON 
{
  "success": true,
  "data": {
    "result": true
  }
}

Пример ответа при ошибке

400 — недопустимое значение value:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "`value` must be `like` or `dislike`."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS messageId не является положительным целым числом, нет value или оно не like и не dislike, передано другое поле тела или параметр строки запроса. Проверяется до обращения к Битрикс24
404 ENTITY_NOT_FOUND Битрикс24 вернул «не найдено». Код портала — в error.b24Code
422 BITRIX_ERROR Битрикс24 вернул ошибку. Код портала — в error.b24Code
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения — вызов может сделать владельца ключа участником чата
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24

Полный список общих ошибок API — Ошибки.

Известные особенности

Вызов может сделать вас участником. Если чат сообщения разрешает автовступление — например, чат комментариев, коллаб или чат задачи, — вызов добавляет текущего пользователя в участники, как открытие чата в интерфейсе Битрикс24. Поэтому вызов считается изменяющим.

Оценка любого сообщения. Эндпоинт принимает оценку любого сообщения и отвечает result: true. Учитывается оценка только ответов CoPilot в чате CoPilot. Прочитать оценку обратно этот эндпоинт не позволяет.

Смотрите также