> ## 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.

# Estado / información

> Lee el estado actual de la integración de Chatwoot

**Auth:** `TokenAccount` o `TokenInstance` • **Rate limit:** `Global` (100/min) • **Idempotente:** sí

## Descripción

Devuelve el estado local de la integración de Chatwoot y lo complementa con el estado actual (best-effort). Esta respuesta **incluye** el `chatwoot_api_token` en plaintext y los flags de comportamiento (`sign_messages`, `ignore_groups`, `start_as_pending`, `reopen_resolved`).

## Ejemplo

<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>

## Respuesta exitosa

```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                   | Descripción                                                                                                                                 |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `instance_name`         | Nombre de la instancia.                                                                                                                     |
| `status`                | `active` / `paused` / `error`. Cuando está disponible, refleja el estado actual.                                                            |
| `bridge_integration_id` | ID interno de la integración.                                                                                                               |
| `chatwoot_base_url`     | URL de la instalación de Chatwoot.                                                                                                          |
| `chatwoot_account_id`   | ID numérico de la cuenta de Chatwoot.                                                                                                       |
| `chatwoot_api_token`    | Token de API (`access_token`) de la cuenta de Chatwoot, en **plaintext**. Proviene de la fila local descifrada. Consulta el aviso de abajo. |
| `chatwoot_inbox_id`     | ID de la inbox creada en Chatwoot (se completa después del primer `list` que logre sincronizar).                                            |
| `chatwoot_inbox_name`   | Nombre de la inbox.                                                                                                                         |
| `last_error`            | Último mensaje de error de la integración. Vacío cuando está saludable.                                                                     |
| `created_at`            | Marca de tiempo RFC 3339 de la creación de la integración.                                                                                  |
| `sign_messages`         | Antepone a cada mensaje enviado por un agente `*Nombre*:` (negrita de WhatsApp).                                                            |
| `ignore_groups`         | No enruta eventos de grupos hacia Chatwoot.                                                                                                 |
| `start_as_pending`      | Crea las nuevas conversaciones como `pending` en lugar de `open`.                                                                           |
| `reopen_resolved`       | Reabre una conversación `resolved` cuando llega un nuevo mensaje, en lugar de crear una nueva.                                              |

<Warning>
  El `chatwoot_api_token` se devuelve en **plaintext** en esta respuesta (queda cifrado en reposo). Como ese token normalmente tiene acceso amplio a la cuenta de Chatwoot, trata la respuesta como sensible: evita registrarla en logs o cachearla en el cliente.
</Warning>

<Note>
  Los flags `sign_messages` / `ignore_groups` / `start_as_pending` / `reopen_resolved` se **persisten localmente** y reflejan el último `set`. Siempre se devuelven, incluso como `false`.
</Note>

## Parámetros de ruta

<ParamField path="instance" type="string" required>
  Nombre de la instancia (p. ej., `suporte`).
</ParamField>

## Cabeceras

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

## Comportamiento

<Steps>
  <Step title="Leer datos locales">
    Consulta la tabla `chatwoot_integrations`. Este paso es rápido y siempre funciona.
  </Step>

  <Step title="Complementar con el estado actual (best-effort)">
    RyzeAPI intenta obtener el estado actual de la integración con un timeout de **10 s**. En caso de fallo de red, continúa con los datos locales.
  </Step>

  <Step title="Sobrescribir campos volátiles">
    Cuando el estado actual está disponible, `status` y `last_error` se reemplazan con los valores en vivo.
  </Step>

  <Step title="Backfill de inbox_id">
    Si el `inbox_id` quedó disponible y el local sigue en `0`, se actualiza la base de datos (`SetInboxID`), útil para casos de consistencia eventual justo después del `set`.
  </Step>
</Steps>

## Errores

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

<Tip>
  Si `last_error` no está vacío, inspecciona el mensaje, usualmente indica que Chatwoot cerró la sesión (token rotado, inbox eliminada manualmente, etc.). Reactivar con [`POST /api/chatwoot/set/:instance`](/es/api/chatwoot/activate) suele resolverlo.
</Tip>

## Siguiente

<CardGroup cols={2}>
  <Card title="Reactivar / actualizar" icon="plug" href="/es/api/chatwoot/activate">
    Usa `POST /api/chatwoot/set/:instance` para corregir credenciales o flags.
  </Card>

  <Card title="Desactivar" icon="power-off" href="/es/api/chatwoot/deactivate">
    Elimina la integración.
  </Card>
</CardGroup>