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

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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
            const response = await $b24.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
                }
            );
        
            const result = response.getData().result;
            console.log('Created element with ID:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('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 may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

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: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Overview of Methods

Vote in the Attached Vote

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

Method ParametersMethod Parameters

Parameter IM_MESSAGE_VOTE_DATAParameter IM_MESSAGE_VOTE_DATA

Structure of the Question in QUESTIONSStructure of the Question in QUESTIONS

Structure of the Answer in ANSWERSStructure of the Answer in ANSWERS

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Response Element resultResponse Element result

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning