Получить счетчики im.counters.get

Scope: im

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

Метод im.counters.get получает счетчики непрочитанных сообщений и уведомлений для текущего пользователя.

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

Без параметров.

Примеры кода

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

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

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

HTTP-статус: 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+03:00",
                "date_finish": "2026-02-25T12:07:45+03:00",
                "operating_reset_at": 1772011065,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
object

Корневой объект со счетчиками

TYPE
object

Суммарные счетчики по типам (подробное описание)

CHAT
array

Счетчики по чатам. Ключ — идентификатор чата, значение — количество непрочитанных сообщений

CHAT_MUTED
object

Счетчики по чатам с отключенными уведомлениями. Ключ — идентификатор чата, значение — количество непрочитанных сообщений

CHAT_UNREAD
array

Счетчики по чатам с установленной меткой «Не прочитано»

LINES
array

Счетчики по чатам открытых линий

DIALOG
object

Счетчики по диалогам один-на-один. Ключ — идентификатор пользователя, значение — количество непрочитанных сообщений

DIALOG_UNREAD
array

Счетчики по диалогам один-на-один с установленной ручной меткой «Не прочитано»

time
time

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

Объект TYPE

Название
тип

Описание

ALL
integer

Общее количество непрочитанных сообщений и уведомлений

CHAT
integer

Общее количество непрочитанных сообщений в чатах

DIALOG
integer

Общее количество непрочитанных сообщений в диалогах

LINES
integer

Общее количество непрочитанных сообщений в открытых линиях

NOTIFY
integer

Общее количество непрочитанных уведомлений

MESSENGER
integer

Общее количество непрочитанных сообщений в мессенджере (без уведомлений)

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

Название
тип

Описание

error
string

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

error_description
error_description

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

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

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

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

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

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