Webhooks สำหรับ API ภายในองค์กร

สมัครรับข้อมูล Webhooks เพื่อรับการแจ้งเตือนเกี่ยวกับข้อความที่ธุรกิจของคุณได้รับและรับการอัพเดตโปรไฟล์ลูกค้า โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับ Webhooks ของแพลตฟอร์ม WhatsApp Business ที่ภาพรวม, Webhooks

การตั้งค่า Webhooks จะไม่ส่งผลกระทบต่อหมายเลขโทรศัพท์ในแอพ WhatsApp Business ของคุณ คุณจะใช้หมายเลขโทรศัพท์ดังกล่าวในแอพ WhatsApp Business ไม่ได้อีกต่อไปก็ต่อเมื่อคุณได้ย้ายหมายเลขนั้นไปยังแพลตฟอร์ม WhatsApp Business แล้ว

ก่อนเริ่มต้น

คุณจำเป็นต้องมีสิ่งต่อไปนี้

  • โค้ดที่รองรับ HTTPS และมีใบรับรอง SSL ที่ถูกต้อง
  • ตำแหน่งข้อมูล URL การเรียกกลับ ซึ่งได้รับการกำหนดค่าให้ยอมรับคำขอขาเข้าจาก Coreapp
  • ตำแหน่งข้อมูล URL การเรียกกลับ ซึ่งส่งการตอบกลับมาเป็น HTTPS 200 OK เมื่อได้รับการแจ้งเตือน

ลองอีกครั้ง

หากการแจ้งเตือนส่งไปไม่ถึงผู้รับด้วยเหตุผลใดๆ หรือหากคำขอ Webhook ส่งรหัสสถานะ HTTP ที่นอกเหนือจาก 200 กลับมา เราจะลองส่งอีกครั้ง ทั้งนี้ เราจะลองส่งใหม่ต่อไปโดยเว้นระยะให้นานขึ้นเรื่อยๆ จนถึงเพดานการหมดเวลา (โดยทั่วไปจะอยู่ที่ 24 ชั่วโมง แต่อาจเปลี่ยนแปลงได้) หรือจนกว่าจะส่งได้สำเร็จ

ตั้งค่าตำแหน่งข้อมูล URL การเรียกกลับ

ส่งคำขอ PATCH ไปยังตำแหน่งข้อมูล /v1/settings/application โดยตั้งค่าพารามิเตอร์ webhooks เป็นตำแหน่งข้อมูล URL การเรียกกลับของคุณ พารามิเตอร์อื่นๆ ที่มักได้รับการกำหนดค่า ได้แก่ sent_status และ callback_persist

ตัวอย่างคำขอ

PATCH /v1/settings/application
{
    "callback_persist": true,
    "sent_status": true,  // Either use this or webhooks.message.sent, but webhooks.message.sent property is preferred as sent_status will be deprecated soon
    "webhooks": { 
    	"url": "webhook.your-domain", 
        "message": {     // Available on v2.41.2 and above
        	"sent": false,
        	"delivered": true,
        	"read": false
       },
    }
}

เมื่อสำเร็จ การตอบกลับจะมี 200 OK พร้อม null หรืออ็อบเจ็กต์ JSON

โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการกำหนดค่าแอพและพารามิเตอร์ Webhooks เพิ่มเติมที่ข้อมูลอ้างอิงเกี่ยวกับการตั้งค่าแอพพลิเคชั่น

เพย์โหลดการแจ้งเตือน Webhook

เมื่อใดก็ตามที่เกิดเหตุการณ์ที่กำหนดไว้ขึ้น แพลตฟอร์ม WhatsApp Business จะพบเหตุการณ์ดังกล่าว จากนั้นจะส่งการแจ้งเตือนไปยัง URL ของ Webhook ที่คุณระบุไว้ก่อนหน้านี้ คุณจะได้รับการแจ้งเตือน 2 ประเภท ได้แก่

  • ข่อความที่ได้รับ: การแจ้งเตือนนี้จะแจ้งให้คุณทราบเมื่อคุณได้รับข้อความ หรือเรียกอีกอย่างว่า "การแจ้งเตือนขาเข้า" ในทั้งเอกสารฉบับนี้
  • สถานะข้อความและการแจ้งเตือนการกำหนดราคา: การแจ้งเตือนนี้จะแจ้งให้คุณทราบเมื่อสถานะข้อความเปลี่ยนไป เช่น ข้อความได้รับการส่งถึงผู้รับแล้วหรือมีผู้อ่านข้อความแล้ว หรือเรียกอีกอย่างว่า "การแจ้งเตือนขาออก" ในทั้งเอกสารฉบับนี้

โปรดดูข้อมูลเกี่ยวกับแต่ละช่องที่องค์ประกอบ

การแจ้งเตือนข้อผิดพลาด

{
    "errors": [ {
       "code": <error-code>,
       "title": "<error-title>",
       "details": "<error-description>",
       "href": "location for error detail"
    },
    {
       ...
    }
    ]
 }

ตำแหน่งข้อมูลของแอพตัวอย่าง

หากต้องการทดสอบ Webhooks คุณสามารถสร้างแอพตัวอย่างขึ้นมาโดยมีตำแหน่งข้อมูลสำหรับใช้รับการแจ้งเตือนได้