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

Убрать превью ссылки

DELETE /v1/chats/messages/:messageId/url-preview

Убирает у вашего сообщения карточку-превью ссылки, текст сообщения остаётся. Чат определяется по сообщению, dialogId не нужен.

Параметры

Параметр Тип Обяз. Описание
messageId (path) number да ID сообщения, положительное целое — из ленты чата (GET /v1/chats/:dialogId/messages) или из ответа отправки

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

Примеры

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

Terminal
curl -X DELETE https://vibecode.bitrix24.tech/v1/chats/messages/1002/url-preview \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal
curl -X DELETE https://vibecode.bitrix24.tech/v1/chats/messages/1002/url-preview \
  -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/messages/1002/url-preview', {
  method: 'DELETE',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { success } = await res.json()
console.log('Превью убрано:', success)

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

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

const { success } = await res.json()
console.log('Превью убрано:', success)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.result boolean true — превью убрано

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

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

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

422 — сообщение чужое:

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

Ошибки

HTTP Код Описание
400 INVALID_PARAMS messageId не положительное целое, поле тела или параметр строки запроса. Проверяется до обращения к Битрикс24
422 BITRIX_ERROR Битрикс24 отказал. Код — в error.b24Code: WRONG_SENDER — сообщение не ваше, MESSAGE_NOT_FOUND — сообщения нет
404 ENTITY_NOT_FOUND Битрикс24 вернул код NOT_FOUND. Код портала — в error.b24Code
403 BITRIX_ACCESS_DENIED У пользователя нет доступа к чату — Битрикс24 отказал с кодом ACCESS_DENIED
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения — см. права доступа
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24

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

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

Без превью с самого начала. Чтобы превью не появилось вовсе, отправляйте сообщение с urlPreview: false — см. отправку сообщения.

Правка возвращает превью. Правка в режиме format=v2 по умолчанию строит превью заново по ссылкам текста — и после этой операции тоже. Чтобы сообщение осталось без превью, передавайте при правке urlPreview: false.

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