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

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

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

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

Параметры

Параметр Тип Обяз. Описание
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/individual" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/chat42/sharing-links/individual" \
  -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/sharing-links/individual', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
console.log('Код ссылки:', data.sharingLink.code)

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

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

const { data } = await res.json()
console.log('Код ссылки:', data.sharingLink.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 individual — личная ссылка
data.sharingLink.dateCreate string Дата создания, ISO 8601
data.sharingLink.dateExpire string | null Срок действия. null — без срока
data.sharingLink.requireApproval boolean Требуется ли одобрение вступления
data.sharingLink.url string Адрес ссылки на портале, код в нём — параметр IM_CODE

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

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

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

422 — ссылки нет, а generateIfNotExists равен false:

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

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Поле тела вне generateIfNotExists, тело не объект, generateIfNotExists не true и не false или передан параметр запроса. Проверяется до обращения к Битрикс24
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 BITRIX_ACCESS_DENIED Нет права приглашать в этот чат — Битрикс24 отказал с кодом ACCESS_DENIED
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения, вызов изменяющий — см. права доступа
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24

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

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

Повторный вызов возвращает ту же ссылку. Пока ссылка действует, каждый вызов отдаёт её же с тем же code. Новый код выдаёт перевыпуск.

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

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