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

Ссылки и гости

Приглашайте в чат сотрудников портала по ссылке, а людей вне портала — гостей — по гостевой ссылке, почте или SMS. Возможность отзыва зависит от вида ссылки: персональные приглашения по почте и SMS отозвать нельзя.

Скоуп: im | Базовый URL: https://vibecode.bitrix24.tech/v1 | Авторизация: X-Api-Key

Битрикс24 API: im.v2.Chat.SharingLink.*, im.v2.SharingLink.get, im.v2.Chat.joinByCode, im.v2.Guest.Link.*

Получить основную ссылку чата

POST /v1/chats/:dialogId/sharing-links/primary

Возвращает основную ссылку чата и создаёт её, если ссылки ещё нет. Основная ссылка одна на чат и не отзывается, выдать её может только участник с правом управлять ссылками чата.

Параметры

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

Поля запроса (body)

Тело можно не передавать.

Поле Тип Обяз. Описание
generateIfNotExists boolean нет false — только вернуть действующую ссылку, не создавая новую. По умолчанию true

Другие поля тела и параметры запроса отклоняются с 400 INVALID_PARAMS.

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/chat42/sharing-links/primary" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"generateIfNotExists": false}'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/chat42/sharing-links/primary" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"generateIfNotExists": false}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat42/sharing-links/primary', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ generateIfNotExists: false }),
})

const { success, data, error } = await res.json()
console.log(success ? data.sharingLink.code : error.code)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat42/sharing-links/primary', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ generateIfNotExists: false }),
})

const { success, data, error } = await res.json()
console.log(success ? data.sharingLink.code : error.code)

Поля ответа

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

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

Объект ссылки того же вида, что у личной ссылки, с type, равным primary:

JSON 
{
  "success": true,
  "data": {
    "sharingLink": {
      "id": 1011,
      "entityId": "42",
      "entityType": "chat",
      "code": "Rt5wYn8KqL2vPz3M",
      "type": "primary",
      "dateCreate": "2026-09-24T23:01:10+00:00",
      "dateExpire": null,
      "requireApproval": false,
      "url": "https://portal.bitrix24.ru/online/?IM_CODE=Rt5wYn8KqL2vPz3M"
    }
  }
}

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

403 — групповой чат, основную ссылку не выдают никому из участников:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ACCESS_DENIED",
    "message": "ACCESS_DENIED"
  }
}

Ошибки

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

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

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

Групповой чат основную ссылку не выдаёт. Право управлять ссылками группового чата портал не даёт ни одному участнику, включая владельца, и отвечает 403 BITRIX_ACCESS_DENIED. Чтобы пригласить сотрудника по ссылке в такой чат, выдайте ему свою личную ссылку.

Основная ссылка не отзывается. Отзыв по коду снимает только личные ссылки.

Вызов изменяющий даже без создания. При generateIfNotExists: false ссылка не создаётся, но ключ только для чтения всё равно получает 403 WRITE_BLOCKED_READONLY_KEY: вызов может сделать владельца ключа участником чата, если чат разрешает автовступление.

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