ChatAppAudit

您可以通过指定HTTP URL来接收Chat App 消息服务模板审核状态。

协议说明

参数

说明

协议

HTTP + JSON

编码

UTF-8

请求说明

单次推送可能包含多条审核状态报告。

请求样例

[
 {    
 "WabaId": "9099999990****",        
 "TemplateCode": "744c4b5c79c9432497a075bdfca3****",    
 "Language": "en_US",    
 "AuditStatus": "unaudit",    
 "Reason": ""
 },
 {    
 "WabaId": "9099999990****",        
 "TemplateCode": "744c4b5c79c9432497a075bdfca*****",    
 "Language": "en_US",    
 "AuditStatus": "unaudit",    
 "Reason": ""
 }
]

字段说明

V1版本

名称

类型

是否必选

描述

WabaId

String

WABA的ID。

说明

WhatsApp完成注册后请在WhatsApp官网获取。

TemplateCode

String

模板编码。

说明

模板编码可通过Chat App 消息服务控制台模板设计页面,在模板列表查看或通过ListChatappTemplate接口获取

Language

String

模板语言。

AuditStatus

String

模板审核状态。取值:

  • pass:审核通过

  • fail:审核失败

  • auditing:审核中

  • unaudit:未审核

  • disabled:禁用

  • paused:暂停

Reason

String

模板审核不通过原因。

说明

AuditStatusfail时有值。

V2版本

说明

V2版本一般适用于ISV在需要管理客户WABA,号码状态等内容时使用。

名称

类型

是否必选

描述

WabaId

String

WABA的ID。

说明

WhatsApp完成注册后请在WhatsApp官网获取。

TemplateCode

String

模板编码。

说明

模板编码可通过Chat App 消息服务控制台模板设计页面,在模板列表查看或通过ListChatappTemplate接口获取

Language

String

模板语言。

AuditStatus

String

模板审核状态。取值:

  • pass:审核通过

  • fail:审核失败

  • auditing:审核中

  • unaudit:未审核

  • disabled:禁用

  • paused:暂停

Reason

String

模板审核不通过原因。

说明

AuditStatusfail时有值。

Type

String

通知类型。取值:

  • template:消息模板状态变更

  • phoneNameUpdate:电话号码名称状态变更

  • phoneQualityUpdate:电话号码质量变更

  • wabaReviewUpdate:WABA审核状态变更

  • wabaAccountUpdate:WABA账户变更

  • templateCategoryUpdate:模板类别更新

  • templateQualityUpdate:模板质量更新

说明

当值为template时,参数与V1版本一致。

PhoneNumber

String

号码。

说明
  • 当Type为phoneNameUpdate,phoneQualityUpdate,wabaAccountUpdate时有值;

  • 当Type为wabaReviewUpdate,template时没有值。

Status

String

状态。

说明
  • 当Type=phoneNameUpdate时取值:

    • APPROVED:电话号码名称审核通过。

    • REJECTED:电话号码名称被拒绝。

    • DEFERRED:电话号码名称审核推迟。

  • 当Type=phoneQualityUpdate时取值 (电话号码质量变化的原因):

    • ONBOARDING:号码注册。

    • UPGRADE:号码发送量升级。

    • DOWNGRADE:号码发送量降级。

    • FLAGGED:号码被标记。

    • UNFLAGGED:号码取消被标记状态。

  • 当Type= wabaAccountUpdate时取值:

    • DISABLED_UPDATE

      • SCHEDULE_FOR_DISABLE:WABA已禁用。

      • DISABLE:WABA被封号。

      • REINSTATE:WABA已解封。

    • VERIFIED_ACCOUNT:已认证的WABA账户。

    • ACCOUNT_RESTRICTION:WABA违反WhatsApp Business开放平台政策时,会对该WABA施加限制,可能包括以下取值:

      • RESTRICTED_BIZ_INITIATED_MESSAGING:下行消息受限。

      • RESTRICTION_ON_ADD_PHONE_NUMBER_ACTION:限制添加电话号码。

      • RESTRICTED_CUSTOMER_INITIATED_MESSAGING:上行消息受限。

    • ACCOUNT_VIOLATION:WABA账户违反政策。

    • PHONE_NUMBER_ADDED:WABA 账户增加电话号码。

    • PHONE_NUMBER_REMOVED:WABA 账户移除号码。

    • BUSINESS_VERIFICATION_STATUS_UPDATE:Facebook商业平台验证状态更新

      • BUSINESS_VERIFIED:验证通过。

      • BUSINESS_REJECTED:验证被拒绝。

      • MORE_INFORMATION_REQUESTED:需要提供更多信息。

      • BUSINESS_REVOKED:撤销审核申请。

    • ACCOUNT_DELETED:删除WABA账户

  • 当Type=wabaReviewUpdate时取值:

    • APPROVED :WABA审核通过。

    • REJECTED:WABA审核被拒绝。

  • 当Type=template时没有值。

CurrentLimit

String

号码的发送量限制。

说明
  • 当Type=phoneQualityUpdate时取值 :

    • TIER_50

    • TIER_250

    • TIER_1K

    • TIER_10K

    • TIER_100K

    • TIER_UNLIMITED

    • TIER_UN_SET

  • 其它状态没有值。

响应说明

接收到回执后,响应的HTTP状态码必须为200,且响应体格式需如下所示,否则会推送失败,触发重新推送。

响应样例

{
  "code" : 0,
  "msg" : "成功"
}

字段说明

名称

类型

是否必选

描述

code

Number

应答编码。

msg

String

描述信息。

重新推送

第一次推送失败后,间隔1分钟、5分钟后会进行重推,直至推送成功为止。如果推送3次后仍失败,不再重试。