Pular para o conteúdo

GET /v1/channels/{id}/health

GET
/v1/channels/{id}/health
curl --request GET \
--url https://seu-endereco-da-api/v1/channels/example/health \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Ler canais (channels:read).

id
required
string
Media typeapplication/json
object
displayPhoneNumber
required
string
verifiedName
required
string
qualityRating
required
string
Allowed values: GREEN YELLOW RED UNKNOWN
messagingLimitTier
required
string
Allowed values: TIER_50 TIER_250 TIER_1K TIER_2K TIER_10K TIER_100K TIER_UNLIMITED UNKNOWN
marketingApiStatus
required

Inscrição do número no envio otimizado de marketing da Meta

string
nullable
nameStatus
required
string
Allowed values: APPROVED PENDING_REVIEW DECLINED AVAILABLE_WITHOUT_REVIEW EXPIRED NON_EXISTS UNKNOWN
status
required
string
codeVerificationStatus
required
string
accountMode
required
string
isOfficialBusinessAccount
required
boolean
throughputLevel
required
string
nullable
canSendMessage
required
string
Allowed values: AVAILABLE LIMITED BLOCKED UNKNOWN
isOnBizApp
required

The number is also in use on the WhatsApp Business app (coexistence)

boolean
platformType
required

CLOUD_API when the number is served by Cloud API

string
blockers
required
Array<object>
object
entity
required
string
Allowed values: WABA PHONE_NUMBER APP BUSINESS UNKNOWN
kind
required
string
Allowed values: messaging calling
code
required
string
title
required
string
message
required
string
possibleSolution
required
string
nullable
accountReviewStatus
required
string
checkedAt
required
string format: date-time

Example

{
"qualityRating": "GREEN",
"messagingLimitTier": "TIER_50",
"nameStatus": "APPROVED",
"canSendMessage": "AVAILABLE",
"blockers": [
{
"entity": "WABA",
"kind": "messaging"
}
]
}