สถานภาพ
/v1/health
ใช้โหนด health เพื่อตรวจสอบสถานะของไคลเอ็นต์ WhatsApp Business API ของคุณ
ก่อนเริ่มต้น
โหนด health รองรับโทเค็น Bearer และการยืนยันตัวตนของคีย์ API
คีย์ 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-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 ส่วนโหนดอื่นๆ ทั้งหมดรวมถึง Master หลักจะมี gateway_status เป็น disconnected ในโหมดการเชื่อมต่อหลายจุดที่มีชาร์ด X รายการ ระบบจะเชื่อมต่อ Coreapp X รายการกับเซิร์ฟเวอร์ WhatsApp ส่วน Master หลักก็จะเชื่อมต่อกับเซิร์ฟเวอร์ WhatsApp เช่นกัน
พารามิเตอร์
| ชื่อ | คำอธิบาย |
|---|---|
ประเภท: อ็อบเจ็กต์ | ประกอบด้วยช่องที่อธิบายสถานภาพของไคลเอ็นต์ WhatsApp Business API |
ประเภท: สตริง | สถานะของการเชื่อมต่อระหว่าง Coreapp และเซิร์ฟเวอร์ WhatsApp ค่าที่รองรับ:
|
ประเภท: สตริง | บทบาทของคอนเทนเนอร์ในการตั้งค่าแบบความพร้อมใช้งานสูง/การเชื่อมต่อหลายจุด ดูข้อมูลเพิ่มเติมเกี่ยวกับการตั้งค่าเหล่านี้ที่เอกสารประกอบเกี่ยวกับความพร้อมใช้งานและการปรับขนาด ค่าที่รองรับ: |