/v1/health
Gunakan node health
simpul untuk memeriksa status klien API WhatsApp Business Anda.
Node health
mendukung token Bearer dan autentikasi kode API.
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-tokenThe 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.
Kunci API yang Anda atur harus memiliki minimal 12 karakter dan maksimal 128 karakter.
Buat panggilan GET
ke node ini untuk mengambil status klien API WhatsApp Business Anda.
Permintaan:
GET /v1/health { Authorization: Bearer your-auth-token | Apikey your-api-key-token }
Tanggapannya memberikan status kesehatan gateway ke server WhatsApp. Jika header Authorization
tidak ada atau tidak valid, kode kesalahan 401
ditampilkan.
{ "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" }, } }
Dalam mode Ketersediaan Tinggi, hanya satu Coreapp yang akan terhubung ke server WhatsApp, semua node lain termasuk Master utama akan memiliki gateway_status
: disconnected
. Dalam mode Multikoneksi dengan X
partisi, X
Coreapp akan terhubung ke server WhatsApp, dan Master utama juga akan terhubung ke server WhatsApp.
Nama | Deskripsi |
---|---|
jenis: Objek | Berisi kolom yang menjelaskan kesehatan klien API WhatsApp Business. |
jenis: String | Status koneksi antara server Coreapp dan WhatsApp. Nilai yang didukung:
|
jenis: String | Peran kontainer dalam penyiapan Ketersediaan/Multikoneksi Tinggi. Lihat dokumentasi Ketersediaan dan Penskalaan untuk informasi selengkapnya tentang pengaturan ini. Nilai yang didukung: |