Skip to content

Channel Health

GET
/platform/v1/channels/{channel_id}/health
curl --request GET \
--url https://example.com/platform/v1/channels/1/health

Return live + cached health diagnostics for a WhatsApp channel.

Merges Meta’s live phone-number GET (health_status, quality_rating, messaging_limit_tier, name_status, code_verification_status) with the channel’s DB-cached snapshot (last written by the inbound phone_number_quality_update webhook). Adds the derived booleans webhook_configured and token_present so the developer can program against operational readiness without seeing the token.

channel_id
required
Channel Id
integer

Successful Response

Media type application/json
Example generated
example

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}