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

Отозвать ссылку по коду

DELETE /v1/chats/sharing-links/:code

Отзывает вашу личную ссылку по её коду — ссылку на чат или гостевую ссылку. После отзыва вступить в чат по этому коду нельзя. Чат находится по коду, поэтому в пути он не нужен.

Параметры

Параметр Тип Обяз. Описание
code (path) string да Код ссылки — поле code объекта ссылки или параметр IM_CODE её адреса. От 1 до 64 печатных символов без пробелов

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

Примеры

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

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

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/chats/sharing-links/Xk9pQ2mZ7rT4vB1c" \
  -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/sharing-links/Xk9pQ2mZ7rT4vB1c', {
  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/sharing-links/Xk9pQ2mZ7rT4vB1c', {
  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_ALREADY_REVOKED",
    "b24Code": "SHARING_LINK_ALREADY_REVOKED"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS code не соответствует формату кода ссылки: нужно от 1 до 64 печатных символов без пробелов
400 INVALID_PARAMS Передан параметр запроса или поле тела — метод их не принимает
400 INVALID_PARAMS Тело запроса не JSON-объект
403 BITRIX_ACCESS_DENIED Нет права отозвать личную ссылку другого участника или персональное гостевое приглашение — Битрикс24 отказал с кодом ACCESS_DENIED
422 BITRIX_ERROR Битрикс24 вернул SHARING_LINK_ALREADY_REVOKED — ссылка уже отозвана. Код портала — в error.b24Code
422 BITRIX_ERROR Битрикс24 вернул SHARING_LINK_WRONG_PARAMS — ссылка неподходящего вида, например основная ссылка чата. Код портала — в error.b24Code
422 BITRIX_ERROR Битрикс24 вернул SHARING_LINK_NOT_FOUND — ссылки с таким кодом нет. Код портала — в error.b24Code
404 ENTITY_NOT_FOUND Битрикс24 ответил кодом «не найдено» без уточнения. Код портала — в error.b24Code, если он был передан
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения — см. права доступа
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ошибку сервера

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

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

Гостевую ссылку можно отозвать без кода. Свою гостевую ссылку отзывает и отзыв гостевой ссылки — ему не нужен код, достаточно dialogId.

Отозванная ссылка продолжает читаться. Чтение по коду отдаёт её тем же ответом без признака отзыва, а вступление по ней отклоняется с SHARING_LINK_REVOKED.

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