метод REST scope: imopenlines

imconnector.send.status.reading

Обновить статус «прочитано»

Кто может выполнять: любой пользователь

Описание

Метод imconnector.send.status.reading подтверждает в Битрикс24, что исходящее сообщение открытой линии прочитано во внешней системе. Метод не отправляет сообщение повторно, а только фиксирует результат прочтения.

Метод не применяется для входящих сообщений из внешней системы в открытую линию.

Метод работает только в контексте приложения.

Параметры

CONNECTOR string обязательный

Строковый код коннектора, который задали в параметре ID при вызове imconnector.register

LINE integer обязательный

Идентификатор открытой линии.

Идентификатор можно получить методами imopenlines.config.get и imopenlines.config.list.get

MESSAGES array обязательный

Массив статусов прочтения. Каждый элемент массива — объект с блоками im, message, chat

Структура объекта подробно описана ниже

Параметр MESSAGES

im object необязательный

Внутренние идентификаторы сообщения в Битрикс24 (подробное описание)

message object необязательный

Данные сообщения во внешней системе (подробное описание)

chat object необязательный

Данные чата во внешней системе (подробное описание)

Примеры запроса

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "CONNECTOR": "myconnector",
    "LINE": 107,
    "MESSAGES": [
      {
        "im": {
          "chat_id": 323,
          "message_id": 85911
        },
        "message": {
          "id": ["ext-msg-1007"]
        },
        "chat": {
          "id": "channel-123"
        }
      }
    ],
    "auth": "**put_access_token_here**"
  }' \
  https://**put_your_bitrix24_address**/rest/imconnector.send.status.reading

Ответ

HTTP-статус: 200

{
    "result": {
    "SUCCESS": true,
    "DATA": []
    },
    "time": {
    "start": 1738065600.11,
    "finish": 1738065600.21,
    "duration": 0.10,
    "processing": 0.04,
    "date_start": "2025-01-28T12:00:00+00:00",
    "date_finish": "2025-01-28T12:00:00+00:00"
    }
}

Возвращаемые данные

SUCCESS boolean

Возвращает true, если статус прочтения успешно принят и обновлен в Битрикс24

DATA array

Пустой массив при успешной обработке

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": "WRONG_AUTH_TYPE",
    "error_description": "Current authorization type is denied for this method Application context required"
}
Код Описание Значение
403 WRONG_AUTH_TYPE Current authorization type is denied for this method Application context required
400 ERROR_ARGUMENT Argument 'CONNECTOR' is null or empty
400 ERROR_ARGUMENT Argument 'LINE' is null or empty
400 ERROR_ARGUMENT Argument 'MESSAGES' is null or empty
400 IMCONNECTOR_NO_CORRECT_PROVIDER Не удалось найти подходящий провайдер для коннектора

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.