HTTP URL を指定して、メッセージテンプレートの審査通知を取得します。
プロトコル仕様
項目 | 説明 |
プロトコル | HTTP + JSON |
エンコーディング方式 | UTF-8 |
前提条件
Alibaba Cloud アカウントを登録し、AccessKey ペアを作成済みであること。 詳細については、「AccessKey ペアの作成」をご参照ください。
メッセージ受信確認の概要と設定を確認し、そのモード、タイプ、設定プロセスを理解していること。 その後、それに応じてメッセージ受信確認を設定します。
リクエスト
一度に複数の審査レポートがプッシュされる場合があります。
リクエストの例
[
{
"WabaId": "9099999990****",
"TemplateCode": "744c4b5c79c9432497a075bdfca3****",
"Language": "en_US",
"AuditStatus": "unaudit",
"Reason": ""
},
{
"WabaId": "9099999990****",
"TemplateCode": "744c4b5c79c9432497a075bdfca*****",
"Language": "en_US",
"AuditStatus": "unaudit",
"Reason": ""
}
]リクエストパラメーター
V1
パラメーター | タイプ | 必須 | 説明 |
WabaId | String | はい | WhatsApp Business Account (WABA) ID。 説明 WABA を作成した後、Business Manager プラットフォームで WABA ID を取得します。 |
TemplateCode | String | はい | テンプレートコード。 説明 Chat App Message Service コンソールの [テンプレートデザイン] ページで取得するか、ListChatappTemplate 操作を呼び出して取得します。 |
Language | String | はい | テンプレート言語。 |
AuditStatus | String | はい | メッセージテンプレートの審査ステータス。 有効な値:
|
Reason | String | いいえ | 審査が失敗した理由。 説明 AuditStatus の戻り値が fail の場合に値が返されます。 |
V2
V2 は、独立系ソフトウェアベンダー (ISV) が顧客の WhatsApp Business Account (WABA) と電話番号を管理する必要がある場合に使用されます。
パラメーター | タイプ | 必須 | 説明 |
WabaId | String | はい | WABA ID。 説明 WABA を作成した後、Business Manager プラットフォームで WABA ID を取得します。 |
TemplateCode | String | はい | テンプレートコード。 説明 Chat App Message Service コンソールの [テンプレートデザイン] ページで取得するか、ListChatappTemplate 操作を呼び出して取得します。 |
Language | String | はい | テンプレート言語。 |
AuditStatus | String | はい | メッセージテンプレートの審査ステータス。 有効な値:
|
Reason | String | いいえ | 審査が失敗した理由。 説明 AuditStatus の戻り値が fail の場合に値が返されます。 |
Type | String | はい | 通知のタイプ。 有効な値:
説明 Type の戻り値が template の場合、V2 の審査レポートのパラメーターは V1 の審査レポートのパラメーターと同じです。 |
PhoneNumber | String | いいえ | 電話番号。 説明
|
Status | String | いいえ | ステータス。 説明
|
CurrentLimit | String | いいえ | 電話番号が 1 日に送信できるメッセージの最大数。 説明
|
応答
コールバックの受信を確認するには、ご利用のエンドポイントが 3 秒以内に HTTP 200 ステータスコードを返す必要があります。 応答本文は、次のフォーマットの JSON オブジェクトである必要があります。 そうでない場合、システムは審査レポートのプッシュに失敗したと判断し、再度プッシュを試みます。
応答の例
{
"code" : 0,
"msg" : "Successful"
}応答パラメーター
パラメーター | タイプ | 必須 | 説明 |
code | Number | はい | 応答コード。 |
msg | String | いいえ | 応答コードの説明。 |
リトライ
最初のプッシュ試行が失敗した場合、サービスは 1 分後、さらに 5 分後にリクエストをリトライします。 ご利用のエンドポイントが 200 以外の HTTP ステータスコードを返すか、リクエストがタイムアウトした場合、試行は失敗とみなされます。 3 回の試行が失敗した後、サービスはリトライを停止します。