説明
QPS 制限
この操作は、アカウントごとに 1 秒あたり最大 50 回呼び出すことができます。この制限を超えるリクエストは破棄され、サービス中断が発生します。この操作を呼び出すときは、この制限に注意することをお勧めします。
デバッグ
OpenAPI Explorer は、署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。
権限付与
次の表に、API 操作に対応する権限付与情報を示します。権限付与情報は、Action ポリシー要素で使用して、RAM ユーザーまたは RAM ロールにこの API 操作を呼び出す権限を付与できます。
操作: リソースに対する操作を指定するために Action 要素で使用できる値。
アクセスレベル: 各操作のアクセスレベル。レベルは、読み取り、書き込み、および一覧表示です。
リソースタイプ: 操作を実行するために RAM ユーザーまたは RAM ロールを承認できるリソースのタイプ。
必要なリソースタイプは強調表示されています。
リソースレベルで権限を付与できない場合は、操作の「リソースタイプ」列に「すべてのリソース」が使用されます。
条件キー: Alibaba Cloud サービスによって定義された条件キー。
関連操作: 操作を完了するために RAM ユーザーまたは RAM ロールが実行する必要があるその他の操作。操作を完了するには、RAM ユーザーまたは RAM ロールに関連操作を実行する権限が必要です。
操作 | アクセスレベル | リソースタイプ | 条件キー | 関連操作 |
cams:CreateChatappTemplate | 書き込み |
| なし | なし |
リクエストパラメーター
パラメーター | タイプ | 必須 | 説明 | 例 |
Category | String | はい | メッセージテンプレートのカテゴリ。有効な値:
| UTILITY |
Components | Object | はい | メッセージテンプレートのコンポーネント。 説明 Category が AUTHENTICATION に設定されている場合、Components を HEADER に設定することはできません。 Type が BODY または FOOTER に設定されている場合、テキストコンテンツは空である必要があります。 | - |
Type | String | はい | コンポーネントタイプ。有効な値:
説明 WhatsApp メッセージテンプレートでは、BODY コンポーネントの長さは 1,024 文字を超えることはできません。 HEADER または FOOTER コンポーネントの長さは 60 文字を超えることはできません。 | BODY |
Text | String | いいえ | 送信するメッセージのテキスト。 説明 Category が AUTHENTICATION に設定されている場合、このパラメーターは空である必要があります。 | hello |
Format | String | いいえ | メディアリソースのタイプ。有効な値:
| TEXT |
Url | String | いいえ | メディアリソースの URL。 説明 メディアリソースのサイズは、要件を満たしている必要があります。パラメーターの詳細については、「メッセージテンプレートのパラメーター」トピックの「サポートされているメディアタイプとサイズ制限」セクションをご参照ください。 | https://image.developer.aliyundoc.com |
Caption | String | いいえ | ドキュメントの説明。 | これはビデオです。 |
FileName | String | いいえ | ドキュメントの名前。 | パッケージビデオ |
Buttons | Object | いいえ | ボタン。 Type を BUTTONS に設定した場合にのみ、このパラメーターを指定できます。 説明 WhatsApp メッセージテンプレートのボタン数の制限
| |
Type | String | はい | ボタンタイプ。有効な値:
説明 WhatsApp メッセージテンプレートの Category を AUTHENTICATION に設定した場合、ボタンは 1 つだけ許可され、ボタンのタイプは COPY_CODE または ONE_TAP である必要があります。 Category を COPY_CODE に設定した場合、Text は必須です。 Type を ONE_TAP に設定した場合、Text は必須であり、SignatureHash、PackageName、および AutofillText も必須です。目的のアプリがデバイスにインストールされていない場合は、Text の値が表示されます。 Text の値は、確認コードを手動でコピーする必要があることを示します。 | PHONE_NUMBER |
Text | String | いいえ | ボタンの表示名。 | Call Me |
PhoneNumber | String | いいえ | 電話番号。このパラメーターは、ボタンタイプが PHONE_NUMBER の場合にのみ有効です。 | +861368897**** |
Url | String | いいえ | URL ボタンをタップしたときにアクセスされる URL。 | https://example.com |
UrlType | String | いいえ | URL タイプ。有効な値:
| static |
SignatureHash | String | いいえ | WhatsApp がアプリを読み込むために使用するアプリ署名キーハッシュ。このパラメーターは、WhatsApp メッセージテンプレートの Category が AUTHENTICATION に設定され、Type が ONE_TAP に設定されている場合に必須です。 | wi299382 |
PackageName | String | いいえ | WhatsApp がアプリを読み込むために使用するアプリパッケージ名。このパラメーターは、WhatsApp メッセージテンプレートの Category が AUTHENTICATION に設定され、Type が ONE_TAP に設定されている場合に必須です。 | com.demo |
AutofillText | String | いいえ | 自動入力ボタンのテキスト。このパラメーターは、WhatsApp メッセージテンプレートの Category が AUTHENTICATION に設定され、Type が ONE_TAP に設定されている場合に必須です。 | Autofill |
IsOptOut | Boolean | いいえ | 登録解除ボタン。このパラメーターは、Category が MARKETING に設定され、ボタンタイプが QUICK_REPLY の場合に有効です。 Chat App Message Service コンソールでメッセージ送信制御が構成されていて、顧客がこのボタンをタップした場合、マーケティングメッセージは顧客に送信されません。 | false |
CouponCode | String | いいえ | プロモーションコード。文字と数字のみを含めることができます。このパラメーターは、$(couponCode) などの変数に設定できます。メッセージを送信するときに couponCode の値を指定します。 | 120293 |
FlowId | String | いいえ | フロー ID。 | 479884093605183 |
FlowAction | String | いいえ | フローアクション。 有効な値:
| NAVIGATE |
NavigateScreen | String | いいえ | 移動先の画面。 FlowAction が NAVIGATE に設定されている場合、このパラメーターは必須です。 | DETAILS |
CodeExpirationMinutes | Integer | いいえ | WhatsApp メッセージテンプレートの確認コードの有効期間。単位: 分。このパラメーターは、Category が AUTHENTICATION に設定され、Type が FOOTER に設定されている場合にのみ有効です。確認コードの有効期間はフッターに表示されます。 | 5 |
AddSecretRecommendation | Boolean | いいえ | 顧客が確認コードを他の人と共有しないことを示すメモ。メモはメッセージ本文に表示されます。このパラメーターは、Category が AUTHENTICATION に設定され、Type が BODY に設定されている場合にのみ有効です。 | true |
HasExpiration | Boolean | いいえ | プロモーションコードに有効期限があるかどうかを指定します。 Type が LIMITED_TIME_OFFER に設定されている場合、このパラメーターを指定します。 | true |
Cards | Object | いいえ | カルーセルテンプレートのカルーセルカード。 | |
CardComponents | Object | はい | カルーセルカードのコンポーネント。 | |
Type | String | はい | コンポーネントタイプ。有効な値:
| BODY |
Format | String | いいえ | メディアリソースのタイプ。このパラメーターは、Type が HEADER に設定されている場合に有効です。有効な値:
| IMAGE |
Text | String | いいえ | カルーセルカードの本文コンテンツ。 | 非常に強力なチームは誰ですか |
Url | String | いいえ | メディアリソースの URL。 | https://alibaba.com/img.png |
Buttons | Object | いいえ | ボタン。 Type を BUTTONS に設定した場合にのみ、このパラメーターを指定します。カルーセルカードには、最大 2 つのボタンを含めることができます。 | |
Text | String | いいえ | ボタンテキスト。 | Call me |
Type | String | はい | ボタンタイプ。有効な値:
| PHONE_NUMBER |
Url | String | いいえ | URL ボタンをタップしたときにアクセスされる URL。 | https://alibaba.com/xx |
UrlType | String | いいえ | URL タイプ。有効な値:
| static |
PhoneNumber | String | いいえ | 電話番号。 | +8613800 |
Name | String | はい | メッセージテンプレートの名前。 | hello_whatsapp |
Language | String | はい | メッセージテンプレートで使用される言語。詳細については、「言語コード」をご参照ください。 | en |
Example | Object | いいえ | テンプレート例。 | |
String | いいえ | サンプル変数。 このパラメーターは、元の JSON 構造を文字列に変換することによって渡されます。 | {"textVariable":"text"} | |
TemplateType | String | はい | メッセージテンプレートのタイプ。 | |
CustSpaceId | String | いいえ | 独立系ソフトウェアベンダー (ISV) アカウント内のユーザーのスペース ID。 | 293483938849493 |
AllowCategoryChange | Boolean | いいえ | Facebook がテンプレートのディレクトリを自動的に変更することを許可するかどうかを指定します。このパラメーターを true に設定すると、テンプレートのレビュー成功率が向上します。 | true |
MessageSendTtlSeconds | Integer | いいえ | WhatsApp の認証テンプレートによって送信されたメッセージの有効期間。 説明 Alibaba Cloud の運用スタッフがホワイトリストに追加できるように、事前に WhatsApp ビジネスアカウント (WABA) を提供する必要があります。そうしないと、メッセージテンプレートのレビュー提出に失敗します。 | 120 |
レスポンスパラメーター
パラメーター | タイプ | 説明 | 例 |
- | Object | 返された結果。 | - |
RequestId | String | リクエスト ID。 | 90E63D28-E31D-1EB2-8939-A94866411B2D |
Code | String | レスポンスコード。
| OK |
Message | String | エラーメッセージ。 | 指定されたリソースに対する操作がユーザーに許可されていません。 |
Data | Object | 返された結果。 | - |
TemplateCode | String | テンプレートコード。 | SMS_232907**** |
TemplateName | String | メッセージテンプレートの名前。 | hello_world |
AccessDeniedDetail | String | アクセス拒否の詳細。 | - |
例
成功レスポンスの例
JSON 形式
{
"RequestId": "90E63D28-E31D-1EB2-8939-A94866******",
"Code": "OK",
"Message": "指定されたリソースに対する操作がユーザーに許可されていません。",
"Data": {
"TemplateCode": "MSG_232907****",
"TemplateName": "hello_world"
},
"AccessDeniedDetail": "None"
}エラーコード
HTTP ステータスコード | エラーコード | 説明 |
400 | Product.Unsubscript | 指定されたプロダクトをサブスクライブしていません。 |
400 | Ram.PermissionDeny | 操作を実行する権限がありません。 |
400 | System.LimitControl | システムはフロー制御中です。 |
400 | Unknown.ResourceOwnerId | リソースは現在のユーザーに属していません。 |
エラーコードの一覧については、「サービスエラーコード」をご参照ください。