Create and Send a Vote in Chat vote.Integration.Im.send

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: vote

Who can execute the method: any user

The method vote.Integration.Im.send creates and sends a vote to the specified chat in the messenger.

Method Parameters

Required parameters are marked with *

Name
type

Description

chatId*
integer

The identifier of the chat to which the vote is sent. It can be obtained using the methods im.chat.add, im.chat.get, im.recent.get, im.recent.list

IM_MESSAGE_VOTE_DATA*
object

Vote data containing the question and answer options. The structure is described below

templateId
string

A unique identifier for the request, with no format requirements. The purpose of the identifier is to prevent duplication. If the request is sent again due to a network failure with the same templateId, the server will recognize this and create the vote only once

Parameter IM_MESSAGE_VOTE_DATA

Required parameters are marked with *

Name
type

Description

QUESTIONS*
array

An array of vote questions, the structure is described below. Maximum 1 question

ANONYMITY
integer

Anonymity of the vote. Possible values:

  • 0 — non-anonymous vote,
  • 1 — anonymous vote.

Default value: 0, public vote

OPTIONS
integer

Allow re-voting. Possible values:

  • 0 — no,
  • 1 — yes.

Default value: 0, re-voting is prohibited

Structure of the Question in QUESTIONS

Name
type

Description

QUESTION
string

The text of the question

FIELD_TYPE
integer

The type of field for the answer. Possible values:

  • 0 — radio buttons, one answer option,
  • 1 — checkboxes, multiple choice.

Default value: 0

ANSWERS
array

An array of answer options, the structure is described below. Minimum 2 options, maximum 10

Structure of the Answer in ANSWERS

Name
type

Description

MESSAGE
string

The text of the answer option

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"chatId":**put_chat_id**,"IM_MESSAGE_VOTE_DATA":{"QUESTIONS":[{"QUESTION":"**put_question_title**","FIELD_TYPE":0,"ANSWERS":[{"MESSAGE":"**put_message_content**"},{"MESSAGE":"**put_message_content**"},{"MESSAGE":"**put_message_content**"}]}],"ANONYMITY":0,"OPTIONS":0},"templateId":null}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/vote.Integration.Im.send
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"chatId":**put_chat_id**,"IM_MESSAGE_VOTE_DATA":{"QUESTIONS":[{"QUESTION":"**put_question_title**","FIELD_TYPE":0,"ANSWERS":[{"MESSAGE":"**put_message_content**"},{"MESSAGE":"**put_message_content**"},{"MESSAGE":"**put_message_content**"}]}],"ANONYMITY":0,"OPTIONS":0},"templateId":null,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/vote.Integration.Im.send
        
// 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 VoteIntegrationImSendResult = {
          messageId: number
          voteId: number
        }
        
        try {
          const response = await $b24.actions.v2.call.make<VoteIntegrationImSendResult>({
            method: 'vote.Integration.Im.send',
            params: {
              chatId: 1,
              IM_MESSAGE_VOTE_DATA: {
                QUESTIONS: [
                  {
                    QUESTION: 'What is your favorite color?',
                    FIELD_TYPE: 0,
                    ANSWERS: [
                      { MESSAGE: 'Red' },
                      { MESSAGE: 'Green' },
                      { MESSAGE: 'Blue' },
                    ],
                  },
                ],
                ANONYMITY: 0,
                OPTIONS: 0,
              },
              templateId: null,
            },
            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('Message ID:', result.messageId, 'Vote ID:', result.voteId)
          }
        } 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 sendImVote() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'vote.Integration.Im.send',
                params: {
                  chatId: 1,
                  IM_MESSAGE_VOTE_DATA: {
                    QUESTIONS: [
                      {
                        QUESTION: 'What is your favorite color?',
                        FIELD_TYPE: 0,
                        ANSWERS: [
                          { MESSAGE: 'Red' },
                          { MESSAGE: 'Green' },
                          { MESSAGE: 'Blue' },
                        ],
                      },
                    ],
                    ANONYMITY: 0,
                    OPTIONS: 0,
                  },
                  templateId: null,
                },
                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('Message ID:', result.messageId, 'Vote ID:', result.voteId)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', sendImVote)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.vote.integration.im.send(
                chat_id=1,
                im_message_vote_data={
                    "QUESTIONS": [
                        {
                            "QUESTION": "Question title",
                            "FIELD_TYPE": 0,
                            "ANSWERS": [
                                {
                                    "MESSAGE": "Answer 1",
                                },
                                {
                                    "MESSAGE": "Answer 2",
                                },
                                {
                                    "MESSAGE": "Answer 3",
                                },
                            ],
                        },
                    ],
                    "ANONYMITY": 0,
                    "OPTIONS": 0,
                },
                template_id=None,
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'vote.Integration.Im.send',
                    [
                        'chatId' => **put_chat_id**,
                        'IM_MESSAGE_VOTE_DATA' => [
                            'QUESTIONS' => [
                                [
                                    'QUESTION' => '**put_question_title**',
                                    'FIELD_TYPE' => 0,
                                    'ANSWERS' => [
                                        ['MESSAGE' => '**put_message_content**'],
                                        ['MESSAGE' => '**put_message_content**'],
                                        ['MESSAGE' => '**put_message_content**']
                                    ]
                                ]
                            ],
                            'ANONYMITY' => 0,
                            'OPTIONS' => 0
                        ],
                        'templateId' => null
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error sending vote message: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "vote.Integration.Im.send",
            {
                "chatId": **put_chat_id**,
                "IM_MESSAGE_VOTE_DATA": {
                    "QUESTIONS": [
                        {
                            "QUESTION": "**put_question_title**",
                            "FIELD_TYPE": 0,
                            "ANSWERS": [
                                {
                                    "MESSAGE": "**put_message_content**"
                                },
                                {
                                    "MESSAGE": "**put_message_content**"
                                },
                                {
                                    "MESSAGE": "**put_message_content**"
                                }
                            ]
                        }
                    ],
                    "ANONYMITY": 0,
                    "OPTIONS": 0
                },
                "templateId": null
            },
            function(result)
            {
                if(result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.dir(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'vote.Integration.Im.send',
            [
                'chatId' => **put_chat_id**,
                'IM_MESSAGE_VOTE_DATA' => [
                    'QUESTIONS' => [
                        [
                            'QUESTION' => '**put_question_title**',
                            'FIELD_TYPE' => 0,
                            'ANSWERS' => [
                                ['MESSAGE' => '**put_message_content**'],
                                ['MESSAGE' => '**put_message_content**'],
                                ['MESSAGE' => '**put_message_content**']
                            ]
                        ]
                    ],
                    'ANONYMITY' => 0,
                    'OPTIONS' => 0
                ],
                'templateId' => null
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Response Handling

HTTP status: 200

{
            "result": {
                "messageId": 23,
                "voteId": 7
            },
            "time": {
                "start": 1754470016.954889,
                "finish": 1754470017.043656,
                "duration": 0.08876705169677734,
                "processing": 0.07431983947753906,
                "date_start": "2025-08-06T11:46:56+02:00",
                "date_finish": "2025-08-06T11:46:57+02:00",
                "operating_reset_at": 1754470616,
                "operating": 0.3257129192352295
            }
        }
        

Returned Data

Name
type

Description

result
object

The root element of the response. Contains information about the message and vote numbers, the structure is described below

time
time

Information about the execution time of the request

Response Element result

Name
type

Description

messageId
integer

The identifier of the sent message in the chat

voteId
integer

The identifier of the created vote

Error Handling

HTTP status: 400

{
            "error": "400",
            "error_description": "Access denied"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

403

Creating a survey is not available

400

Please enter a question and answer options

400

Maximum number of questions: 1

400

Minimum number of answers: 2

400

Maximum number of answers: 10

400

Failed to save survey data. Please try again

403

Insufficient rights to create a survey

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning