# Conectar com o Facebook POST /inbox/cloud/login Liga uma inbox nova ao Messenger ou ao Instagram pelo login da Meta, sem ninguém copiar o token da Página. Devolve `login_url`: o dono da Página abre o link, autoriza o app e escolhe a Página. A Meta volta para a Orkesio, que troca o código pelo token da Página (um token que não vence), liga a inbox como o [`POST /inbox/cloud`](/endpoint/post/inbox~cloud) e, com o app do próprio cliente, cadastra o webhook do app. Quem autorizou vê uma página de confirmação. - **App:** o seu app na Meta (`app_id` e `app_secret`), com o endereço de `redirect_uri` em "URIs de redirecionamento do OAuth válidos" e o domínio dele em "Domínios do app". - **Página:** se a conta autorizar mais de uma, mande `page_id`. - O link vale 15 minutos e uma vez só. Só quem pediu deve abri-lo: a Página de quem autorizar vai para esta inbox. ## Autenticação ```json [ { "token": [] } ] ``` ```json { "token": { "name": "token", "type": "apiKey", "in": "header" } } ``` ## Corpo da requisição ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "channel", "app_id", "app_secret" ], "properties": { "channel": { "type": "string", "enum": [ "messenger", "instagram" ], "description": "O canal da inbox." }, "app_id": { "type": "string", "pattern": "^[0-9]+$", "description": "ID do seu app na Meta.", "example": "941970291976551" }, "app_secret": { "type": "string", "description": "App Secret do app. Também confere a assinatura dos webhooks." }, "page_id": { "type": "string", "pattern": "^[0-9]+$", "description": "A Página, quando a conta autorizar mais de uma." }, "config_id": { "type": "string", "description": "Configuração do Login do Facebook para Empresas, quando o app usa uma (no lugar da lista de permissões)." } } }, "example": { "channel": "messenger", "app_id": "941970291976551", "app_secret": "..." } } } } ``` ## Respostas ```json { "200": { "description": "O link de autorização.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "login_url", "redirect_uri", "expires_at" ], "properties": { "login_url": { "type": "string", "description": "Link da Meta para o dono da Página autorizar." }, "redirect_uri": { "type": "string", "description": "Para onde a Meta volta; cadastre no app em \"URIs de redirecionamento do OAuth válidos\"." }, "expires_at": { "type": "string", "format": "date-time", "description": "Até quando o link vale (15 minutos)." } } }, "example": { "login_url": "https://www.facebook.com/v26.0/dialog/oauth?client_id=941970291976551&redirect_uri=...&state=...", "redirect_uri": "https://loja.orkesio.com/channel/oauth/callback", "expires_at": "2026-10-19T23:15:00.000Z" } } } }, "400": { "description": "Corpo inválido, canal errado ou sem o app.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrkesioError" }, "example": { "error": "invalid_request", "message": "app_id e app_secret são obrigatórios." } } } }, "401": { "description": "Token ausente ou inválido.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrkesioError" }, "example": { "error": "unauthorized", "message": "Token inválido." } } } }, "409": { "description": "A inbox já foi conectada pelo WhatsApp Web.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrkesioError" }, "example": { "error": "inbox_uses_whatsapp_web", "message": "A inbox já foi conectada pelo WhatsApp Web; crie uma inbox nova para o Messenger." } } } }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "description": "Erro interno ao gerar o link.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrkesioError" }, "example": { "error": "internal_error", "message": "Falha ao gerar o login." } } } } } ``` **Estado:** Prévia ## Compatibilidade de canais | Canal | Compatível | Observação | |---|---|---| | WhatsApp (Web) | Não | Só Messenger e Instagram. | | WhatsApp (API oficial) | Não | No WhatsApp, use o POST /inbox/cloud. | | Instagram | Sim | | | Messenger | Sim | | | Telegram | Não | No Telegram, use o POST /inbox/cloud com o token do bot. | ## Eventos que esta rota gera Nenhum. Esta rota não gera evento no webhook (nem em `GET /events`): o resultado vem só na resposta. ## Antes e depois (uazapi → Orkesio) Rota nova: não tem equivalente na uazapi. ## #/components/schemas/OrkesioError ```json { "type": "object", "properties": { "error": { "type": "string", "description": "Código estável do erro, em inglês e `snake_case`. Os de uso geral: `invalid_request` (400): pedido inválido: JSON malformado, campo desconhecido ou valor fora do permitido (o detalhe em `message`; o campo em `field`, quando é um só); `unauthorized` (401): `token` ou `admintoken` ausente ou inválido; `forbidden` (403): o token não pode fazer isso (no servidor de demonstração, por exemplo); `not_admin` (403): o WhatsApp recusou por falta de permissão no grupo ou na newsletter; `account_restricted` (403): o WhatsApp restringiu a conta de iniciar conversas novas (mandar para quem já conversa continua valendo; até quando, em `GET /inbox/limits`); `new_chat_limit` (403): a conta atingiu a cota do WhatsApp de conversas novas neste ciclo (veja `GET /inbox/limits`); os dois também no `error` de `OrkesioMessage` e de `message.status`, e não adianta repetir o envio; `payment_required` (403): na API oficial, a Meta recusou o envio por um problema no pagamento da conta do WhatsApp Business (erro 131042 da Meta); acerte a forma de pagamento no gerenciador da Meta, porque repetir não adianta; também no `error` de `OrkesioMessage` e de `message.status`; `whatsapp_rejected` (400): o WhatsApp recusou a mudança pedida (o campo, em `field`, quando é um só); `not_found` (404): o recurso não existe nesta inbox; `conflict` (409): o recurso já existe ou mudou (id em uso, inbox de outro canal); `inbox_not_paired` (409): a inbox ainda não conectou um número; `payload_too_large` (413): o corpo passou do limite; `canceled` e `expired`: só no `error` de `OrkesioMessage` e de `message.status` (envio cancelado antes de sair, ou que passou do prazo na fila); `rate_limited` (429): muitos pedidos; espere o `Retry-After`; `internal_error` (500): falha inesperada na api; tente de novo; `send_failed` (500): o envio falhou (o motivo em `message`); também no `error` de `OrkesioMessage` e de `message.status`; `unsupported_for_channel` (501): o canal da inbox não atende esta rota ou este tipo de mensagem; `meta_error` (502): a Meta recusou ou não respondeu; `disconnected` (503): a inbox está desconectada (sem sessão do WhatsApp, ou token do canal oficial vencido); `unavailable` (503 ou 504): o WhatsApp não respondeu a tempo, ou algo em andamento impede agora; tente de novo. Cada rota lista os códigos próprios dela (`outside_window`, `number_invalid`, `flow_invalid`...). A lista pode crescer: trate código desconhecido pelo status HTTP." }, "message": { "type": "string", "description": "Descrição para pessoas (às vezes o texto do WhatsApp ou da Meta). Não compare o texto: use `error`." }, "field": { "type": "string", "description": "O campo do pedido que causou o erro, quando é um só (por exemplo, o campo que o WhatsApp recusou num `PATCH`)." } }, "required": [ "error", "message" ], "additionalProperties": true, "description": "O objeto de erro da Orkesio, o mesmo em todo lugar: o corpo das respostas de erro e o `error` de `OrkesioMessage`, `message.status` e `message.failed`. Algumas rotas juntam campos próprios (`request_id`, `errors`...)." } ``` ## #/components/responses/RateLimited ```json { "description": "`rate_limited`: passou do limite de chamadas desta inbox (ou do admin); espere o tempo do header `Retry-After` e tente de novo.", "headers": { "Retry-After": { "description": "Segundos até poder chamar de novo.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrkesioError" }, "example": { "error": "rate_limited", "message": "Muitas requisições." } } } } ``` ## Guias relacionados [Visão geral](/docs/overview) · [O que funciona em cada canal](/docs/canais) · [O que muda da uazapi](/docs/o-que-muda)