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

Webhooks cho API Tại chỗ

Đăng ký Webhooks để nhận thông báo về tin nhắn mà doanh nghiệp bạn nhận được và thông tin mới về hồ sơ khách hàng. Hãy xem phần Tổng quan, Webhooks để biết thêm thông tin về webhook của Nền tảng WhatsApp Business.

Việc thiết lập Webhooks sẽ không ảnh hưởng đến số điện thoại trên Ứng dụng WhatsApp Business của bạn. Chỉ sau khi chuyển số điện thoại sang Nền tảng WhatsApp Business, bạn mới không dùng được số đó trên Ứng dụng WhatsApp Business nữa.

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

Bạn sẽ cần:

  • Mã hỗ trợ HTTPS và có chứng chỉ SSL hợp lệ
  • Điểm cuối URL gọi lại được đặt cấu hình để chấp nhận các yêu cầu mà Coreapp gửi đến
  • Điểm cuối URL gọi lại trả về phản hồi HTTPS 200 OK khi nhận được thông báo

Thử lại

Nếu một thông báo không gửi được vì bất cứ lý do gì hoặc nếu yêu cầu webhook trả về mã trạng thái HTTP không phải là 200, chúng tôi sẽ thử gửi lại thông báo đó. Chúng tôi sẽ tiếp tục thử gửi lại với độ trễ tăng dần lên đến khoảng thời gian chờ nhất định (thường là 24 giờ, mặc dù khoảng thời gian này có thể thay đổi) hoặc cho đến khi gửi thành công.

Đặt điểm cuối URL gọi lại

Gửi yêu cầu PATCH đến điểm cuối /v1/settings/application có thông số webhooks được đặt làm điểm cuối URL gọi lại của bạn. Các thông số thường được đặt cấu hình khác là sent_status và callback_persist.

Yêu cầu mẫu

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

Khi thành công, phản hồi sẽ chứa 200 OK kèm theo null hoặc một đối tượng JSON.

Hãy truy cập Tài liệu tham khảo về Cài đặt ứng dụng để biết thêm thông tin về cách đặt cấu hình ứng dụng và các thông số webhook bổ sung.

Phần tải dữ liệu thông báo của webhook

Mỗi khi một sự kiện kích hoạt diễn ra, Nền tảng WhatsApp Business sẽ xem xét sự kiện đó và gửi thông báo đến URL Webhook mà bạn đã chỉ định trước đây. Bạn có thể nhận được 2 loại thông báo:

  • Tin nhắn đã nhận: Thông báo này cho bạn biết thời điểm bạn nhận được tin nhắn. Thông báo này còn được gọi là "thông báo tin nhắn đến" trong toàn bộ tài liệu.
  • Thông báo trạng thái tin nhắn và giá cả: Thông báo này cho bạn biết thời điểm trạng thái tin nhắn thay đổi. Ví dụ: đã đọc hoặc đã gửi tin nhắn. Thông báo này còn được gọi là "thông báo tin nhắn đi" trong toàn bộ tài liệu.

Hãy xem phần Thành phần để biết thông tin về từng trường.

Thông báo lỗi

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

Điểm cuối ứng dụng mẫu

Để thử nghiệm Webhooks của mình, bạn có thể tạo một ứng dụng mẫu có điểm cuối để nhận thông báo.