84  /  108

im.recent.get

Просмотров: 483 (Статистика ведётся с 06.02.2017)
Александр Суворов
Сложность урока:
4 уровень - сложно, требуется сосредоточится, внимание деталям и точному следованию инструкции.
1
2
3
4
5

Список последних диалогов пользователя

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

Параметры

Параметр Пример Обязат. Описание Ревизия
SKIP_OPENLINES N Нет Пропускать чаты открытых линий 18
SKIP_CHAT N Нет Пропускать чаты 18
SKIP_DIALOG N Нет Пропускать диалоги один-на-один 18
LAST_UPDATE 2019-07-11T10:45:31+02:00 Нет Ограничение выборки для минимизации переданных данных, дата в формате ATOM 23

Вызов метода

JavaScript

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

PHP

$result = restCommand('im.user.status.idle.start', Array(
	'SKIP_OPENLINES' => 'Y'
), $_REQUEST["auth"]);

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

{
	"result": [
		{
			"id": "1",
		 	"type": "user",
		 	"avatar": {
				"url": "http://www.hazz/upload/resize_cache/main/1af/100_100_2/1464255149.png",
				"color": "#df532d"
		  	},
			"title": "Евгений Шеленков",
			"message": {
				"id": "30468",
				"text": "1",
				"file": false,
				"attach": false,
				"author_id": "1"
			},
			"counter": "3",
			"date": "2017-10-17T11:12:56+02:00",
			"user": {
				"id": "1",
				"name": "Евгений Шеленков",
				"first_name": "Евгений",
				"last_name": "Шеленков",
				"work_position": "ИТ-специалист",
				"color": "#df532d",
				"avatar": "http://www.hazz/upload/resize_cache/main/1af/100_100_2/1464255149.png",
				"gender": "M",
				"birthday": false,
				"extranet": false,
				"network": false,
				"bot": false,
				"connector": false,
				"external_auth_id": "default",
				"status": "online",
				"idle": false,
				"last_activity_date": "2017-10-17T11:16:01+02:00",
				"mobile_last_date": "2017-05-26T12:04:58+02:00",
				"absent": "2017-11-01T00:00:00+02:00"
			}
		},
		{
			"id": "chat21191",
			"type": "chat",
			"avatar": {
				"url": "",
				"color": "#4ba984"
			},
			"title": "Мятный чат №3",
			"message": {
				"id": "30467",
				"text": "Разрешение на обновление Битрикс24 получено от [Вложение]",
				"file": false,
				"attach": true,
				"author_id": "2"
			},
			"counter": "0",
			"date": "2017-10-17T10:38:20+02:00",
			"chat": {
				"id": "21191",
				"title": "Мятный чат №3",
				"owner": "2",
				"extranet": false,
				"avatar": "",
				"color": "#4ba984",
				"type": "chat",
				"entity_type": "",
				"entity_data_1": "",
				"entity_data_2": "",
				"entity_data_3": "",
				"date_create": "2017-10-14T12:15:32+02:00",
				"message_type": "C"
			}
		}
	]
}       

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

  • id – идентификатор диалога (цифра если пользователь, chatXXX если это чат)
  • name – тип записи (user – если пользователь, chat – если это чат)
  • avatar – объект описания аватара записи:
    • url – ссылка на аватар (если пусто, значит аватар не задан)
    • color – цвет диалога в формате hex
  • title – заголовок записи (Имя, фамилия – для пользователя, название чата – для чата)
  • messages – объект описания сообщения:
    • id – идентификатор сообщения
    • text – текст сообщения (без бб-кодов и переносов строк)
    • file – присуствуют файлы (true/false)
    • attach – присутствуют вложения (true/false)
    • author_id – автор сообщения
    • date – дата сообщения в формате ATOM
  • counter – счетчик не прочитанных сообщений
  • user – объект описания данных пользователя (не доступно если это тип записи – чат):
    • id – идентификатор пользователя
    • name – имя и фамилия пользователя
    • first_name – имя пользователя
    • last_name – фамилия пользователя
    • work_position – должность
    • color – цвет пользователя в формате hex
    • avatar – ссылка на аватар (если пусто, значит аватар не задан)
    • gender – пол пользователя
    • birthday – день рождения пользователя в формате DD-MM, если пусто – не задан
    • extranet – признак внешнего экстранет-пользователя (true/false)
    • network – признак пользователя Битрикс24.Network (true/false)
    • bot – признак бота (true/false)
    • connector – признак пользователя открытых линий (true/false)
    • external_auth_id – код внешней авторизации
    • status – выбранный статус пользователя
    • idle – дата, когда пользователь отошел от компьютера, в формате АТОМ (если не задано, false)
    • last_activity_date – дата последнего действия пользователя в формате АТОМ
    • mobile_last_date – дата последнего действия в мобильном приложении в формате АТОМ (если не задано, false)
    • absent – дата, по какое число у пользователя отпуск, в формате АТОМ (если не задано, false)
  • chat – объект описания данных чата (не доступно, если это тип записи – пользователь):
    • id – идентификатор чата
    • title – название чата
    • owner – идентификатор пользователя владельца чата
    • extranet – признак участия в чате внешнего экстранет-пользователя (true/false)
    • color – цвет чата в формате hex
    • avatar – ссылка на аватар (если пусто, значит аватар не задан)
    • type – тип чата (групповой чат, чат для звонка, чат открытой линии и тд)
    • entity_type – внешний код для чата – тип
    • entity_id – внешний код для чата – идентификатор
    • entity_data_1 – внешние данные для чата
    • entity_data_2 – внешние данные для чата
    • entity_data_3 – внешние данные для чата
    • date_create – дата создания чата в формате АТОМ
    • message_type – тип сообщений чата

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



0
Курсы разработаны в компании «1С-Битрикс»