Obtains the review reports of a message template created in the Chat App Message Service console by specifying an HTTP URL.
Protocol
Parameter | Description |
Protocol | HTTP + JSON |
Encoding format | UTF-8 |
Request
Multiple review reports may be pushed to an HTTP server at a time.
Sample request
[
{
"WabaId": "9099999990****",
"TemplateCode": "744c4b5c79c9432497a075bdfca3****",
"Language": "en_US",
"AuditStatus": "unaudit",
"Reason": ""
},
{
"WabaId": "9099999990****",
"TemplateCode": "744c4b5c79c9432497a075bdfca*****",
"Language": "en_US",
"AuditStatus": "unaudit",
"Reason": ""
}
]
Request parameters
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 WhatsApp Business accounts (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
|
Response
After your HTTP server receives a review report, the HTTP status code in the response must be 200, and the response parameters must be in the following format. Otherwise, the system determines that the review report failed to be pushed and tries to push the review report again.
Sample response
{
"code" : 0,
"msg" : "Successful"
}
Response parameters
Parameter | Type | Required | Description |
code | Number | Yes | The response code. |
msg | String | No | The description of the response code. |
Retries
After the system fails to push a review report, it tries to push the review report again 1 minute later. If this retry fails, the system performs a second retry 5 minutes later. If the system fails to push a review report for three consecutive times, it no longer retries.