im.dialog.read

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

Александр Суворов

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

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

Изменение факта прочтения сообщений: все сообщения до указанного (включая само сообщение) помечаются как прочитанные

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

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

Параметры

Параметр	Пример	Обязат.	Описание	Ревизия
DIALOG_ID	chat29 или 256	Да	Идентификатор диалога. Формат: chatXXX – чат получателя, если сообщение для чата или XXX – идентификатор получателя, если сообщение для приватного диалога	21
MESSAGE_ID	12	Да	Идентификатор последнего прочитанного сообщения в диалоге	21

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

JavaScript

BX24.callMethod('im.dialog.read', {
  'DIALOG_ID': chat29,
  'MESSAGE_ID': 12,
}, function(result){
  if(result.error())
  {
    console.error(result.error().ex);
  }
  else
  {
    console.log(result.data());
  }
});

PHP

$result = restCommand('im.dialog.read', Array(
  'DIALOG_ID' => chat29,
  'MESSAGE_ID' => 12,  
), $_REQUEST["auth"]);

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

{
    "result": 
    {
        dialogId: "chat76", 
        chatId: 76, 
        counter: 1, 
        lastId: 6930
    }
}

dialogId – идентификатор прочитанного диалога
chatId – идентификатор чата
counter – кол-во непрочитанных сообщений после выполнения метода
lastId – последнее прочитанное сообщение

Если метод не смог установить новую метку прочтения:

{
 "result": false
}

Пример ответа при возникновении ошибки

{
    "error": "MESSAGE_ID_ERROR",
    "error_description": "Message ID can't be empty"
}

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

error – код возникшей ошибки
error_description – краткое описание возникшей ошибки

Возможные коды ошибок

Код	Описание
MESSAGE_ID_ERROR	Указан некорректный идентификатор сообщения
DIALOG_ID_EMPTY	Указан некорректный идентификатор диалога

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