Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Получить счетчики im.counters.get». Вы узнаете экспертные методики работы с im.counters.get и научитесь избегать типичных ошибок начинающих разработчиков.

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

Тут может не хватать некоторых данных — дополним в ближайшее время

• нужны правки под стандарт написания
• отсутствуют примеры
• отсутствует ответ в случае ошибки

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

Метод im.counters.get получает счетчики.

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

Практические примеры использования в коде

• JS

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

• PHP

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

• BX24.js

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

• PHP CRest

    $result = restCommand(
        'im.counters.get',
        Array(),
        $_REQUEST[
            "auth"
        ]
    );    

• cURL

// пример для cURL

Ответ в случае успеха

{    
    "result": {
        "CHAT": {"18": 1},
        "DIALOG": {"1": 3, "5": 1},
        "LINES": {},
        "TYPE": {
            "ALL": 5,
            "CHAT": 1,
            "DIALOG": 4,
            "LINES": 0,
            "NOTIFY": 0
        }
    }
}

Описание ключей

• CHAT – объект, содержащий список чатов, в которых есть непрочитанные сообщения.
• DIALOG – объект, содержащий список диалогов, в которых есть непрочитанные сообщения.
• LINES – объект, содержащий список чатов открытых линий, в которых есть непрочитанные сообщения.
• TYPE – объект, содержит суммарные счетчики:
• ALL – суммарный счетчик всех сущностей.
• CHAT – суммарный счетчик чатов.
• DIALOG – суммарный счетчик диалогов.
• LINES – суммарный счетчик открытых линий.
• NOTIFY – суммарный счетчик уведомлений.