Platform health API reference

Platform health

A public, unauthenticated endpoint for your monitor: in one call it tells you whether the platform is up and whether the SMS provider is answering.

1 operation

Base URLhttps://api.messages.ccxcompany.co

AuthenticationNo authentication

The technical text below comes from the public contract, openapi.json, in the language the contract was written in.

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.

Responses

200Default Response

Response fields and example

Field	Type	Description
`status`required	`string`	Values:`okfail`
`uptimeSec`required	`number`
`checks`required	`object`
`checks.database`required	`object`
`checks.database.status`required	`string`	Values:`okfailskipped`
`checks.database.latencyMs`required	`integer`
`checks.cache`required	`object`
`checks.cache.status`required	`string`	Values:`okfailskipped`
`checks.cache.latencyMs`required	`integer`
`checks.workers`required	`object`
`checks.workers.status`required	`string`	Values:`okfailskipped`
`checks.workers.latencyMs`required	`integer`
`checks.apiRoutes`required	`object`
`checks.apiRoutes.status`required	`string`	Values:`okfailskipped`
`checks.apiRoutes.latencyMs`required	`integer`
`checks.smsProvider`optional	`object`
`checks.smsProvider.status`required	`string`	Values:`okfailskipped`
`checks.smsProvider.latencyMs`required	`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

Error responses follow RFC 7807 (application/problem+json), with a stable code in the code field. See the error codes

curl example

cURL

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

Required fields only. Swap the sample values for your own.

Platform health

Saúde da plataforma e do provedor de canal

Responses

curl example

Other API areas

Stuck on a route? Talk to the people who run the API.