Health

Health check and status endpoints

Get Meta Stack Health Status

get

Retrieve health status information for the Meta stack including connectivity and service availability. The health_status field is always requested. Additional fields (e.g. display_phone_number) can be requested via the fields query parameter and are concatenated with health_status into a single fields param.

Authorizations

D360-API-KEY

D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Query parameters

fieldsstringOptional

Comma-separated list of additional fields to return alongside health_status (e.g. display_phone_number)

Responses

200

Health status retrieved successfully

application/json

Response payload containing health status information for messaging and calling. health_status is always returned. The remaining fields are only returned when explicitly requested via the fields query parameter and mirror the corresponding fields on the Meta Graph WhatsApp Business phone number node.

account_modestringOptionalExample: LIVE

certificatestringOptional

code_verification_statusstringOptionalExample: VERIFIED

country_codestringOptionalExample: US

country_dial_codestringOptionalExample: 1

display_phone_numberstringOptionalExample: [phone]

host_platformstringOptionalExample: CLOUD_API

idstringOptionalExample: 106540352242922

is_official_business_accountbooleanOptionalExample: true

is_on_biz_appbooleanOptionalExample: false

is_preverified_numberbooleanOptionalExample: false

last_onboarded_timestringOptionalExample: 2024-01-15T10:00:00+0000

messaging_limit_tierstringOptionalExample: TIER_1K

name_statusstringOptionalExample: APPROVED

new_certificatestringOptional

new_display_namestringOptionalExample: Jasper's Market EU

new_name_statusstringOptionalExample: PENDING_REVIEW

platform_typestringOptionalExample: CLOUD_API

quality_ratingstringOptionalExample: GREEN

statusstringOptionalExample: CONNECTED

verified_namestringOptionalExample: Jasper's Market

401

Unauthorized

application/json

500

Internal server error

application/json

get/health_status

HTTPcURLJavaScriptPython

GET /health_status HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Accept: */*

{
  "account_mode": "LIVE",
  "certificate": "text",
  "code_verification_status": "VERIFIED",
  "country_code": "US",
  "country_dial_code": "1",
  "display_phone_number": "[phone]",
  "health_status": {
    "can_send_message": "AVAILABLE",
    "entities": [
      {
        "additional_info": [
          "text"
        ],
        "can_receive_call_sip": "AVAILABLE",
        "can_send_message": "AVAILABLE",
        "entity_type": "PHONE_NUMBER",
        "errors": [
          {
            "error_code": 141002,
            "error_description": "Message templates can only be sent out if they are approved.",
            "possible_solution": "Edit or appeal the message template review decision."
          }
        ],
        "id": "106540352242922"
      }
    ]
  },
  "host_platform": "CLOUD_API",
  "id": "106540352242922",
  "is_official_business_account": true,
  "is_on_biz_app": false,
  "is_preverified_number": false,
  "last_onboarded_time": "2024-01-15T10:00:00+0000",
  "messaging_limit_tier": "TIER_1K",
  "name_status": "APPROVED",
  "new_certificate": "text",
  "new_display_name": "Jasper's Market EU",
  "new_name_status": "PENDING_REVIEW",
  "platform_type": "CLOUD_API",
  "quality_rating": "GREEN",
  "status": "CONNECTED",
  "verified_name": "Jasper's Market"
}