# Obter configuração do Chatwoot GET /integrations/chatwoot Retorna a configuração da integração com o Chatwoot desta inbox. Com a integração ligada, testa também a conexão com o Chatwoot (pode levar até 10 segundos). A resposta traz o `access_token` em texto: não a mostre a quem não deve ver o token. ## Autenticação ```json [ { "token": [] } ] ``` ```json { "token": { "name": "token", "type": "apiKey", "in": "header" } } ``` ## Respostas ```json { "200": { "description": "Configuração obtida com sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Se a integração com Chatwoot está habilitada", "example": true }, "url": { "type": "string", "description": "URL base da inbox Chatwoot", "example": "https://app.chatwoot.com" }, "account_id": { "type": "integer", "format": "int64", "description": "ID da conta no Chatwoot", "example": 1 }, "chatwoot_inbox_id": { "type": "integer", "format": "int64", "description": "Id da caixa de entrada (inbox) no Chatwoot. Quando a api cria a caixa, vem o id dela.", "example": 5 }, "access_token": { "type": "string", "description": "Token de acesso da API do Chatwoot, em texto.", "example": "pXXGHHHyJPYHYgWHJHYHgJjj" }, "ignore_groups": { "type": "boolean", "description": "`true`: mensagens de grupos do WhatsApp não vão para o Chatwoot.", "example": false }, "sign_messages": { "type": "boolean", "description": "`true`: as respostas dos agentes vão ao WhatsApp com o nome do agente em negrito na primeira linha.", "example": true }, "create_new_conversation": { "type": "boolean", "description": "`true`: depois que a conversa é resolvida, a próxima mensagem abre outra no Chatwoot. `false`: reabre a mesma conversa como pendente.", "example": false }, "chatwoot_inbox_name": { "type": "string", "description": "Nome que a api usa para procurar ou criar a caixa: o `chatwoot_inbox_name` do último `PUT` até a integração ligar; depois, o nome da inbox. O nome real da caixa vem em `integration_status.chatwoot_inbox_name`.", "example": "WhatsApp Loja" }, "integration_status": { "type": "object", "description": "Resultado do teste de conexão com o Chatwoot. Com a integração desligada ou ainda ligando depois do `PUT`, vem `status: disabled`.", "properties": { "status": { "type": "string", "enum": [ "ok", "warning", "error", "timeout", "disabled" ], "description": "`ok`: tudo certo. `warning`: conectou, mas a caixa não existe ou o webhook dela não aponta para a api. `error`: não conectou (confira URL, `access_token` e `account_id`). `timeout`: o Chatwoot não respondeu em 10 segundos. `disabled`: integração desligada." }, "connection_ok": { "type": "boolean", "description": "A api conseguiu falar com o Chatwoot." }, "credentials_ok": { "type": "boolean", "description": "O token e a conta foram aceitos." }, "chatwoot_inbox_exists": { "type": "boolean", "description": "A caixa de `chatwoot_inbox_id` existe no Chatwoot." }, "chatwoot_inbox_name": { "type": "string", "description": "Nome da caixa no Chatwoot." }, "webhook_configured": { "type": "boolean", "description": "A caixa tem webhook configurado." }, "webhook_url": { "type": "string", "description": "Webhook configurado na caixa." }, "expected_webhook_url": { "type": "string", "description": "Webhook que a api espera na caixa." }, "error_message": { "type": "string", "description": "Motivo do problema, quando há." }, "details": { "type": "array", "items": { "type": "string" }, "description": "Detalhes do teste." }, "message": { "type": "string", "description": "Só com `status: disabled`." } }, "example": { "status": "ok", "connection_ok": true, "credentials_ok": true, "chatwoot_inbox_exists": true, "chatwoot_inbox_name": "WhatsApp Loja", "webhook_configured": true, "webhook_url": "https://sua-api.com/chatwoot/webhook/inst_abc123", "expected_webhook_url": "https://sua-api.com/chatwoot/webhook/inst_abc123", "error_message": "", "details": [] } } } } } } }, "401": { "description": "Token ausente ou inválido.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrkesioError" }, "example": { "error": "unauthorized", "message": "Token inválido." } } } }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "description": "Erro interno.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrkesioError" }, "example": { "error": "internal_error", "message": "Erro interno; tente de novo." } } } } } ``` **Estado:** Disponível ## Compatibilidade de canais | Canal | Compatível | Observação | |---|---|---| | WhatsApp (Web) | Sim | | | WhatsApp (API oficial) | Sim | | | Instagram | Sim | | | Messenger | Sim | | | Telegram | Sim | | ## 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) Na uazapi: `GET /chatwoot/config`. - `/integrations/chatwoot`; campos sem o prefixo `chatwoot_`. ## #/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)