All Products
Search
Document Center

Chat App Message Service:ChatAppAudit

Last Updated:Apr 19, 2024

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:

  • pass: The message template is approved.

  • fail: The message template is rejected.

  • auditing: The message template is being reviewed.

  • unaudit: The message template is to be reviewed.

Reason

String

No

The reason for the review failure.

Note

A value is returned when the return value of AuditStatus is fail.

V2

Note

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:

  • pass: The message template is approved.

  • fail: The message template is rejected.

  • auditing: The message template is being reviewed.

  • unaudit: The message template is to be reviewed.

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:

  • template: The status of the message template changes.

  • phoneNameUpdate: The phone number name changes.

  • phoneQualityUpdate: The quality rating of the phone number changes.

  • wabaReviewUpdate: The review status of the WABA changes.

  • wabaAccountUpdate: The WABA 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
  • If the return value of Type is phoneNameUpdate, phoneQualityUpdate, or wabaAccountUpdate, a value is returned for PhoneNumber.

  • If the return value of Type is wabaReviewUpdate or template, no value is returned for PhoneNumber.

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 about WhatsApp Business Platform, the WABA will be 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: The phone number is added to the WABA.

    • PHONE_NUMBER_REMOVED: The 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 enterprise is 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 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

  • No value is returned for this parameter when the return value of Type is template, phoneNameUpdate, wabaReviewUpdate, or wabaAccountUpdate.

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.