Saltar al contenido principal
GET
/
api
/
chatwoot
/
list
/
:instance
Estado / información
curl --request GET \
  --url https://api.example.com/api/chatwoot/list/:instance \
  --header 'token: <token>'
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

curl -X GET "https://ryzeapi.cloud/api/chatwoot/list/suporte" \
  -H "token: $Token_Account"

​
Respuesta exitosa

200 OK
{
  "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
}
CampoDescripción
instance_nameNombre de la instancia.
statusactive / paused / error. Cuando está disponible, refleja el estado actual.
bridge_integration_idID interno de la integración.
chatwoot_base_urlURL de la instalación de Chatwoot.
chatwoot_account_idID numérico de la cuenta de Chatwoot.
chatwoot_api_tokenToken de API (access_token) de la cuenta de Chatwoot, en plaintext. Proviene de la fila local descifrada. Consulta el aviso de abajo.
chatwoot_inbox_idID de la inbox creada en Chatwoot (se completa después del primer list que logre sincronizar).
chatwoot_inbox_nameNombre de la inbox.
last_errorÚltimo mensaje de error de la integración. Vacío cuando está saludable.
created_atMarca de tiempo RFC 3339 de la creación de la integración.
sign_messagesAntepone a cada mensaje enviado por un agente *Nombre*: (negrita de WhatsApp).
ignore_groupsNo enruta eventos de grupos hacia Chatwoot.
start_as_pendingCrea las nuevas conversaciones como pending en lugar de open.
reopen_resolvedReabre una conversación resolved cuando llega un nuevo mensaje, en lugar de crear una nueva.
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.
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.

​
Parámetros de ruta

​
instance
string
requerido
Nombre de la instancia (p. ej., suporte).

​
Cabeceras

​
token
string
requerido
TokenAccount o TokenInstance.

​
Comportamiento

1

Leer datos locales

Consulta la tabla chatwoot_integrations. Este paso es rápido y siempre funciona.
2

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

Sobrescribir campos volátiles

Cuando el estado actual está disponible, status y last_error se reemplazan con los valores en vivo.
4

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.

​
Errores

HTTPerror.message
404instance not found
404no chatwoot integration for this instance
503integration gateway not configured
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 suele resolverlo.

​
Siguiente

Reactivar / actualizar

Usa POST /api/chatwoot/set/:instance para corregir credenciales o flags.

Desactivar

Elimina la integración.