К содержанию
TelegaFirst

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

disconnectBot

Обновлено

POST /api/v1/tools/onboarding/bot-connection/disconnect

disconnectBot

Авторизация и права

Scopes: ALL. Auth alternatives: OR; scopes внутри альтернативы: ALL.

ПолеЗначение
security.0.hubApiKey[]
security.1.hubBearer[]
securitySchemes.hubApiKey.in"header"
securitySchemes.hubApiKey.name"X-Api-Key"
securitySchemes.hubApiKey.type"apiKey"
securitySchemes.hubBearer.scheme"bearer"
securitySchemes.hubBearer.type"http"
x-required-scopes["onboarding:write"]

Параметры запроса

ПолеЗначение
0.description"Canonical global response cache requires a key for a nonempty body; journey commands, direct bot connection, retry, tax, provider and billing cancellation also enforce it in the actual controller. Bot connection recovery uses its durable tenant reservation and accepts an empty body without a key."
0.in"header"
0.name"Idempotency-Key"
0.requiredfalse
0.schema0.schema

Тело запроса

ПолеЗначение
content.application/json.schemacontent.application/json.schema
requiredtrue

Ответы

ПолеЗначение
201.content.application/json.schemaOnboardingBotDisconnectResponse
201.description"The bot was taken off the business and the business is back at its bot step (body.disconnected true), or the business had no bot and nothing changed (false)."

Ошибки

ПолеЗначение
400.content.application/problem+json.schemaProblemDetails
400.description"Invalid input or missing idempotency key."
401.content.application/problem+json.schemaProblemDetails
401.description"Authentication required."
403.content.application/problem+json.schemaProblemDetails
403.description"FORBIDDEN: only the business owner changes its bot, so the call needs the owner OAuth sign-in; an API key or M2M credential has no owner behind it."
409.content.application/problem+json.schemaProblemDetails
409.description"GROUPS_ALREADY_BOUND: an operator group or the technical account is already bound, so the bot stays; connect the other bot to a new business (POST /api/v1/tools/onboarding/slug with new_business true). ONBOARDING_BUSY: a bot setup is still running."

Дополнительные условия

ПолеЗначение
operationId"disconnectBot"
tags["onboarding"]
x-idempotency"http-cache"