Для AI-агентов: markdown этой страницы — /docs-content/chats/management/hide.md индекс документации — /llms.txt
Скрыть чат
POST /v1/chats/:dialogId/hide
Убирает диалог из списка текущего пользователя, сохраняя сообщения и участие в чате. Новое сообщение может вернуть диалог в список.
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
ПараметрdialogId (path) |
Типstring | Обяз.да | ОписаниеЧисловой ID собеседника для личной переписки, chatN для группового чата или me для текущего пользователя. Источник — последние диалоги |
Параметры запроса не принимаются. Тело можно не передавать или отправить {}. Другие поля и тело другого типа отклоняются.
Примеры
curl — личный ключ
curl -X POST https://vibecode.bitrix24.tech/v1/chats/chat456/hide \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth-приложение
curl -X POST https://vibecode.bitrix24.tech/v1/chats/chat456/hide \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat456/hide', {
method: 'POST',
headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const body = await res.json()
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat456/hide', {
method: 'POST',
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
const body = await res.json()
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | Описаниеtrue при успехе |
Полеdata |
Типboolean | Описаниеtrue — диалог скрыт |
Пример ответа
{"success": true, "data": true}
Пример ответа при ошибке
400 — передано неизвестное поле тела folderId:
{"success": false, "error": {"code": "INVALID_PARAMS", "message": "Body field `folderId` is not accepted by POST /v1/chats/:dialogId/hide. It takes no body fields."}}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP400 | КодINVALID_PARAMS |
ОписаниеПараметр запроса, поле тела или тело другого типа |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеУ ключа нет скоупа im |
| HTTP403 | КодWRITE_BLOCKED_READONLY_KEY |
ОписаниеКлюч разрешает только чтение |
| HTTP403 | КодBITRIX_ACCESS_DENIED |
ОписаниеБитрикс24 отказал в доступе |
| HTTP422 | КодBITRIX_ERROR |
ОписаниеБитрикс24 отклонил действие. Его код сохранён в error.b24Code |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеУ ключа не настроены токены Битрикс24 |
| HTTP502 | КодME_ALIAS_RESOLUTION_FAILED |
ОписаниеНе удалось определить пользователя для me |
Общие ошибки API — Ошибки.
Известные особенности
При неизвестном исходе сетевого запроса платформа не повторяет скрытие автоматически.