118  /  166

im.counters.get

Просмотров: 14506
Дата последнего изменения: 19.11.2021
Александр Суворов
Сложность урока:
3 уровень - средняя сложность. Необходимо внимание и немного подумать.
1
2
3
4
5

Получение счетчиков

Ревизия Получить информацию о текущей ревизии API (версии платформы) – im.revision.get : 18

Параметры

Нет

Вызов метода

JavaScript

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

PHP

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

Пример ответа

{    
	"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 – суммарный счетчик уведомлений

Обратите внимание! Метод указан с использованием функции restCommand - это метод отправки данных в Битрикс24, данный метод есть в примере ЭхоБота, и представлен здесь в качестве примера. Вы можете использовать свою функцию или javascript-метод BX24.callMethod или bitrix24-php-sdk.



2
Курсы разработаны в компании «1С-Битрикс»
Доступна новая документация по REST: понятнее описания, больше примеров, удобнее поиск
Перейти