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

Получить опрос

GET /v1/polls/:pollId

Возвращает опрос по ID прикрепления. Включает активные вопросы, ответы, счётчики, текущий голос и права.

Итоги закрываются по правилам Битрикс24: при resultsVisible: false счётчики и проценты равны null, voters пуст, votersComplete: false. Правила видимости: объект опроса.

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

Параметры

Параметр Тип Обяз. По умолч. Описание
ПараметрpollId (path) Типnumber Обяз.да По умолч.— ОписаниеПоложительный ID прикрепления: поле id из поиска опросов, не voteId

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/polls/7" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/polls/7" \
  -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/7', {
  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/7', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const result = await res.json()

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue при успехе
Полеdata Типobject ОписаниеОбъект опроса

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

Иллюстрация формы ответа по нормализатору и тестовым данным, а не ответ живого портала.

JSON 
{
  "success": true,
  "data": {
    "id": 7,
    "voteId": 8,
    "status": "active",
    "anonymous": true,
    "allowRevote": true,
    "resultsHidden": true,
    "resultsVisible": true,
    "votersCount": 3,
    "questions": [
      {
        "id": 10,
        "text": "First",
        "multipleChoice": false,
        "required": false,
        "votesCount": 0,
        "answers": [
          {
            "id": 11,
            "text": "One",
            "votesCount": 0,
            "percent": 0
          },
          {
            "id": 12,
            "text": "Two",
            "votesCount": 0,
            "percent": 0
          }
        ]
      },
      {
        "id": 20,
        "text": "Second",
        "multipleChoice": true,
        "required": true,
        "votesCount": 2,
        "answers": [
          {
            "id": 22,
            "text": "A",
            "votesCount": 2,
            "percent": 100
          },
          {
            "id": 23,
            "text": "B",
            "votesCount": 0,
            "percent": 0
          }
        ]
      }
    ],
    "myVote": {
      "voted": true,
      "answerIds": [
        22
      ]
    },
    "permissions": {
      "canVote": false,
      "canRevote": true,
      "canManage": true
    }
  }
}

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

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

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

Ошибки

HTTP Код Причина и действие
HTTP400 КодINVALID_PARAMS Причина и действиеНеверный ID или параметр запроса
HTTP401 КодTOKEN_MISSING Причина и действиеНет пользовательской сессии Битрикс24
HTTP403 КодSCOPE_DENIED Причина и действиеНет скоупа vote
HTTP403 КодCOWORK_READONLY Причина и действиеОперация запрещена для ключа Коворка «портал только для чтения»
HTTP404 КодPOLL_NOT_FOUND Причина и действиеОпрос не найден или недоступен
HTTP403 КодPOLL_ACCESS_DENIED Причина и действиеБитрикс24 запретил операцию
HTTP422 КодBITRIX_ERROR Причина и действиеБитрикс24 отклонил запрос, например метод недоступен в этой версии

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

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