API Tại chỗ của Nền tảng WhatsApp Business

Tình trạng

/v1/health

Sử dụng nút health để kiểm tra trạng thái của ứng dụng API WhatsApp Business.

Trước khi bạn bắt đầu

Nút health hỗ trợ xác thực bằng mã Bearer và khóa API.

Khóa 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.

Hạn chế

Khóa API bạn đặt phải có tối thiểu 12 ký tự và tối đa 128 ký tự.

Truy xuất

Thực hiện lệnh gọi GET đến nút này để truy xuất trạng thái của ứng dụng API WhatsApp Business.

Ví dụ

Yêu cầu:

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

Phản hồi cung cấp trạng thái tình trạng của cổng đến máy chủ WhatsApp. Nếu tiêu đề Authorization không hiển thị hoặc không hợp lệ, mã lỗi 401 sẽ được trả về.

Trường hợp Đơn kết nối

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

Trường hợp Độ sẵn sàng cao/Đa kết nối

{
    "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"
      },
    }
}

Ở chế độ Độ sẵn sàng cao, chỉ một Coreapp sẽ được kết nối với máy chủ WhatsApp, còn tất cả những nút khác chứa Master chính sẽ có gateway_status là disconnected. Ở chế độ Đa kết nối có X phân đoạn, X Coreapp sẽ được kết nối với máy chủ WhatsApp và Master chính cũng sẽ kết nối với máy chủ WhatsApp.

Thông số

TênMô tả

health

loại: Đối tượng

Chứa các trường mô tả tình trạng của ứng dụng API WhatsApp Business.

gateway_status

loại: Chuỗi

Trạng thái kết nối giữa Coreapp và máy chủ WhatsApp.


Giá trị được hỗ trợ:

  • connected, connecting - Tình trạng tốt.
  • uninitialized - Ứng dụng có thể đang trong quá trình nâng cấp hoặc khởi tạo sơ đồ cơ sở dữ liệu. Hãy thử lại sau vài phút và liên hệ với Bộ phận hỗ trợ của WhatsApp nếu bạn vẫn thấy trạng thái này.
  • unregistered - Bạn cần đăng ký ứng dụng API WhatsApp Business của mình. Hãy xem tài liệu về Đăng ký để biết thêm thông tin.
  • disconnected - Coreapp không được kết nối với máy chủ WhatsApp.

role

loại: Chuỗi

Vai trò của vùng chứa trong cách thiết lập Độ sẵn sàng cao/Đa kết nối. Hãy xem tài liệu về Độ sẵn sàng và khả năng mở rộng quy mô để biết thêm thông tin về những cách thiết lập này.


Giá trị được hỗ trợ: primary_master, secondary_master, coreapp