Thành phần Webhooks
Webhooks có một trường mảng ở cấp cao nhất cho biết nội dung đang được truyền tải. Các thành phần của mảng này là đối tượng JSON có trường chi tiết liên quan đến Webhook.
Webhook cho API Quản lý WhatsApp Business có thể chứa những đối tượng sau:
| Thông số | Mô tả |
|---|---|
| Đây là đối tượng mà bạn đã đăng ký. Đối với quy trình đăng ký nhúng, đối tượng này luôn là |
Đối tượng này chứa thông tin chi tiết về sự thay đổi đã kích hoạt lệnh gọi webhook. |
Đối tượng entry
| Thông số | Mô tả |
|---|---|
| ID của Tài khoản WhatsApp Business có chứa webhook này. |
| Thời gian của mục nhập. |
| Các thay đổi đã kích hoạt lệnh gọi webhook. Hãy xem đối tượng |
changes
| Thông số | Mô tả (Nhấp vào mũi tên ở cột bên trái để xem các giá trị được hỗ trợ.) |
|---|---|
| Chứa loại thông báo mà bạn sẽ nhận được trên webhook đó. |
| Chứa thông tin chi tiết về các thay đổi liên quan đến |
value
| Thông số | Mô tả (Nhấp vào mũi tên ở cột bên trái để xem các giá trị được hỗ trợ.) |
|---|---|
| Được thêm vào webhook khi một tài khoản bị cấm. Đối tượng này bao gồm 2 thuộc tính:
|
| Chứa giới hạn hiện tại về hạng của tài khoản này. |
| Được dùng nếu có quyết định về tài khoản hoặc số điện thoại. |
| Bao gồm số điện thoại hiển thị của tài khoản kinh doanh đã kích hoạt thông báo. |
| Được dùng khi một sự kiện xảy ra trong WABA cụ thể. Hãy nhấp vào mũi tên ở cột bên trái để xem tất cả tùy chọn hiện có. |
| Luôn hiển thị khi Cho biết số lượng tin nhắn mẫu bạn có thể gửi bằng mỗi số điện thoại của doanh nghiệp thuộc Tài khoản WhatsApp Business có tên hiển thị đã được phê duyệt. Hãy xem phần Giới hạn nhắn tin. |
| Bao gồm số lượng số điện thoại tối đa mà một doanh nghiệp có thể sở hữu. Khi field=business_capability_update, một webhook sẽ hiển thị max_phone_numbers_per_business hoặc max_phone_numbers_per_waba. |
| Bao gồm số lượng số điện thoại tối đa mà một WABA có thể sở hữu. Khi field=business_capability_update, một webhook sẽ hiển thị max_phone_numbers_per_business hoặc max_phone_numbers_per_waba. |
| Lý do từ chối mẫu. Giá trị có thể dùng:
|
| Nếu một yêu cầu bị từ chối, trường này sẽ hiển thị lý do từ chối. |
| Trường này hiển thị tên được gửi đi xác minh. |
enum | Được dùng để báo cáo những hạn chế mà chúng tôi đã áp dụng đối với một WABA cụ thể khi WABA đó vi phạm các chính sách của Nền tảng WhatsApp Business. Trường này bao gồm danh sách các loại hạn chế và ngày hết hạn tương ứng. Dưới đây là các loại hạn chế có thể áp dụng:
Ngày hết hạn được cung cấp theo định dạng DateTime. |
| ID của người dùng yêu cầu vô hiệu hóa hoặc đã vô hiệu hóa/cập nhật mã xác minh hai bước. |
Ví dụ
Thay đổi về trạng thái mẫu tin nhắn
Đã phê duyệt mẫu
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "whatsapp-business-account-id",
"time": 1604703141,
"changes": [
{
"field": "message_template_status_update",
"value": {
"event": "APPROVED",
"message_template_id": 1234567,
"message_template_name": "My message template",
"message_template_language": "en-US",
"reason": null
}
}
]
}
]
}
Đã từ chối mẫu
{
"object": "whatsapp_business_account"
"entry": [
{
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
"time": <TIMESTAMP>,
"changes": [
{
"value": {
"event": "REJECTED",
"message_template_id": <TEMPLATE_ID>,
"message_template_name": "<TEMPLATE_NAME>",
"message_template_language": "<LANGUAGE_AND_LOCALE_CODE>",
"reason": "<REJECTION_REASON>"
},
"field": "message_template_status_update"
}
]
}
]
}Đã đặt lịch vô hiệu hóa mẫu
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
"time": TIMESTAMP,
"changes": [
{
"field": "message_template_status_update",
"value": {
"event": "FLAGGED",
"message_template_id": TEMPLATE-ID,
"message_template_name": "My message template",
"message_template_language": "en-US",
"reason": null,
"disable_info": {
"disable_date": "DATE",
}
}
}
]
}
]
}
Đã tạm dừng mẫu
{
"object": "whatsapp_business account",
"entry": [
{
"id": "10908...",
"time": 1661885238,
"changes": [
{
"value": {
"event": "PAUSED",
"message_template_id": 6048...,
"message_template_name": "welcome",
"message_template_language": "en_US",
"reason": "NONE",
"other_info": {
"title": "SECOND_PAUSE",
"description": "Your WhatsApp message template has been paused for 6 hours until Aug 31 at 12:47 AM UTC because it continued to have issues."
}
},
"field": "message_template_status_update"
}
]
}
],
}
Đang chờ xóa tin nhắn mẫu
{
"object": "whatsapp_business account",
"entry": [
{
"id": "10310...",
"time": TIMESTAMP,
"changes": [
{
"value": {
"event": "PENDING_DELETION",
"message_template_id": 1137...,
"message_template_name": "<MY_TEMPLATE_NAME>",
"message_template_language": "en_US",
"reason": "NONE"
}
},
"field": "message_template_status_update"
}
]
}
],
}
Thay đổi về hạng mục mẫu
Đã thay đổi hạng mục mẫu
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "<ID>",
"time": <TIME>,
"changes": [
{
"field": "template_category_update",
"value": {
"message_template_id": <MESSAGE_TEMPLATE_ID>,
"message_template_name": "<MESSAGE_TEMPLATE_NAME>",
"message_template_language": "<MESSAGE_TEMPLATE_LANGUAGE",
"previous_category": "<PREVIOUS_CATEGORY>",
"new_category": "<NEW_CATEGORY>"
}
}
]
}
]
}
Thay đổi về chất lượng mẫu tin nhắn
Đã thay đổi xếp hạng chất lượng mẫu
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
"time": <TIMESTAMP>,
"changes": [
{
"field": "message_template_quality_update",
"value": {
"previous_quality_score": "<PREVIOUS_QUALITY_SCORE>",
"new_quality_score": "<NEW_QUALITY_SCORE>",
"message_template_id": <TEMPLATE_ID>,
"message_template_name": "<TEMPLATE_NAME>",
"message_template_language": "<LANGUAGE_AND_LOCALE_CODE>"
}
}
]
}
]
}Thay đổi về số điện thoại
Đã nhận được cập nhật về tên
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "waba-id",
"time": 1608243053,
"changes": [
{
"field": "phone_number_name_update",
"value": {
"display_phone_number": "16505551111",
"decision": "APPROVED",
"requested_verified_name": "WhatsApp",
"rejection_reason": null
}
}
]
}
]
}
Đã nhận được cập nhật về chất lượng
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "waba-id",
"time": 1608243062,
"changes": [
{
"field": "phone_number_quality_update",
"value": {
"display_phone_number": "16505551111",
"event": "FLAGGED",
"current_limit": "TIER_10K"
}
}
]
}
]
}
Thay đổi về WABA
Đã nâng cấp số điện thoại trong hộp cát lên tài khoản đã xác minh
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "whatsapp-business-account-id",
"time": 1604703058,
"changes": [
{
"field": "account_update",
"value": {
"phone_number": "16505551111",
"event": "VERIFIED_ACCOUNT"
}
}
]
}
]
}
Đã cấm tài khoản WhatsApp Business
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "whatsapp-business-account-id",
"time": 1604703058,
"changes": [
{
"field": "account_update",
"value": {
"event": "DISABLED_UPDATE"
"ban_info": {
"waba_ban_state": ["SCHEDULE_FOR_DISABLE", "DISABLE", "REINSTATE"],
"waba_ban_date": "January 31, 2021"
}
}
}
]
}
]
}
Tài khoản WhatsApp Business vi phạm chính sách
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
"time": TIMESTAMP,
"changes": [
{
"value": {
"event": "ACCOUNT_VIOLATION",
"violation_info": {
"violation_type": "VIOLATION_TYPE"
}
},
"field": "account_update"
}
]
}
]
}Đã hạn chế tài khoản WhatsApp Business sau khi vi phạm chính sách
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
"time": TIMESTAMP,
"changes": [
{
"value": {
"event": "ACCOUNT_RESTRICTION",
"restriction_info": [
{"restriction_type":
"RESTRICTED_BIZ_INITIATED_MESSAGING" |
"RESTRICTION_ON_ADD_PHONE_NUMBER_ACTION" |
"RESTRICTED_CUSTOMER_INITIATED_MESSAGING",
"expiration": TIMESTAMP}
]
}
},
"field": "account_update"
}
]
}
]
}Đã vô hiệu hóa tài khoản WhatsApp Business
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
"time": TIMESTAMP,
"changes": [
{
"value": {
"event": "DISABLED_UPDATE",
"ban_info": {
"waba_ban_state":
"SCHEDULE_FOR_DISABLE" |
"DISABLE" |
"REINSTATE",
"waba_ban_date": TIMESTAMP
}
},
"field": "account_update"
}
]
}
]
}Đã hoàn tất quy trình xét duyệt tài khoản WhatsApp Business
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "whatsapp-business-account-id",
"time": 1604703141,
"changes": [
{
"field": "account_review_update",
"value": {
"decision": "APPROVED"
}
}
]
}
]
}
Đã hạn chế tài khoản WhatsApp Business do vi phạm chính sách
{
"field": "account_update",
"value": {
"phone_number": "PHONE_NUMBER",
"event": "ACCOUNT_RESTRICTION",
"restriction_info": [
{
"restriction_type": "RESTRICTION_ADD_PHONE_NUMBER_ACTION",
"expiration": TIMESTAMP
},
{
"restriction_type": "RESTRICTED_BIZ_INITIATED_MESSAGING",
"expiration": TIMESTAMP
},
{
"restriction_type": "RESTRICTED_CUSTOMER_INITIATED_MESSAGING",
"expiration": TIMESTAMP
}
]
}
}Đã xóa tài khoản WhatsApp Business
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
"time": TIMESTAMP,
"changes": [
{
"value": {
"phone_number": "15551...",
"event": "ACCOUNT_DELETED",
},
"field": "account_update"
}
]
}
]
}Đã gỡ tài khoản WhatsApp Business khỏi đối tác
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
"time": TIMESTAMP,
"changes": [
{
"value": {
"phone_number": "15551...",
"event": "PARTNER_REMOVED",
},
"field": "account_update"
}
]
}
]
}Thay đổi về năng lực kinh doanh
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
"time": TIMESTAMP,
"changes": [
{
"field": "business_capability_update",
"value": {
"max_daily_conversation_per_phone": NUMBER,
"max_phone_numbers_per_business": NUMBER
}
}
]
}
]
}Cảnh báo tài khoản
Đã từ chối tăng giới hạn nhắn tin
{
"entry": [
{
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
"time": <UNIX_TIMESTAMP>,
"changes": [
{
"value": {
"entity_type": "BUSINESS",
"entity_id": "<BUSINESS_ID>",
"alert_severity": "CRITICAL",
"alert_status": "ACTIVE",
"alert_type": "INCREASED_CAPABILITIES_ELIGIBILITY_FAILED",
"alert_description": "Based on your activity, limits cannot be increased for your business <BUSINES_NAME>. Contact support for more information."
},
"field": "account_alerts"
}
]
}
],
"object": "whatsapp_business_account"
}Đã từ chối tăng giới hạn nhắn tin, cần thêm mức sử dụng
{
"entry": [
{
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
"time": <UNIX_TIMESTAMP>,
"changes": [
{
"value": {
"entity_type": "BUSINESS",
"entity_id": "<BUSINESS_ID>",
"alert_severity": "WARNING",
"alert_status": "ACTIVE",
"alert_type": "INCREASED_CAPABILITIES_ELIGIBILITY_DEFERRED",
"alert_description": "Limits cannot be increased for your business <BUSINES_NAME>. Use WhatsApp Business platform actively for several days and follow our messaging policies."
},
"field": "account_alerts"
}
]
}
],
"object": "whatsapp_business_account"
}Đã từ chối tăng giới hạn nhắn tin, cần thêm thông tin
{
"entry": [
{
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
"time": <UNIX_TIMESTAMP>,
"changes": [
{
"value": {
"entity_type": "BUSINESS",
"entity_id": "<BUSINESS_ID>",
"alert_severity": "WARNING",
"alert_status": "ACTIVE",
"alert_type": "INCREASED_CAPABILITIES_ELIGIBILITY_NEED_MORE_INFO",
"alert_description": "Additional verification is required for your business <BUSINESS_NAME>. Go to Security Center in Meta for Business to complete identity verification. To continue without completing additional verification, your business can use WhatsApp Business platform actively for several days and follow our messaging policies."
},
"field": "account_alerts"
}
]
}
],
"object": "whatsapp_business_account"
}