Для AI-агентов: markdown этой страницы — /docs-content/chats/sharing/guest-link-revoke.md индекс документации — /llms.txt

Отозвать гостевую ссылку

DELETE /v1/chats/:dialogId/guest-links

Отзывает вашу гостевую ссылку на чат: по её адресу войти в чат уже нельзя. Код ссылки не нужен, достаточно ID диалога.

Параметры

Параметр Тип Обяз. Описание
dialogId (path) string да ID диалога: chatXXX для группового чата, числовой ID пользователя для личного, me — ваш личный диалог. Список — GET /v1/chats/recent

Тело запроса не принимается: поля тела и параметры запроса отклоняются с 400 INVALID_PARAMS.

Примеры

curl — личный ключ

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/chats/chat42/guest-links" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/chats/chat42/guest-links" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat42/guest-links', {
  method: 'DELETE',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
console.log('Отозвана:', data.result)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat42/guest-links', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { data } = await res.json()
console.log('Отозвана:', data.result)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.result boolean true — ссылка отозвана

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

JSON 
{
  "success": true,
  "data": {
    "result": true
  }
}

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

422 — действующей гостевой ссылки нет:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "SHARING_LINK_NOT_FOUND",
    "b24Code": "SHARING_LINK_NOT_FOUND"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Передано поле тела или параметр запроса. Проверяется до обращения к Битрикс24
422 BITRIX_ERROR Битрикс24 вернул ошибку, код портала — в error.b24Code. SHARING_LINK_NOT_FOUND — действующей гостевой ссылки у вас нет, GUEST_FEATURE_DISABLED — гости на портале выключены, CHAT_NOT_FOUND — чата нет на портале
404 ENTITY_NOT_FOUND Битрикс24 ответил кодом «не найдено» без уточнения, код портала — в error.b24Code
502 ME_ALIAS_RESOLUTION_FAILED Не удалось определить пользователя для алиаса me
403 BITRIX_ACCESS_DENIED Нет права управлять гостевыми ссылками чата — Битрикс24 отказал с кодом ACCESS_DENIED
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения — см. права доступа
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24

Полный список общих ошибок API — Ошибки.

Известные особенности

Автовступление в чат. Вызов может сделать владельца ключа участником открытого чата, даже если операция со ссылкой затем получит отказ. Ключ только для чтения блокируется до обращения к Битрикс24.

Отзыв виден в чате. После отзыва в чате появляется системное сообщение, что вы отозвали гостевую ссылку, его видят все участники.

Уже вошедшие гости будут удалены. Отзыв закрывает старую ссылку для новых гостей и удаляет из чата тех, кто ранее вошёл по ней. Персональные приглашения по почте и SMS остаются действительными до dateExpire.

Смотрите также