Estado de la plataforma: referencia de la API

Estado de la plataforma

Un endpoint público y sin autenticación para tu monitor: en una sola consulta indica si la plataforma está activa y si el proveedor de SMS responde.

1 operación

URL basehttps://api.messages.ccxcompany.co

AutenticaciónSin autenticación

El texto técnico de abajo viene del contrato público, openapi.json, en el idioma en que se escribió el contrato.

Saúde da plataforma e do provedor de canal

GET/health/deep

Endpoint público e sem autenticação, desenhado para o seu monitor sintético consultar a cada minuto. Leia o campo smsProvider, não apenas o código HTTP.

Faz as checagens internas da plataforma MAIS uma sonda de leitura no provedor de SMS (uma operação barata, nunca um envio). O resultado da sonda é cacheado por 30 segundos.

Leia o campo `smsProvider`, não apenas o código HTTP — é ele que separa os dois cenários:

Leitura	Diagnóstico
`status: "fail"` (HTTP 503)	Plataforma CCX indisponível
`status: "ok"` + `smsProvider: "fail"`	CCX no ar, provedor do canal fora
`status: "ok"` + `smsProvider: "ok"`	Ambos no ar

smsProvider NÃO entra no status agregado de propósito: um provedor fora do ar não deve tirar a plataforma inteira de operação, levando junto WhatsApp, e-mail e painel.

skipped num campo significa que aquela dependência não está configurada neste ambiente — não é falha.

Respuestas

200Default Response

Campos y ejemplo de la respuesta

Campo	Tipo	Descripción
`status`obligatorio	`string`	Valores:`okfail`
`uptimeSec`obligatorio	`number`
`checks`obligatorio	`object`
`checks.database`obligatorio	`object`
`checks.database.status`obligatorio	`string`	Valores:`okfailskipped`
`checks.database.latencyMs`obligatorio	`integer`
`checks.cache`obligatorio	`object`
`checks.cache.status`obligatorio	`string`	Valores:`okfailskipped`
`checks.cache.latencyMs`obligatorio	`integer`
`checks.workers`obligatorio	`object`
`checks.workers.status`obligatorio	`string`	Valores:`okfailskipped`
`checks.workers.latencyMs`obligatorio	`integer`
`checks.apiRoutes`obligatorio	`object`
`checks.apiRoutes.status`obligatorio	`string`	Valores:`okfailskipped`
`checks.apiRoutes.latencyMs`obligatorio	`integer`
`checks.smsProvider`opcional	`object`
`checks.smsProvider.status`obligatorio	`string`	Valores:`okfailskipped`
`checks.smsProvider.latencyMs`obligatorio	`integer`

JSON

{  "status": "ok",  "uptimeSec": 0,  "checks": {    "database": {      "status": "ok",      "latencyMs": 0    },    "cache": {      "status": "ok",      "latencyMs": 0    },    "workers": {      "status": "ok",      "latencyMs": 0    },    "apiRoutes": {      "status": "ok",      "latencyMs": 0    },    "smsProvider": {      "status": "ok",      "latencyMs": 0    }  }}

503Default Response

Las respuestas de error siguen el formato RFC 7807 (application/problem+json), con un código estable en el campo code. Ver los códigos de error

Ejemplo en curl

cURL

curl 'https://api.messages.ccxcompany.co/health/deep'

Solo los campos obligatorios. Cambia los valores de ejemplo por los tuyos.

Estado de la plataforma

Saúde da plataforma e do provedor de canal

Respuestas

Ejemplo en curl

Otras áreas de la API

¿Atascado en una ruta? Habla con quienes mantienen la API.