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

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.

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

​
Descripción

Devuelve el estado local de la integración de Chatwoot e intenta enriquecerlo con datos en vivo del bridge RyzeIntegrations (best-effort). El chatwootApiToken nunca se expone en esta respuesta.

​
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_inbox_id": 42,
  "chatwoot_inbox_name": "WhatsApp - Orion",
  "last_error": "",
  "created_at": "2026-04-20T10:15:30Z"
}
CampoDescripción
instance_nameNombre de la instancia.
statusactive / paused / error. Cuando el bridge responde, este valor es en vivo.
bridge_integration_idID devuelto por RyzeIntegrations en el momento del set.
chatwoot_base_urlURL de la instalación de Chatwoot.
chatwoot_account_idID numérico de la cuenta de Chatwoot.
chatwoot_inbox_idID del inbox creado por el bridge (se completa después del primer list que alcance el bridge con éxito).
chatwoot_inbox_nameNombre del inbox.
last_errorÚltimo mensaje de error reportado por el bridge. Vacío cuando está saludable.
created_atMarca de tiempo RFC 3339 de cuando se creó la integración.
El campo chatwootApiToken está serializado con la etiqueta json:"-", nunca aparece en la respuesta, ni siquiera para el TokenAccount de la cuenta propietaria.

​
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

Enriquecimiento en vivo (best-effort)

Si el bridge está habilitado, llama a GET /v1/integrations/<bridge_integration_id> con un timeout de 10 s. En caso de fallo de red, recurre a los datos locales.
3

Sobrescribir campos volátiles

Si el bridge respondió, status y last_error se reemplazan con los valores en vivo.
4

Backfill de inbox_id

Si el bridge devolvió un inbox_id y el local sigue siendo 0, se actualiza la base de datos (SetInboxID), útil para casos de consistencia eventual justo después del set.
5

404 del bridge se tolera

Cuando el bridge responde 404 para el bridge_integration_id, se trata como consistencia eventual (no es un error): procedemos con los datos locales.

​
Errores

HTTPerror.message
404instance not found
404no chatwoot integration for this instance
503integration gateway not configured (set BRIDGE_URL and BRIDGE_TOKEN)
Si last_error no está vacío, inspecciona el mensaje, usualmente indica que Chatwoot cerró la sesión (token rotado, inbox eliminado 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 local + bridge.