im.recent.list

Просмотров: 12811
Дата последнего изменения: 17.10.2024

Анна Кокина

Сложность урока:

3 уровень - средняя сложность. Необходимо внимание и немного подумать.

Получение списка последних диалогов пользователя (с поддержкой пагинации)

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

Параметры

Параметр	Пример	Обязат.	Описание	Ревизия
SKIP_OPENLINES	'Y'	Нет	Пропускать чаты открытых линий	30
SKIP_DIALOG	'N'	Нет	Пропускать диалоги "один на один"	30
SKIP_CHAT	'Y'	Нет	Пропускать чаты	30
LAST_MESSAGE_DATE	'2021-10-30'	Нет	Дата из последнего элемента предыдущей выборки	30

Вызов метода и ответ

JavaScript

B24.callMethod(
  'im.recent.list',
  {
    LAST_MESSAGE_DATE: '2021-10-30'
  },
  res => {
    if (res.error())
    {
      console.error(result.error().ex);
    }
    else
    {
      console.log(res.data())
    }
  }
)

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

{
  "items": [
    {
      "id": "chat71",
      "chat_id": 71,
      "type": "chat",
      "avatar": {
        "url": "",
        "color": "#8474c8"
      },
      "title": "Фиолетовый гость №3 - Открытая линия 2",
      "message": {
        "id": 267,
        "text": "Отправлена форма \"Форма контактных данных для открытых линий\" [Вложение]",
        "file": false,
        "author_id": 0,
        "attach": true,
        "date": "2021-10-27T18:20:45+02:00",
        "status": "received"
      },
      "counter": 3,
      "pinned": false,
      "unread": false,
      "date_update": "2021-10-27T18:20:45+02:00",
      "chat": {
        "id": 71,
        "name": "Фиолетовый гость №3 - Открытая линия 2",
        "owner": 0,
        "extranet": false,
        "avatar": "",
        "color": "#8474c8",
        "type": "lines",
        "entity_type": "LINES",
        "entity_id": "livechat|2|70|2016",
        "entity_data_1": "N|NONE|0|N|N|7|1635351612|0|0|0",
        "entity_data_2": "",
        "entity_data_3": "",
        "mute_list": [],
        "manager_list": [],
        "date_create": "2021-10-27T18:20:12+02:00",
        "message_type": "L"
      },
      "lines": {
        "id": 7,
        "status": 5,
        "date_create": "2021-10-27T18:20:12+02:00"
      },
      "user": {
        "id": 0
      },
      "options": []
    },
    {
      "id": "chat69",
      "chat_id": 69,
      "type": "chat",
      "avatar": {
        "url": "",
        "color": "#3e99ce"
      },
      "title": "Синий гость №3 - Открытая линия 2",
      "message": {
        "id": 258,
        "text": "Отправлена форма \"Форма контактных данных для открытых линий\" [Вложение]",
        "file": false,
        "author_id": 0,
        "attach": true,
        "date": "2021-10-27T18:16:22+02:00",
        "status": "received"
      },
      "counter": 3,
      "pinned": false,
      "unread": false,
      "date_update": "2021-10-27T18:16:22+02:00",
      "chat": {
        "id": 69,
        "name": "Синий гость №3 - Открытая линия 2",
        "owner": 0,
        "extranet": false,
        "avatar": "",
        "color": "#3e99ce",
        "type": "lines",
        "entity_type": "LINES",
        "entity_id": "livechat|2|68|2015",
        "entity_data_1": "N|NONE|0|N|N|6|1635351343|0|0|0",
        "entity_data_2": "",
        "entity_data_3": "",
        "mute_list": [],
        "manager_list": [],
        "date_create": "2021-10-27T18:15:43+02:00",
        "message_type": "L"
      },
      "lines": {
        "id": 6,
        "status": 5,
        "date_create": "2021-10-27T18:15:43+02:00"
      },
      "user": {
        "id": 0
      },
      "options": []
    },
    {
      "id": "chat67",
      "chat_id": 67,
      "type": "chat",
      "avatar": {
        "url": "",
        "color": "#29619b"
      },
      "title": "Лазурный гость №2 - Открытая линия 2",
      "message": {
        "id": 250,
        "text": "hi",
        "file": false,
        "author_id": 2014,
        "attach": false,
        "date": "2021-10-27T17:11:36+02:00",
        "status": "received"
      },
      "counter": 5,
      "pinned": false,
      "unread": false,
      "date_update": "2021-10-27T17:11:36+02:00",
      "chat": {
        "id": 67,
        "name": "Лазурный гость №2 - Открытая линия 2",
        "owner": 0,
        "extranet": false,
        "avatar": "",
        "color": "#29619b",
        "type": "lines",
        "entity_type": "LINES",
        "entity_id": "livechat|2|66|2014",
        "entity_data_1": "N|NONE|0|N|N|5|1635346774|0|0|0",
        "entity_data_2": "",
        "entity_data_3": "",
        "mute_list": [],
        "manager_list": [],
        "date_create": "2021-10-27T16:59:34+02:00",
        "message_type": "L"
      },
      "lines": {
        "id": 5,
        "status": 5,
        "date_create": "2021-10-27T16:59:34+02:00"
      },
      "user": {
        "id": 2014,
        "active": true,
        "name": "Гость",
        "first_name": "Гость",
        "last_name": "",
        "work_position": "",
        "color": "#4ba5c3",
        "avatar": "",
        "gender": "M",
        "birthday": "",
        "extranet": true,
        "network": false,
        "bot": false,
        "connector": true,
        "external_auth_id": "imconnector",
        "status": "online",
        "idle": false,
        "last_activity_date": "2021-10-27T17:11:36+02:00",
        "mobile_last_date": false,
        "absent": false,
        "departments": [],
        "phones": false,
        "desktop_last_date": false
      },
      "options": []
    },
    {
      "id": "chat65",
      "chat_id": 65,
      "type": "chat",
      "avatar": {
        "url": "",
        "color": "#df532d"
      },
      "title": "Максим Тестер - Открытая линия 2",
      "message": {
        "id": 225,
        "text": "Создана новая сделка [Вложение]",
        "file": false,
        "author_id": 0,
        "attach": true,
        "date": "2021-10-25T14:48:28+02:00",
        "status": "received"
      },
      "counter": 6,
      "pinned": false,
      "unread": false,
      "date_update": "2021-10-25T14:48:28+02:00",
      "chat": {
        "id": 65,
        "name": "Максим Тестер - Открытая линия 2",
        "owner": 0,
        "extranet": false,
        "avatar": "",
        "color": "#df532d",
        "type": "lines",
        "entity_type": "LINES",
        "entity_id": "livechat|2|64|2011",
        "entity_data_1": "Y|DEAL|12|N|N|4|1635166080|0|0|0",
        "entity_data_2": "LEAD|0|COMPANY|0|CONTACT|9|DEAL|12",
        "entity_data_3": "",
        "mute_list": [],
        "manager_list": [],
        "date_create": "2021-10-25T14:48:00+02:00",
        "message_type": "L"
      },
      "lines": {
        "id": 4,
        "status": 5,
        "date_create": "2021-10-25T14:48:00+02:00"
      },
      "user": {
        "id": 0
      },
      "options": []
    },
    {
      "id": "chat39",
      "chat_id": 39,
      "type": "chat",
      "avatar": {
        "url": "",
        "color": "#4ba984"
      },
      "title": "Чат не для роботов",
      "message": {
        "id": 161,
        "text": "вот вопрос",
        "file": false,
        "author_id": 1,
        "attach": false,
        "date": "2021-10-08T13:19:33+02:00",
        "status": "delivered"
      },
      "counter": 0,
      "pinned": false,
      "unread": false,
      "date_update": "2021-10-08T13:19:33+02:00",
      "chat": {
        "id": 39,
        "name": "Чат не для роботов",
        "owner": 1018,
        "extranet": false,
        "avatar": "",
        "color": "#4ba984",
        "type": "chat",
        "entity_type": "",
        "entity_id": "",
        "entity_data_1": "",
        "entity_data_2": "",
        "entity_data_3": "",
        "mute_list": [],
        "manager_list": [],
        "date_create": "2021-09-27T15:57:53+02:00",
        "message_type": "C"
      },
      "user": {
        "id": 1,
        "active": true,
        "name": "Алексей Шахворостов",
        "first_name": "Алексей",
        "last_name": "Шахворостов",
        "work_position": "",
        "color": "#df532d",
        "avatar": "",
        "gender": "M",
        "birthday": "",
        "extranet": false,
        "network": false,
        "bot": false,
        "connector": false,
        "external_auth_id": "default",
        "status": "online",
        "idle": false,
        "last_activity_date": "2021-10-30T15:52:40+02:00",
        "mobile_last_date": "2021-10-27T16:39:26+02:00",
        "absent": false,
        "departments": [
          1
        ],
        "phones": false,
        "desktop_last_date": "2021-10-21T11:07:54+02:00"
      },
      "options": []
    },
    {
      "id": 1018,
      "chat_id": 28,
      "type": "user",
      "avatar": {
        "url": "",
        "color": "#df532d"
      },
      "title": "Лев Трегубов",
      "message": {
        "id": 160,
        "text": "Пуши приходят",
        "file": false,
        "author_id": 1018,
        "attach": false,
        "date": "2021-10-08T13:19:32+02:00",
        "status": "delivered"
      },
      "counter": 0,
      "pinned": false,
      "unread": false,
      "date_update": "2021-10-08T13:20:59+02:00",
      "user": {
        "id": 1018,
        "active": true,
        "name": "Лев Трегубов",
        "first_name": "Лев",
        "last_name": "Трегубов",
        "work_position": "",
        "color": "#df532d",
        "avatar": "",
        "gender": "M",
        "birthday": "",
        "extranet": false,
        "network": false,
        "bot": false,
        "connector": false,
        "external_auth_id": "default",
        "status": "online",
        "idle": false,
        "last_activity_date": "2021-10-29T16:29:17+02:00",
        "mobile_last_date": "2021-10-08T13:24:22+02:00",
        "absent": false,
        "departments": [
          1
        ],
        "phones": false,
        "desktop_last_date": "2021-10-18T16:51:09+02:00"
      },
      "options": []
    }
  ],
  "hasMore": false
}

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

id – идентификатор диалога (если цифра – это пользователь; если chatXXX – это чат)
type – тип записи (если user – это пользователь, если chat – это чат)
avatar – объект описания аватара записи:
- url – ссылка на аватар (если пусто, значит, аватар не задан)
- color – цвет диалога в формате hex
title – заголовок записи (имя и фамилия – для пользователя, название чата – для чата)
messages – объект описания сообщения:
- id – идентификатор сообщения
- text – текст сообщения (без BB-кодов и переносов строк)
- file – присутствуют файлы (true/false)
- attach – присутствуют вложения (true/false)
- author_id – автор сообщения
- date – дата сообщения
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 – тип сообщений чата
pinned – закреплен чат или нет
unread – стоит ли ручная метка о том, что чат не прочитан
date_update – дата последнего изменения в связанных сущностях

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