vote.AttachedVote.vote — метод REST API Битрикс24

Описание

Метод vote.AttachedVote.vote позволяет проголосовать в прикрепленном голосовании.

Параметры

1. Через идентификатор прикрепленного опроса

attachId integer обязательный

Идентификатор прикрепленного голосования, получить можно методами vote.AttachedVote.get или vote.AttachedVote.getMany

ballot object обязательный

Данные голоса в формате:

{
    "1": ["2", "3"],
    "2": ["5"]
}

Ключ - ID вопроса, значение - массив ID выбранных ответов. Получить ID вопроса и ответов можно методами vote.AttachedVote.get или vote.AttachedVote.getMany.
Несколько вопросов в одном голосовании доступно в постах ленты, в сообщении чата в опросе доступен только один вопрос

2. Через элемент с опросом

moduleId string обязательный

Идентификатор модуля, возможные значения:
- Im для опроса в чате,
- blog для опроса в ленте

entityType string обязательный

Тип объекта, возможные значения:
- Bitrix\\Vote\\Attachment\\ImMessageConnector для опроса в чате,
- Bitrix\\Vote\\Attachment\\BlogPostConnector для опроса в ленте

entityId integer обязательный

Идентификатор элемента, возможные значения:
- id сообщения чата с опросом, получить можно методом vote.Integration.Im.send,
- id поста с опросом в ленте, получить можно методом log.blogpost.get

ballot object обязательный

Данные голоса в формате:

{
    "1": ["2", "3"],
    "2": ["5"]
}

Ключ - ID вопроса, значение - массив ID выбранных ответов. Получить ID вопроса и ответов можно методами vote.AttachedVote.get или vote.AttachedVote.getMany.
Несколько вопросов в одном голосовании доступно в постах ленты, в сообщении чата в опросе доступен только один вопрос

3. Через подписанный идентификатор

signedAttachId string обязательный

Подписанный идентификатор прикрепления, получить можно методом vote.AttachedVote.get, параметр ответа signedAttachId

ballot object обязательный

Данные голоса в формате:

{
    "1": ["2", "3"],
    "2": ["5"]
}

Ключ - ID вопроса, значение - массив ID выбранных ответов. Получить ID вопроса и ответов можно методами vote.AttachedVote.get или vote.AttachedVote.getMany.
Несколько вопросов в одном голосовании доступно в постах ленты, в сообщении чата в опросе доступен только один вопрос

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"attachId":**put_attach_id**,"ballot":{"1":["2","3"],"2":["5"]}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/vote.AttachedVote.vote

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"attachId":**put_attach_id**,"ballot":{"1":["2","3"],"2":["5"]},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/vote.AttachedVote.vote

// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type VoteResult = {
  attach: {
    ID: number
    VOTE_ID: number
    COUNTER: number
    QUESTIONS: Record<string, unknown>
    ANONYMITY: number
    OPTIONS: number
    userAnswerMap: Record<string, unknown>
    canEdit: boolean
    canVote: boolean
    canRevote: boolean
    isVoted: boolean
    signedAttachId: string
    resultUrl: string
    downloadUrl: string
    entityId: number
    isFinished: boolean
  }
}

try {
  const response = await $b24.actions.v2.call.make<VoteResult>({
    method: 'vote.AttachedVote.vote',
    params: {
      attachId: 1,
      ballot: {
        '1': ['2', '3'],
        '2': ['5'],
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Vote submitted, attach ID:', result.attach.ID, 'isVoted:', result.attach.isVoted)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function castVote() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'vote.AttachedVote.vote',
        params: {
          attachId: 1,
          ballot: {
            '1': ['2', '3'],
            '2': ['5'],
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Vote submitted, attach ID:', result.attach.ID, 'isVoted:', result.attach.isVoted)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', castVote)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.vote.attached_vote.vote(
        attach_id=1,
        ballot={
            "1": [
                "2",
                "3",
            ],
            "2": [
                "5",
            ],
        },
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

try {
    $response = $b24Service
        ->core
        ->call(
            'vote.AttachedVote.vote',
            [
                'attachId' => **put_attach_id**,
                'ballot' => [
                    '1' => ['2', '3'],
                    '2' => ['5']
                ]
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error adding product row: ' . $e->getMessage();
}

BX24.callMethod(
    "vote.AttachedVote.vote",
    {
        "attachId": **put_attach_id**,
        "ballot": {
            "1": ["2", "3"],
            "2": ["5"]
        }
    },
    function(result)
    {
        if(result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.dir(result.data());
        }
    }
);

require_once('crest.php');

$result = CRest::call(
    'vote.AttachedVote.vote',
    [
        'attachId' => **put_attach_id**,
        'ballot' => [
            '1' => ['2', '3'],
            '2' => ['5']
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

Ответ

HTTP-статус: 200

{
    "result": {
        "attach": {
            "ID": 1,
            "VOTE_ID": 1,
            "COUNTER": 1,
            "QUESTIONS": {
                "1": {
                    "ID": "1",
                    "ACTIVE": "Y",
                    "TIMESTAMP_X": "2025-08-05T09:08:31+03:00",
                    "VOTE_ID": "1",
                    "C_SORT": "10",
                    "COUNTER": 1,
                    "QUESTION": "Как дела?",
                    "QUESTION_TYPE": "text",
                    "IMAGE_ID": null,
                    "DIAGRAM": "Y",
                    "DIAGRAM_TYPE": "histogram",
                    "REQUIRED": "N",
                    "FIELD_TYPE": "0",
                    "FIELD_NAME": "bx_vote_event[1][BALLOT][1]",
                    "IMAGE": null,
                    "ANSWERS": {
                        "1": {
                            "ID": "1",
                            "ACTIVE": "Y",
                            "TIMESTAMP_X": "2025-08-05T09:08:31+03:00",
                            "QUESTION_ID": "1",
                            "C_SORT": "10",
                            "IMAGE_ID": null,
                            "MESSAGE": "Отлично!",
                            "MESSAGE_TYPE": "text",
                            "COUNTER": 1,
                            "FIELD_TYPE": "0",
                            "FIELD_WIDTH": "0",
                            "FIELD_HEIGHT": "0",
                            "FIELD_PARAM": null,
                            "COLOR": "",
                            "REACTION": "",
                            "~FIELD_NAME": "bx_vote_event[1][BALLOT][1]",
                            "FIELD_NAME": "bx_vote_event[1][BALLOT][1]",
                            "MESSAGE_FIELD_NAME": "bx_vote_event[1][MESSAGE][1][1]",
                            "~PERCENT": 100,
                            "PERCENT": 100
                        },
                        "3": {
                            "ID": "3",
                            "ACTIVE": "Y",
                            "TIMESTAMP_X": "2025-08-05T09:08:31+03:00",
                            "QUESTION_ID": "1",
                            "C_SORT": "20",
                            "IMAGE_ID": null,
                            "MESSAGE": "Лучше всех!",
                            "MESSAGE_TYPE": "text",
                            "COUNTER": "0",
                            "FIELD_TYPE": "0",
                            "FIELD_WIDTH": "0",
                            "FIELD_HEIGHT": "0",
                            "FIELD_PARAM": null,
                            "COLOR": "",
                            "REACTION": "",
                            "~FIELD_NAME": "bx_vote_event[1][BALLOT][1]",
                            "FIELD_NAME": "bx_vote_event[1][BALLOT][1]",
                            "MESSAGE_FIELD_NAME": "bx_vote_event[1][MESSAGE][1][3]",
                            "~PERCENT": 0,
                            "PERCENT": 0
                        },
                        "5": {
                            "ID": "5",
                            "ACTIVE": "Y",
                            "TIMESTAMP_X": "2025-08-05T09:08:31+03:00",
                            "QUESTION_ID": "1",
                            "C_SORT": "30",
                            "IMAGE_ID": null,
                            "MESSAGE": "Какие дела??",
                            "MESSAGE_TYPE": "text",
                            "COUNTER": "0",
                            "FIELD_TYPE": "0",
                            "FIELD_WIDTH": "0",
                            "FIELD_HEIGHT": "0",
                            "FIELD_PARAM": null,
                            "COLOR": "",
                            "REACTION": "",
                            "~FIELD_NAME": "bx_vote_event[1][BALLOT][1]",
                            "FIELD_NAME": "bx_vote_event[1][BALLOT][1]",
                            "MESSAGE_FIELD_NAME": "bx_vote_event[1][MESSAGE][1][5]",
                            "~PERCENT": 0,
                            "PERCENT": 0
                        }
                    }
                }
            },
            "ANONYMITY": 1,
            "OPTIONS": 1,
            "userAnswerMap": {
                "1": {
                    "1": {
                        "EVENT_ID": "27",
                        "EVENT_QUESTION_ID": "27",
                        "ANSWER_ID": "1",
                        "ID": "27",
                        "MESSAGE": ""
                    }
                }
            },
            "canEdit": true,
            "canVote": false,
            "canRevote": true,
            "isVoted": true,
            "signedAttachId": "1.52280488561bf567f33cf03b5ce353e154a9c3552b51b2ffb67be3bb7f26f986",
            "resultUrl": "/vote-result/me7hn922bm011mbf",
            "downloadUrl": "/bitrix/services/main/ajax.php?action=vote.AttachedVote.download&SITE_ID=s1&signedAttachId=1.52280488561bf567f33cf03b5ce353e154a9c3552b51b2ffb67be3bb7f26f986",
            "entityId": 13,
            "isFinished": false
        }
    },
    "time": {
        "start": 1754466663.090774,
        "finish": 1754466663.180457,
        "duration": 0.08968305587768555,
        "processing": 0.07362222671508789,
        "date_start": "2025-08-06T10:51:03+03:00",
        "date_finish": "2025-08-06T10:51:03+03:00",
        "operating_reset_at": 1754467263,
        "operating": 0
    }
}

Возвращаемые данные

result object

Корневой элемент ответа. Содержит объект attach с информацией о голосовании, структура описана ниже

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 403

{
    "error": "403",
    "error_description": "Опрос неактивен."
}

Код	Описание	Значение
`100`	Bitrix\Vote\Attach All parameters in the constructor must have real class type	Не передан или некорректен обязательный параметр. Передайте `attachId`, `signedAttachId` либо связку `moduleId` + `entityType` + `entityId`
`400`	Cannot save poll.	Не удалось сохранить голосование
`403`	The poll is inactive.	Опрос неактивен
`ATTACH_READ_ACCESS_DENIED`	Attach read access denied	Нет прав для участия в голосовании

Описание

Параметры

1. Через идентификатор прикрепленного опроса

2. Через элемент с опросом

3. Через подписанный идентификатор

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

Ответ

Возвращаемые данные

Обработка ошибок

Продолжите изучение