WhatsApp Business 플랫폼 온프레미스 API

상태

/v1/health

  health 노드를 사용하여 WhatsApp Business API 클라이언트의 상태를 확인합니다.

시작하기 전에

  health 노드는 Bearer 토큰과 API 키 인증을 지원합니다.

API 키

If you wish to monitor the health, metrics, and stats nodes from an orchestrator, Bearer tokens are not the best option for ongoing checks as they expire every 7 days. To mediate this, you can use an API key, which can be set using the WA_API_KEY environment variable in the waweb environment section in the .yml file of your installation setup. 
services:
...
  waweb:
  ...
    environment:
    ...
    WA_API_KEY: your-api-key-token
The API key you set must have a minimum of 12 characters and a maximum of 128 characters. The Webapp must be restarted whenever you change the API key.

제한 사항

설정하는 API 키는 12~128자 이내여야 합니다.

검색

  GET 호출을 이 노드로 보내 WhatsApp Business API 클라이언트의 상태를 가져옵니다.

예

요청:

GET /v1/health
{
  Authorization: Bearer your-auth-token | Apikey your-api-key-token
}

이 응답은 WhatsApp 서버에 대한 게이트웨이의 상태를 제공합니다.   Authorization 헤더가 없거나 유효하지 않을 경우 401 오류 코드가 반환됩니다.

단일 인스턴스

{
    "health": {
       "gateway_status": "connected | connecting | disconnected | uninitialized | unregistered"
    }
}

고가용성/다중 연결

{
    "health": {
      "your-hostname1:your-container-id1": {
          "gateway_status": "connected | connecting | disconnected | uninitialized | unregistered",
          "role": "primary_master | secondary_master | coreapp"
      },
      "your-hostname2:your-container-id2": {
          "gateway_status": "connected | connecting | disconnected | uninitialized | unregistered",
          "role": "primary_master | secondary_master | coreapp"
      },
    }
}

고가용성 모드에서는 하나의 Coreapp만 WhatsApp 서버로 연결되고 기본 마스터를 포함한 그 외의 다른 모든 노드는 gateway_status 가 disconnected가 됩니다. 다중 연결 모드에 X 샤드가 포함된 경우 X Coreapps가 WhatsApp 서버에 연결되고 기본 마스터도 WhatsApp 서버에 연결됩니다.

매개변수

이름설명

health

유형: 개체

WhatsApp Business API 클라이언트의 상태를 설명하는 필드를 포함합니다.

gateway_status

유형: 문자열

Coreapp과 WhatsApp 서버 사이의 연결 상태입니다.


지원되는 값:

  • connected, connecting — 상태가 정상입니다.
  • uninitialized — 앱이 데이터베이스 스키마를 업그레이드하거나 초기화하는 과정일 수 있습니다. 몇 분 후에 다시 시도해 보고, 이 상태가 지속되면 WhatsApp 지원에 문의하세요.
  • unregistered — WhatsApp Business API 클라이언트를 등록해야 합니다. 자세한 내용은 등록 문서를 참조하세요.
  • disconnected — Coreapp이 WhatsApp 서버에 연결되지 않았습니다.

role

유형: 문자열

고가용성/다중 연결 단계에서 컨테이너의 역할입니다. 이러한 설정에 대한 자세한 내용은 가용성 및 확장 문서를 참조하세요.


지원되는 값: primary_master, secondary_master, coreapp