> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Status / info

> Lê o estado atual da integração Chatwoot

**Auth:** `TokenAccount` ou `TokenInstance` • **Rate-limit:** `Global` (100/min) • **Idempotente:** sim

## Descrição

Retorna o status local da integração Chatwoot e o complementa com o estado atual (best-effort). Esta resposta **inclui** o `chatwoot_api_token` em plaintext e os flags de comportamento (`sign_messages`, `ignore_groups`, `start_as_pending`, `reopen_resolved`).

## Exemplo

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://ryzeapi.cloud/api/chatwoot/list/suporte" \
    -H "token: $Token_Account"
  ```

  ```javascript JavaScript theme={null}
  await fetch("https://ryzeapi.cloud/api/chatwoot/list/suporte", {
    method: "GET",
    headers: {
      "token": process.env.Token_Account
    }
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.get(
      "https://ryzeapi.cloud/api/chatwoot/list/suporte",
      headers={
          "token": os.environ["Token_Account"]
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
  )

  func main() {
      req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/chatwoot/list/suporte", nil)
      req.Header.Set("token", os.Getenv("Token_Account"))
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

## Resposta de sucesso

```json 200 OK theme={null}
{
  "instance_name": "suporte",
  "status": "active",
  "bridge_integration_id": "int_xyz789abc",
  "chatwoot_base_url": "https://chatwoot.example.com",
  "chatwoot_account_id": 5,
  "chatwoot_api_token": "sk_live_abc123...",
  "chatwoot_inbox_id": 42,
  "chatwoot_inbox_name": "WhatsApp - Orion",
  "last_error": "",
  "created_at": "2026-04-20T10:15:30Z",
  "sign_messages": true,
  "ignore_groups": false,
  "start_as_pending": false,
  "reopen_resolved": true
}
```

| Campo                   | Descrição                                                                                                                 |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `instance_name`         | Nome da instância.                                                                                                        |
| `status`                | `active` / `paused` / `error`. Quando disponível, reflete o estado atual.                                                 |
| `bridge_integration_id` | ID interno da integração.                                                                                                 |
| `chatwoot_base_url`     | URL da instalação Chatwoot.                                                                                               |
| `chatwoot_account_id`   | ID numérico da conta Chatwoot.                                                                                            |
| `chatwoot_api_token`    | API token (`access_token`) da conta Chatwoot, em **plaintext**. Vem da linha local descriptografada. Veja o aviso abaixo. |
| `chatwoot_inbox_id`     | ID do inbox criado no Chatwoot (preenchido após o primeiro `list` que conseguir sincronizar).                             |
| `chatwoot_inbox_name`   | Nome do inbox.                                                                                                            |
| `last_error`            | Última mensagem de erro da integração. Vazio quando saudável.                                                             |
| `created_at`            | Timestamp RFC 3339 da criação da integração.                                                                              |
| `sign_messages`         | Prefixa cada mensagem enviada por um agente com `*Nome*:` (negrito do WhatsApp).                                          |
| `ignore_groups`         | Não roteia eventos de grupos para o Chatwoot.                                                                             |
| `start_as_pending`      | Cria novas conversas como `pending` em vez de `open`.                                                                     |
| `reopen_resolved`       | Reabre uma conversa `resolved` ao chegar nova mensagem, em vez de criar uma nova.                                         |

<Warning>
  O `chatwoot_api_token` é retornado em **plaintext** nesta resposta (fica encriptado at-rest). Como esse token normalmente tem acesso amplo à conta Chatwoot, trate a resposta como sensível: evite registrá-la em logs ou em cache no cliente.
</Warning>

<Note>
  Os flags `sign_messages` / `ignore_groups` / `start_as_pending` / `reopen_resolved` são **persistidos localmente** e refletem o último `set`. São sempre retornados, inclusive como `false`.
</Note>

## Parâmetros de rota

<ParamField path="instance" type="string" required>
  Nome da instância (ex.: `suporte`).
</ParamField>

## Headers

<ParamField header="token" type="string" required>
  `TokenAccount` ou `TokenInstance`.
</ParamField>

## Comportamento

<Steps>
  <Step title="Lê os dados locais">
    Consulta a tabela `chatwoot_integrations`. Esta etapa é rápida e sempre funciona.
  </Step>

  <Step title="Complementa com o estado atual (best-effort)">
    A RyzeAPI tenta obter o estado atual da integração com timeout de **10s**. Em caso de falha de rede, segue com os dados locais.
  </Step>

  <Step title="Sobrescreve campos voláteis">
    Quando o estado atual está disponível, `status` e `last_error` são substituídos pelos valores live.
  </Step>

  <Step title="Backfill de inbox_id">
    Se o `inbox_id` ficou disponível e o local ainda está em `0`, atualiza o banco (`SetInboxID`), útil para casos de eventual consistency logo após o `set`.
  </Step>
</Steps>

## Erros

| HTTP | `error.message`                             |
| :--: | ------------------------------------------- |
|  404 | `instance not found`                        |
|  404 | `no chatwoot integration for this instance` |
|  503 | `integration gateway not configured`        |

<Tip>
  Se `last_error` está não-vazio, inspecione a mensagem, geralmente indica que o Chatwoot derrubou a sessão (token rotacionado, inbox removido manualmente, etc.). Reativar com [`POST /api/chatwoot/set/:instance`](/pt/api/chatwoot/activate) costuma resolver.
</Tip>

## Próximo

<CardGroup cols={2}>
  <Card title="Reativar / atualizar" icon="plug" href="/pt/api/chatwoot/activate">
    Use `POST /api/chatwoot/set/:instance` para corrigir credenciais ou flags.
  </Card>

  <Card title="Desativar" icon="power-off" href="/pt/api/chatwoot/deactivate">
    Remova a integração.
  </Card>
</CardGroup>