HTTP URL を指定することで、Chat App Message Service コンソールで作成されたメッセージテンプレートの審査レポートを取得します。
プロトコル
パラメーター | 説明 |
プロトコル | HTTP + JSON |
エンコーディング方式 | UTF-8 |
前提条件
Alibaba Cloud アカウントを登録し、AccessKey ペアを作成済みであること。 詳細については、「AccessKey ペアの作成」をご参照ください。
メッセージレシートの概要と設定を読み、メッセージレシートのパターン、タイプ、設定フローを理解していること。
テンプレート審査ステータスメッセージを設定するには、「テンプレート審査ステータスメッセージの設定」をご参照ください。
リクエスト
一度に複数の審査レポートが HTTP サーバーにプッシュされる場合があります。
リクエストのサンプル
[
{
"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 アカウント (WABA) ID。 説明 WhatsApp に登録後、WhatsApp の公式サイトから必要な情報を取得してください。 |
TemplateCode | String | はい | テンプレートコード。 説明 テンプレートコードは、Chat App Message Service コンソールの [テンプレートデザイン] ページのテンプレートリストで確認するか、ListChatappTemplate 操作を呼び出して取得できます。 |
Language | String | はい | テンプレートの言語。 |
AuditStatus | String | はい | メッセージテンプレートの審査ステータス。 有効値:
|
Reason | String | いいえ | 審査に失敗した理由。 説明 AuditStatus の戻り値が fail の場合に、このパラメーターの値が返されます。 |
V2
V2 は、独立系ソフトウェアベンダー (ISV) が顧客の WhatsApp Business アカウント (WABA) と電話番号を管理する必要がある場合に使用されます。
名前 | タイプ | 必須 | 説明 |
WabaId | String | はい | WABA ID。 説明 WhatsApp に登録後、WhatsApp の公式サイトからダウンロードできます。 |
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 日に送信できるメッセージの最大数。 説明
|
レスポンス
HTTP サーバーが審査レポートを受信した後、レスポンスの HTTP ステータスコードは 200 である必要があり、レスポンスパラメーターは次のフォーマットである必要があります。 そうでない場合、システムは審査レポートのプッシュに失敗したと判断し、審査レポートの再プッシュを試みます。
レスポンスのサンプル
{
"code" : 0,
"msg" : "Successful"
}レスポンスパラメーター
名前 | タイプ | 必須 | 説明 |
code | Number | はい | レスポンスコード。 |
msg | String | いいえ | 説明 |
再プッシュ
システムが審査レポートのプッシュに失敗した後、1 分後に審査レポートの再プッシュを試みます。 このリトライが失敗した場合、システムは 5 分後に 2 回目のリトライを実行します。 システムが 3 回連続で審査レポートのプッシュに失敗した場合、それ以上のリトライは行われません。