Get Multiple Votes vote.AttachedVote.getMany

Scope: vote

Who can execute the method: user with read access to votes

The method vote.AttachedVote.getMany returns data for multiple votes based on the identifiers of the entities to which the vote is attached.

Method Parameters

Required parameters are marked with *

Name
type

Description

moduleId*
string

Module identifier, possible values:

  • im for chat poll,
  • blog for feed poll

entityType*
string

Object type, possible values:

  • Bitrix\\Vote\\Attachment\\ImMessageConnector for chat poll,
  • Bitrix\\Vote\\Attachment\\BlogPostConnector for feed poll

entityId*
integer

Array of entity identifiers, possible values:

Maximum 50 entities

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"moduleId":"im","entityType":"Bitrix\\Vote\\Attachment\\ImMessageConnector","entityIds":[1,2,3]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/vote.AttachedVote.getMany
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"moduleId":"im","entityType":"Bitrix\\Vote\\Attachment\\ImMessageConnector","entityIds":[1,2,3],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/vote.AttachedVote.getMany
        
try
        {
            const response = await $b24.callMethod(
                'vote.AttachedVote.getMany',
                {
                    moduleId: 'im',
                    entityType: 'Bitrix\\Vote\\Attachment\\ImMessageConnector',
                    entityIds: [1, 2, 3]
                }
            );
            
            const result = response.getData().result;
            console.log('Data:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'vote.AttachedVote.getMany',
                    [
                        'moduleId' => 'im',
                        'entityType' => 'Bitrix\\Vote\\Attachment\\ImMessageConnector',
                        'entityIds' => [1, 2, 3]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "vote.AttachedVote.getMany",
            {
                "moduleId": "im",
                "entityType": "Bitrix\\Vote\\Attachment\\ImMessageConnector",
                "entityIds": [1, 2, 3]
            },
            function(result)
            {
                if(result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.dir(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'vote.AttachedVote.getMany',
            [
                'moduleId' => 'im',
                'entityType' => 'Bitrix\\Vote\\Attachment\\ImMessageConnector',
                'entityIds' => [1, 2, 3]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Response Handling

HTTP status: 200

{
            "result": {
              "items": [
                {
                  "ID": 1,
                  "VOTE_ID": 1,
                  "COUNTER": 1,
                  "QUESTIONS": {
                    "1": {
                      "ID": "1",
                      "ACTIVE": "Y",
                      "TIMESTAMP_X": "2025-08-05T09:08:31+02:00",
                      "VOTE_ID": "1",
                      "C_SORT": "10",
                      "COUNTER": "1",
                      "QUESTION": "How are you?",
                      "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+02:00",
                          "QUESTION_ID": "1",
                          "C_SORT": "10",
                          "IMAGE_ID": null,
                          "MESSAGE": "Great!",
                          "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+02:00",
                          "QUESTION_ID": "1",
                          "C_SORT": "20",
                          "IMAGE_ID": null,
                          "MESSAGE": "Best of all!",
                          "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+02:00",
                          "QUESTION_ID": "1",
                          "C_SORT": "30",
                          "IMAGE_ID": null,
                          "MESSAGE": "What's up??",
                          "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": "1",
                        "EVENT_QUESTION_ID": "1",
                        "ANSWER_ID": "1",
                        "ID": "1",
                        "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": 1754402559.791454,
              "finish": 1754402559.82089,
              "duration": 0.02943587303161621,
              "processing": 0.017578840255737305,
              "date_start": "2025-08-05T17:02:39+02:00",
              "date_finish": "2025-08-05T17:02:39+02:00",
              "operating_reset_at": 1754403159,
              "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Root element of the response. Contains information about the requested votes, structure described below

time
time

Information about the request execution time

Response Element result

Name
type

Description

ID
integer

Identifier of the attached vote

VOTE_ID
integer

Identifier of the vote itself

COUNTER
integer

Vote counter

QUESTIONS
array

Array of poll questions

ANONYMITY
integer

Level of poll anonymity

OPTIONS
integer

Availability of revoting

userAnswerMap
array

Map of the current user's answers

canEdit
bool

Can the current user edit the poll

canVote
bool

Can the current user vote

canRevote
bool

Can the current user revote

isVoted
bool

Has the current user already voted

signedAttachId
string

Signed identifier

resultUrl
string

URL to view the poll results

downloadUrl
string

URL to download the poll results

entityId
integer

Identifier of the entity to which the poll is attached

isFinished
bool

Is the poll completed

Error Handling

HTTP status: 400

{
            "error": "",
            "error_description": "Too many entity ids"
        }
        

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 Types

Error

Description

Too many entity ids

Exceeded the limit of identifiers, maximum 50

Attach with entityId X not found

Vote with the specified identifier not found

Attach with entityId X read access denied

No permission to read the vote with the specified identifier

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