115  /  166

im.recent.unread

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

Установка метки «не прочитан» на чат или диалог

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

Параметры

Параметр Пример Обязат. Описание Ревизия
DIALOG_ID 'chat74' Да Идентификатор диалога. Формат:
  • chatXXX – чат получателя, если сообщение для чата
  • или
  • XXX – идентификатор получателя, если сообщение для приватного диалога
30
ACTION 'Y' Нет Поставить|снять метку «не прочитан» на диалог - 'Y'|'N' 30


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

JavaScript

B24.callMethod(
  'im.recent.unread',
  {
    DIALOG_ID: 'chat74',
    ACTION: 'Y'
  },
  res => {
    if (res.error())
    {
      console.error(result.error().ex);
    }
    else
    {
      console.log(res.data())
    }
  }
)

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

true //если удалось поставить|снять метку

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

{
  "error":"DIALOG_ID_EMPTY",
  "error_description":"Dialog ID can\u0027t be empty"
}

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

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

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

Код Описание
DIALOG_ID_EMPTY Не передан параметр DIALOG_ID или он не соответствует формату


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