Остановить голосование vote.AttachedVote.stop

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: vote

Кто может выполнять метод: пользователь с правами редактирования голосования

Метод vote.AttachedVote.stop останавливает активное голосование, запрещая дальнейшее участие в нем.

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

Доступно три варианта вызова метода.

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

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

Название
тип

Описание

attachId*
integer

Идентификатор прикрепленного голосования, получить можно методами 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

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

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

Название
тип

Описание

signedAttachId*
string

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

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"attachId":**put_attach_id**}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/vote.AttachedVote.stop
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"attachId":**put_attach_id**,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/vote.AttachedVote.stop
        
try
        {
            const response = await $b24.callMethod(
                'vote.AttachedVote.stop',
                {
                    attachId: **put_attach_id**
                }
            );
            
            const result = response.getData().result;
            console.log('Stopped vote with ID:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'vote.AttachedVote.stop',
                    [
                        'attachId' => **put_attach_id**
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error stopping attached vote: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "vote.AttachedVote.stop",
            {
                "attachId": **put_attach_id**
            },
            function(result)
            {
                if(result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.dir(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'vote.AttachedVote.stop',
            [
                'attachId' => **put_attach_id**
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": [],
            "time": {
                "start": 1712132792.910734,
                "finish": 1712132793.530359,
                "duration": 0.6196250915527344,
                "processing": 0.032338857650756836,
                "date_start": "2024-04-03T10:26:32+02:00",
                "date_finish": "2024-04-03T10:26:33+02:00"
            }
        }

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

Название
тип

Описание

result
array

Пустой массив при успешном выполнении операции

time
time

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

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

HTTP-статус: 4xx

{
            "error": "ATTACH_NOT_FOUND",
            "error_description": "Attach not found"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

ATTACH_NOT_FOUND

Голосование не найдено

ATTACH_READ_ACCESS_DENIED

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

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

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

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

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

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

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

Предыдущая
Возобновить голосование
Следующая
Получить данные прикрепленного голосования