Obtains the review reports of a message template created in the Chat App Message Service console by using a Simple Message Queue (formerly MNS) queue.
Prerequisites
An Alibaba Cloud account is created and an AccessKey pair is created for the Alibaba Cloud account. For more information, see Create an AccessKey pair.
You read Configure message receipts and understand the format, type, and configuration process of message receipts.
Parameters that are included in the message body of a report
V1
Parameter | Type | Required | Description |
WabaId | String | Yes | The WhatsApp Business Account (WABA) ID. Note After you create a WABA, obtain the WABA ID on the Business Manager platform of Meta. |
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:
|
Reason | String | No | The reason for the review failure. Note A value is returned when the return value of AuditStatus is fail. |
V2
V2 is used when the independent software vendor (ISV) needs to manage the WABAs and the phone numbers of their customers.
Parameter | Type | Required | Description |
WabaId | String | Yes | The WABA ID. Note After you create a WABA, obtain the WABA ID on the Business Manager platform of Meta. |
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:
|
Reason | String | No | The reason for the review failure. Note A value is returned when the return value of AuditStatus is fail. |
Type | String | Yes | The type of the notification. Valid values:
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
|
Status | String | No | The status. Note
|
CurrentLimit | String | No | The maximum number of messages that the phone number can send in a day. Note
|