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

Отозвать голос

DELETE /v1/polls/:pollId/vote

Отзывает голос текущего пользователя и возвращает обновлённый опрос.

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

Параметры

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

Тело запроса не требуется.

Запись выполняется один раз, без автоматического повтора. После неизвестного исхода прочитайте опрос и решите, нужна ли повторная запись.

Примеры

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

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

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/polls/25/vote" \
  -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/vote', {
  method: 'DELETE',
  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/vote', {
  method: 'DELETE',
  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": 25,
    "voteId": 33,
    "status": "active",
    "anonymous": false,
    "allowRevote": true,
    "resultsHidden": false,
    "resultsVisible": false,
    "votersCount": null,
    "questions": [
      {
        "id": 35,
        "text": "When?",
        "multipleChoice": false,
        "required": false,
        "votesCount": null,
        "answers": [
          { "id": 85, "text": "Now", "votesCount": null, "percent": null, "voters": [], "votersComplete": false },
          { "id": 87, "text": "Later", "votesCount": null, "percent": null, "voters": [], "votersComplete": false }
        ]
      }
    ],
    "myVote": { "voted": false, "answerIds": [] },
    "permissions": { "canVote": true, "canRevote": true, "canManage": true }
  }
}

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

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

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

Ошибки

HTTP Код Причина и действие
HTTP400 КодINVALID_PARAMS Причина и действиеpollId не положительное целое число
HTTP401 КодTOKEN_MISSING Причина и действиеНет пользовательской сессии Битрикс24
HTTP403 КодSCOPE_DENIED Причина и действиеНет скоупа vote
HTTP403 КодCOWORK_READONLY Причина и действиеОперация запрещена для ключа Коворка «портал только для чтения»
HTTP403 КодWRITE_BLOCKED_READONLY_KEY Причина и действиеКлюч разрешает только чтение
HTTP404 КодPOLL_NOT_FOUND Причина и действиеОпрос не найден или недоступен
HTTP409 КодPOLL_FINISHED Причина и действиеБитрикс24 сообщил, что опрос завершён. Остановленный опрос может ответить и 200 без отзыва — см. «Известные особенности»
HTTP403 КодPOLL_ACCESS_DENIED Причина и действиеБитрикс24 запретил операцию
HTTP422 КодBITRIX_ERROR Причина и действиеБитрикс24 отклонил запрос, например метод недоступен в этой версии
HTTP502 КодPOLL_RECALL_OUTCOME_UNKNOWN Причина и действиеЗапрос ушёл в Битрикс24, а исход не подтверждён: таймаут, обрыв соединения или ответ «Internal server error.». Прочитайте опрос и сверьте myVote, прежде чем повторять

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

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

  • Остановленный опрос. Отзыв в остановленном опросе не выполняется, но ответ приходит 200 с myVote.voted: false и status: "active". Это не состояние опроса: голос остаётся на месте. После отзыва в опросе, который мог быть остановлен, проверьте status и myVote чтением опроса.
  • Голоса нет. Отзыв, когда пользователь не голосовал, отвечает 200 и ничего не меняет.

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