Get Counters im.counters.get

Scope: im

Who can execute the method: any user

The method im.counters.get retrieves the counters for unread messages and notifications for the current user.

Method Parameters

No parameters.

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 '{}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.counters.get

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.counters.get

try
        {
            const response = await $b24.callMethod('im.counters.get', {});
            console.log(response.getData().result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call('im.counters.get', []);
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            'im.counters.get',
            {},
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call('im.counters.get', []);
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "TYPE": {
                    "ALL": 5,
                    "NOTIFY": 4,
                    "CHAT": 0,
                    "LINES": 0,
                    "DIALOG": 1,
                    "MESSENGER": 1
                },
                "CHAT": [],
                "CHAT_MUTED": {
                    "1317": 1,
                    "1319": 1
                },
                "CHAT_UNREAD": [],
                "LINES": [],
                "DIALOG": {
                    "547": 1
                },
                "DIALOG_UNREAD": []
            },
            "time": {
                "start": 1772010465,
                "finish": 1772010465.508917,
                "duration": 0.5089170932769775,
                "processing": 0,
                "date_start": "2026-02-25T12:07:45+01:00",
                "date_finish": "2026-02-25T12:07:45+01:00",
                "operating_reset_at": 1772011065,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root object with counters
TYPE `object`	Total counters by type (detailed description)
CHAT `array`	Counters for chats. Key — chat ID, value — number of unread messages
CHAT_MUTED `object`	Counters for chats with notifications disabled. Key — chat ID, value — number of unread messages
CHAT_UNREAD `array`	Counters for chats marked as "Unread"
LINES `array`	Counters for open line chats
DIALOG `object`	Counters for one-on-one dialogs. Key — user ID, value — number of unread messages
DIALOG_UNREAD `array`	Counters for one-on-one dialogs marked as "Unread"
time `time`	Information about the request execution time

TYPE Object

Name `type`	Description
ALL `integer`	Total number of unread messages and notifications
CHAT `integer`	Total number of unread messages in chats
DIALOG `integer`	Total number of unread messages in dialogs
LINES `integer`	Total number of unread messages in open lines
NOTIFY `integer`	Total number of unread notifications
MESSENGER `integer`	Total number of unread messages in the messenger (excluding notifications)

Error Handling

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

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

Get List of Current User's Colleagues

Get IM API Revisions

Get Counters im.counters.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

TYPE ObjectTYPE Object

Error HandlingError Handling

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning