Для AI-агентов: markdown этой страницы — /docs-content/chats/sharing/guest-link-regenerate.md индекс документации — /llms.txt
Перевыпустить гостевую ссылку
POST /v1/chats/:dialogId/guest-links/regenerate
Отзывает вашу гостевую ссылку на чат и выдаёт новую с другим кодом и адресом. Нужен, когда прежний адрес попал не к тем людям: по старой ссылке войти в чат уже нельзя.
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
dialogId (path) |
string | да | ID диалога: chatXXX для группового чата, числовой ID пользователя для личного, me — ваш личный диалог. Список — GET /v1/chats/recent |
Тело запроса не принимается: поля тела и параметры запроса отклоняются с 400 INVALID_PARAMS.
Примеры
curl — личный ключ
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/chat42/guest-links/regenerate" \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth-приложение
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/chat42/guest-links/regenerate" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat42/guest-links/regenerate', {
method: 'POST',
headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Новая ссылка для гостя:', data.sharingLink.url)
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat42/guest-links/regenerate', {
method: 'POST',
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
const { data } = await res.json()
console.log('Новая ссылка для гостя:', data.sharingLink.url)
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
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 |
Пример ответа
{
"success": true,
"data": {
"sharingLink": {
"id": 1015,
"entityId": "42",
"entityType": "guest_chat",
"code": "Rq4vbWE6tT97ksNa",
"type": "individual",
"dateCreate": "2026-09-24T23:07:36+00:00",
"dateExpire": "2026-09-25T23:07:36+00:00",
"requireApproval": false,
"url": "https://b24.to/gi/a1b2c3d4e5-Rq4vbWE6tT97ksNa?IM_DIALOG=chat42",
"name": null
}
}
}
Пример ответа при ошибке
422 — чата нет на портале:
{
"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.
Уже вошедшие гости будут удалены. Перевыпуск отзывает старую ссылку и удаляет из чата гостей, вошедших по ней. Персональные приглашения по почте и SMS не отзываются и действуют до dateExpire.
Системное сообщение видят все участники. Перевыпуск оставляет в чате сообщение о том, что по старой ссылке больше нельзя попасть в чат.
Новая ссылка входит в лимит приглашений. Перевыпущенная ссылка учитывается в лимите 10 гостевых ссылок автора в час, который проверяют приглашения по почте и по SMS.