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

Восстановить регистрацию бота

POST /v1/bots/registrations/:code/recover

Завершает регистрацию бота, результат которой не был подтверждён сразу, и возвращает ID бота на портале Битрикс24. Вызывается тем же ключом и с тем же кодом бота, что и исходная регистрация.

Вызов нужен, когда POST /v1/bots ответил 409 BOT_EFFECT_DESIRED_STATE_NOT_PROVED: запрос на регистрацию отправлен, но её результат ещё не проверен. Новый бот при этом не регистрируется — Вайбкод проверяет уже отправленную регистрацию и завершает запись о боте.

Параметры

Параметр Тип Обяз. Описание
Параметрcode (path) Типstring Обяз.да ОписаниеКод бота — значение поля code из запроса POST /v1/bots

Тело запроса не требуется.

Примеры

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

Terminal
curl -X POST https://vibecode.bitrix24.tech/v1/bots/registrations/support_bot/recover \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal
curl -X POST https://vibecode.bitrix24.tech/v1/bots/registrations/support_bot/recover \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/registrations/support_bot/recover', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log(data) // { botId: 42, code: 'support_bot', recovered: true }

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/registrations/support_bot/recover', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

Поля ответа

Поле Тип Описание
Полеdata.botId Типnumber ОписаниеID бота на портале Битрикс24 — тот же, что data.bots[].id в GET /v1/bots
Полеdata.code Типstring ОписаниеКод бота из пути запроса
Полеdata.recovered Типboolean ОписаниеВсегда true

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

JSON
{
  "success": true,
  "data": {
    "botId": 42,
    "code": "support_bot",
    "recovered": true
  }
}

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

404 — у ключа нет регистрации с таким кодом:

JSON
{
  "success": false,
  "error": {
    "code": "BOT_REGISTRATION_NOT_FOUND",
    "message": "No owned registration is available for recovery"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодCODE_REQUIRED ОписаниеКод бота в пути пустой
HTTP404 КодBOT_REGISTRATION_NOT_FOUND ОписаниеУ ключа нет регистрации с этим кодом, которую можно завершить. Так же отвечает вызов с другим ключом или с другим кодом, чем при регистрации
HTTP409 КодBOT_REGISTRATION_RECOVERY_PENDING ОписаниеПодтверждение или сверка регистрации ещё не завершены. Повторите вызов через число секунд из Retry-After: до следующей плановой проверки (от 1 до 300 секунд), иначе 30 секунд. Если ответ повторяется, обратитесь в поддержку и передайте error.details.registrationRef, когда он есть в ответе
HTTP409 КодBOT_UNAVAILABLE ОписаниеСостояние регистрации требует исправления на стороне платформы, в том числе при несовместимой OAuth-политике или изменившемся подтверждении приложения. Заголовка Retry-After нет, повтор не поможет. Обратитесь в поддержку и передайте error.details.registrationRef, когда он есть в ответе, иначе исходный код бота и портал
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа imbot
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч только для чтения — см. права доступа

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

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

Повторный вызов безопасен. Если регистрация уже завершена, вызов с тем же ключом и кодом снова возвращает 200 с тем же botId.

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