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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type SendStatusReadingResult = {
SUCCESS: boolean
DATA: unknown[]
}
try {
const response = await $b24.actions.v2.call.make<SendStatusReadingResult>({
method: 'imconnector.send.status.reading',
params: {
CONNECTOR: 'myconnector',
LINE: 107,
MESSAGES: [
{
im: { chat_id: 323, message_id: 85911 },
message: { id: ['ext-msg-1007'] },
chat: { id: 'channel-123' },
},
],
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Read status accepted:', result.SUCCESS, 'data:', result.DATA)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function sendStatusReading() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'imconnector.send.status.reading',
params: {
CONNECTOR: 'myconnector',
LINE: 107,
MESSAGES: [
{
im: { chat_id: 323, message_id: 85911 },
message: { id: ['ext-msg-1007'] },
chat: { id: 'channel-123' },
},
],
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Read status accepted:', result.SUCCESS, 'data:', result.DATA)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', sendStatusReading)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.imconnector.send.status.reading(
connector="myconnector",
line=107,
messages=[
{
"im": {
"chat_id": 323,
"message_id": 85911,
},
"message": {
"id": [
"ext-msg-1007",
],
},
"chat": {
"id": "channel-123",
},
},
],
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
$result = $b24Service->core->call(
'imconnector.send.status.reading',
[
'CONNECTOR' => 'myconnector',
'LINE' => 107,
'MESSAGES' => [
[
'im' => ['chat_id' => 323, 'message_id' => 85911],
'message' => ['id' => ['ext-msg-1007']],
'chat' => ['id' => 'channel-123'],
],
],
]
);
BX24.callMethod(
'imconnector.send.status.reading',
{
CONNECTOR: 'myconnector',
LINE: 107,
MESSAGES: [
{
im: { chat_id: 323, message_id: 85911 },
message: { id: ['ext-msg-1007'] },
chat: { id: 'channel-123' },
},
],
},
function(result) {
console.log(result.data());
}
);
$result = CRest::call(
'imconnector.send.status.reading',
[
'CONNECTOR' => 'myconnector',
'LINE' => 107,
'MESSAGES' => [
[
'im' => ['chat_id' => 323, 'message_id' => 85911],
'message' => ['id' => ['ext-msg-1007']],
'chat' => ['id' => 'channel-123'],
],
],
]
);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imconnector.send.status.reading", b24.Params{
"CONNECTOR": "myconnector",
"LINE": 107,
"MESSAGES": []b24.Params{
{
"im": b24.Params{
"chat_id": 323,
"message_id": 85911,
},
"message": b24.Params{
"id": []string{"ext-msg-1007"},
},
"chat": b24.Params{
"id": "channel-123",
},
},
},
})
if err != nil {
return fmt.Errorf("imconnector.send.status.reading: %w", err)
}
var item struct {
Success bool `json:"SUCCESS"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Success)
Ответ
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 |
Не удалось найти подходящий провайдер для коннектора |

