Создать и отправить голосование в чат vote.Integration.Im.send

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: vote

Кто может выполнять метод: любой пользователь

Метод vote.Integration.Im.send создает и отправляет голосование в указанный чат мессенджера.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

chatId*
integer

Идентификатор чата, в который отправляется голосование. Получить можно методами im.chat.add, im.chat.get, im.recent.get, im.recent.list

IM_MESSAGE_VOTE_DATA*
object

Данные голосования с вопросом и вариантами ответов. Структура описана ниже

templateId
string

Уникальный идентификатор запроса, требований к формату нет.
Цель идентификатора — защита от дублирования. Если из-за сбоя сети запрос отправится повторно с тем же templateId, сервер поймет это и создаст опрос только один раз

Параметр IM_MESSAGE_VOTE_DATA

Обязательные параметры отмечены *

Название
тип

Описание

QUESTIONS*
array

Массив вопросов голосования, структура описана ниже. Максимум 1 вопрос

ANONYMITY
integer

Анонимность голосования. Возможные значения:

  • 0 — неанонимное голосование,
  • 1 — анонимное голосование.

Значение по умолчанию: 0, публичное голосование

OPTIONS
integer

Разрешить переголосование. Возможные значения:

  • 0 — нет,
  • 1 — да.

Значение по умолчанию: 0, переголосование запрещено

Структура вопроса в QUESTIONS

Название
тип

Описание

QUESTION
string

Текст вопроса

FIELD_TYPE
integer

Тип поля для ответа. Возможные значения:

  • 0 — радиокнопки, один вариант ответа,
  • 1 — чекбоксы, множественный выбор.

Значение по умолчанию: 0

ANSWERS
array

Массив вариантов ответов, структура описана ниже. Минимум 2 варианта, максимум 10

Структура ответа в ANSWERS

Название
тип

Описание

MESSAGE
string

Текст варианта ответа

Примеры кода

Как использовать примеры в документации

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>
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>';

Обработка ответа

HTTP-статус: 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+03:00",
        "date_finish": "2025-08-06T11:46:57+03:00",
        "operating_reset_at": 1754470616,
        "operating": 0.3257129192352295
    }
}

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

Название
тип

Описание

result
object

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

time
time

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

Элемент ответа result

Название
тип

Описание

messageId
integer

Идентификатор отправленного сообщения в чате

voteId
integer

Идентификатор созданного голосования

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

403

Создание опроса недоступно

400

Введите вопрос и варианты ответов

400

Максимальное количество вопросов: 1

400

Минимальное количество ответов: 2

400

Максимальное количество ответов: 10

400

Не удалось сохранить данные опроса. Попробуйте ещё раз

403

Недостаточно прав для создания опроса

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

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

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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