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

Получить гостевую ссылку

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

Возвращает вашу гостевую ссылку на чат и создаёт её, если ссылки ещё нет. По адресу ссылки в чат входит человек вне портала, у каждого участника своя гостевая ссылка.

Параметры

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

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

Примеры

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

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

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

Terminal 
curl -X POST "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: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
console.log('Ссылка для гостя:', data.sharingLink.url, 'до', data.sharingLink.dateExpire)

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

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

const { data } = await res.json()
console.log('Ссылка для гостя:', data.sharingLink.url, 'до', data.sharingLink.dateExpire)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.sharingLink.id number ID ссылки
data.sharingLink.entityType string guest_chat — гостевая ссылка
data.sharingLink.entityId string ID чата без префикса chat
data.sharingLink.code string Код ссылки — для чтения и отзыва по коду
data.sharingLink.type string individual — личная гостевая ссылка
data.sharingLink.dateCreate string Дата создания, ISO 8601
data.sharingLink.dateExpire string Срок действия — через сутки после создания
data.sharingLink.requireApproval boolean Требуется ли одобрение вступления
data.sharingLink.url string Адрес, который открывает гость
data.sharingLink.name null У личной гостевой ссылки всегда null

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

JSON 
{
  "success": true,
  "data": {
    "sharingLink": {
      "id": 1014,
      "entityId": "42",
      "entityType": "guest_chat",
      "code": "Pq7Rs2Tu9Vw4Xy1Z",
      "type": "individual",
      "dateCreate": "2026-09-24T23:07:13+00:00",
      "dateExpire": "2026-09-25T23:07:13+00:00",
      "requireApproval": false,
      "url": "https://b24.to/gi/a1b2c3d4e5-Pq7Rs2Tu9Vw4Xy1Z?IM_DIALOG=chat42",
      "name": null
    }
  }
}

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

422 — чата нет на портале:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "CHAT_NOT_FOUND",
    "hint": "dialogId must be a userId (number as string) for DMs or \"chat{N}\" for group chats. Examples: \"1\" for user 1, \"chat123\" for group chat 123. Create a group chat first via POST /v1/bots/:botId/chats if needed.",
    "b24Code": "CHAT_NOT_FOUND"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Передано поле тела или параметр запроса. Проверяется до обращения к Битрикс24
422 BITRIX_ERROR Битрикс24 вернул ошибку, код портала — в error.b24Code. 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.

Ссылки входят в лимит приглашений. Каждая новая гостевая ссылка, включая перевыпущенные и отозванные, учитывается в лимите 10 гостевых ссылок автора в час, который проверяют приглашения по почте и по SMS.

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