How to receive template review reports by using Message Service (MNS) - Chat App Message Service

Obtains the review reports of a message template created in the Chat App Message Service console using a Simple Message Queue (SMQ, formerly MNS) queue.

Prerequisites

You have registered an Alibaba Cloud account and created an AccessKey pair. For more information, see Create an AccessKey pair.
You have read Introduction and configuration process of message receipts. You understand the mode, type, and configuration process of message receipts.

Note

To configure template review status messages, see Configure template review status messages.

Message body format

V1

Name	Type	Required	Description
WabaId	String	Yes	The WhatsApp Business Account (WABA) ID. Note Obtain the required information from the official WhatsApp website after you register for WhatsApp.
TemplateCode	String	Yes	The template code. Note You can view the template code in the template list on the Template Design page of the Chat App Message Service console or obtain it by calling the ListChatappTemplate operation.
Language	String	Yes	The template language.
AuditStatus	String	Yes	The review status of the message template. Valid values: pass: The message template is approved. fail: The message template is rejected. Audit: Under review unaudit: The message template is to be reviewed. disabled: Disable. paused
Reason	String	No	The reason for the review failure. Note A value is returned for this parameter when the return value of AuditStatus is fail.

V2

Note

V2 is used when the independent software vendor (ISV) needs to manage the WABAs and phone numbers of their customers.

Name	Type	Required	Description
WabaId	String	Yes	The WABA ID. Note After you register for WhatsApp, you can download it from the official WhatsApp website.
TemplateCode	String	Yes	The template code. Note You can obtain the template code on the Template Design page in the Chat App Message Service console or by calling the ListChatappTemplate operation.
Language	String	Yes	The template language.
AuditStatus	String	Yes	The review status of the message template. Valid values: pass: The message template is approved. Failed: Review failed Audit status: Under review unaudit: Unaudited disabled: Disabled Paused: Paused
Reason	String	No	The reason for the review failure. Note A value is returned for this parameter when the return value of AuditStatus is fail.
Type	String	Yes	The type of the notification. Valid values: template: The status of the message template changes. phoneNameUpdate: The status of the phone number name changes. phoneQualityUpdate: The quality rating of the phone number changes. GREEN: High quality YELLOW: Medium quality RED: Low quality UNKNOWN: Unknown wabaReviewUpdate: The review status of the WABA changes. wabaAccountUpdate: The WABA changes. templateCategoryUpdate: The type of the message template changes. templateQualityUpdate: The quality rating of the message template changes. Note If the return value of Type is template, the parameters in the review report of V2 are the same as those in the review report of V1.
PhoneNumber	String	No	The phone number. Note A value is returned when the value of Type is phoneNameUpdate, phoneQualityUpdate, or wabaAccountUpdate. This parameter is not applicable when Type is set to wabaReviewUpdate or template.
Status	String	No	The status. Note Valid values when the return value of Type is phoneNameUpdate: APPROVED: The phone number name is approved. REJECTED: The phone number name is rejected. DEFERRED: The review for the phone number name is delayed. Valid values when the return value of Type is phoneQualityUpdate. The values indicate the reasons why the quality rating of the phone number changes. ONBOARDING: The phone number is being used for registration. UPGRADE: The number of messages that the phone number can send is increased. DOWNGRADE: The number of messages that the phone number can send is decreased. FLAGGED: A tag is added to the phone number. UNFLAGGED: A tag is removed from the phone number. Valid values when the return value of Type is wabaAccountUpdate: DISABLED_UPDATE: SCHEDULE_FOR_DISABLE: The WABA is blocked. DISABLE: The WABA is disabled. REINSTATE: The WABA lock is removed. VERIFIED_ACCOUNT: The WABA is verified. ACCOUNT_RESTRICTION: If a WABA violates a policy of the WhatsApp Business Platform, the WABA is restricted. Valid values: RESTRICTED_BIZ_INITIATED_MESSAGING: The WABA is not allowed to send business-initiated messages. RESTRICTION_ON_ADD_PHONE_NUMBER_ACTION: The WABA is not allowed to add new phone numbers. RESTRICTED_CUSTOMER_INITIATED_MESSAGING: The WABA is not allowed to send customer-initiated messages. ACCOUNT_VIOLATION: The WABA has violated a policy. PHONE_NUMBER_ADDED: A phone number is added to the WABA. PHONE_NUMBER_REMOVED: A phone number is removed from the WABA. BUSINESS_VERIFICATION_STATUS_UPDATE: The verification status of the enterprise on the Business Manager platform of Meta is updated. BUSINESS_VERIFIED: The enterprise is approved. BUSINESS_REJECTED: The authentication request was rejected. MORE_INFORMATION_REQUESTED: The enterprise needs to provide more information. BUSINESS_REVOKED: The enterprise has revoked the review application. ACCOUNT_DELETED: The WABA is deleted. Valid values when the return value of Type is wabaReviewUpdate: APPROVED: The WABA is approved. REJECTED: The WABA is rejected. No value is returned for this parameter when the return value of Type is template.
CurrentLimit	String	No	The maximum number of messages that the phone number can send in a day. Note Valid values when the return value of Type is phoneQualityUpdate: TIER_50 TIER_250 TIER_1K TIER_10K TIER_100K TIER_UNLIMITED TIER_UN_SET Other statuses have no associated value.