im.recent.unread
Установить или снять признак «прочитано» у чата
Описание
Метод im.recent.unread устанавливает или снимает признак «прочитано» у чата.
Параметры
DIALOG_ID
string
обязательный
Идентификатор чата в формате:
chatXXX— чатsgXXX— чат группы или проектаXXX— идентификатор пользователя личного чата
Идентификатор чата можно получить с помощью метода im.chat.get. Идентификатор пользователя — с помощью методов user.get и user.search
ACTION
string
необязательный
Действие с меткой «прочитано»:
- Y — установить метку
- N — снять метку и отметить диалог прочитанным
По умолчанию: Y
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"DIALOG_ID":"chat2941","ACTION":"Y"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.recent.unread
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"DIALOG_ID":"chat2941","ACTION":"Y","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/im.recent.unread
// 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
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'im.recent.unread',
params: {
DIALOG_ID: 'chat2941',
ACTION: 'Y',
},
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('Unread flag set or removed successfully:', result)
}
} 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 markRecentUnread() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'im.recent.unread',
params: {
DIALOG_ID: 'chat2941',
ACTION: 'Y',
},
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('Unread flag set or removed successfully:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', markRecentUnread)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.im.recent.unread(
dialog_id="chat2941",
action=True,
).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}")
try {
$response = $b24Service
->core
->call(
'im.recent.unread',
[
'DIALOG_ID' => 'chat2941',
'ACTION' => 'Y'
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error marking dialog as unread: ' . $e->getMessage();
}
BX24.callMethod(
'im.recent.unread',
{
DIALOG_ID: 'chat2941',
ACTION: 'Y'
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'im.recent.unread',
[
'DIALOG_ID' => 'chat2941',
'ACTION' => 'Y'
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.recent.unread", b24.Params{
"DIALOG_ID": "chat2941",
"ACTION": "Y",
})
if err != nil {
return fmt.Errorf("im.recent.unread: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Ответ
HTTP-статус: 200
{
"result": true,
"time": {
"start": 1772518597,
"finish": 1772518597.385986,
"duration": 0.3859860897064209,
"processing": 0,
"date_start": "2026-03-03T09:16:37+03:00",
"date_finish": "2026-03-03T09:16:37+03:00",
"operating_reset_at": 1772519197,
"operating": 0
}
}
Возвращаемые данные
result
boolean
true, если метка успешно установлена или снята.
Возвращает false, если чат с указанным DIALOG_ID не найден
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "DIALOG_ID_EMPTY",
"error_description": "Dialog ID can't be empty"
}
| Код | Описание | Значение |
|---|---|---|
DIALOG_ID_EMPTY |
Dialog ID can't be empty | Не передан или передан в неверном формате DIALOG_ID |

