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

Список проголосовавших за ответ

GET /v1/polls/:pollId/answers/:answerId/voters

Возвращает участников, выбравших конкретный ответ, страницами по 50. Видимость определяет Битрикс24, в анонимном опросе личности участников недоступны никому.

Сначала читается опрос для проверки видимости итогов по правилам Битрикс24. При resultsVisible: false возвращается 403 RESULTS_HIDDEN, список участников не запрашивается. Это чтение подписывает пользователя на события, поэтому ключ Коворка «портал только для чтения» получает 403 COWORK_READONLY до обращения к порталу.

Скоуп: vote. Ограничения ключей — Опросы.

Параметры

Параметр Тип Обяз. По умолч. Описание
ПараметрpollId (path) Типnumber Обяз.да По умолч.— ОписаниеПоложительный ID прикрепления: поле id из поиска опросов, не voteId
ПараметрanswerId (path) Типnumber Обяз.да По умолч.— ОписаниеПоложительный ID из questions[].answers[].id опроса
Параметрpage (query) Типnumber Обяз.нет По умолч.1 ОписаниеПоложительное целое. Фиксированная страница — 50 участников

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/polls/25/answers/85/voters?page=1" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/polls/25/answers/85/voters?page=1" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/polls/25/answers/85/voters?page=1', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})
const result = await res.json()

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/polls/25/answers/85/voters?page=1', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const result = await res.json()

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue при успехе
Полеdata Типarray ОписаниеУчастники выбранного ответа
Полеdata[].id Типnumber ОписаниеID пользователя
Полеdata[].name Типstring ОписаниеИмя
Полеdata[].position Типstring | null ОписаниеДолжность
Полеdata[].avatarUrl Типstring | null ОписаниеСсылка на аватар
Полеmeta.page Типnumber ОписаниеТекущая страница
Полеmeta.pageSize Типnumber Описание50
Полеmeta.total Типnumber ОписаниеОбщее количество из Битрикс24
Полеmeta.nextPage Типnumber | null ОписаниеСледующая страница, null на последней

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

JSON 
{
  "success": true,
  "data": [
    { "id": 1317, "name": "Anna Smith", "position": null, "avatarUrl": "https://example.bitrix24.ru/upload/main/avatar.png" }
  ],
  "meta": {
    "page": 1,
    "pageSize": 50,
    "total": 1,
    "nextPage": null
  }
}

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

400 — page равен нулю:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Invalid poll parameters."
  }
}

Ошибки

HTTP Код Причина и действие
HTTP400 КодINVALID_PARAMS Причина и действиеpollId, answerId или page не положительное целое число
HTTP401 КодTOKEN_MISSING Причина и действиеНет пользовательской сессии Битрикс24
HTTP403 КодSCOPE_DENIED Причина и действиеНет скоупа vote
HTTP403 КодRESULTS_HIDDEN Причина и действиеИтоги закрыты по правилам Битрикс24
HTTP403 КодPOLL_ACCESS_DENIED Причина и действиеБитрикс24 отказал в чтении опроса при проверке видимости итогов
HTTP403 КодCOWORK_READONLY Причина и действиеОперация запрещена для ключа Коворка «портал только для чтения»
HTTP404 КодPOLL_NOT_FOUND Причина и действиеОпрос не найден или недоступен
HTTP404 КодANSWER_NOT_FOUND Причина и действиеБитрикс24 явно отказал в доступе к списку участников ответа
HTTP422 КодBITRIX_ERROR Причина и действиеБитрикс24 отклонил запрос. Если ответа с таким answerId нет в этом опросе, приходит b24Code: "403" с текстом «Internal server error.» — сверьте answerId с questions[].answers[].id опроса

Другие отказы авторизации, лимиты и общие ошибки — Ошибки.

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