説明
この操作は、アカウントごとに 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 | 文字列 | はい | Viber テンプレートのカテゴリ。有効な値:
| text |
Components | オブジェクト | はい | メッセージテンプレートのコンポーネント。 | |
Type | 文字列 | はい | コンポーネントタイプ。有効な値:
説明 Viber タイプのテンプレートでは、画像、ビデオ、ドキュメントは HEADER に配置されます (クライアントはテキストの下に画像を表示します)。 | BODY |
Text | 文字列 | いいえ | 送信するメッセージのテキスト。 | hello |
Format | 文字列 | いいえ | メディアリソースのタイプ。有効な値:
| TEXT |
Url | 文字列 | いいえ | メディアリソースの URL。 説明 Viber メッセージテンプレートでは 800 × 800 ピクセルの画像を使用することをお勧めします。 | https://image.developer.aliyundoc.com |
FileName | 文字列 | いいえ | ドキュメントの名前。 | Package video |
Buttons | オブジェクト | いいえ | ボタン。 Components パラメーターの Type サブパラメーターを BUTTONS に設定した場合にのみ、このパラメーターを指定できます。 | |
Type | 文字列 | はい | ボタンタイプ。有効な値:
説明 URL ボタンは 1 つだけ追加できます。 | URL |
Text | 文字列 | いいえ | ボタンの表示名。 | Click |
Url | 文字列 | いいえ | URL ボタンがタップされたときにアクセスされる URL。 | https://example.com |
UrlType | 文字列 | いいえ | URL タイプ。有効な値:
| static |
ThumbUrl | 文字列 | いいえ | Viber メッセージテンプレートのビデオのサムネイル URL。 | https://cdn.multiplymall.mobiapp.cloud/yunmall/B-L202207130001/20220730/d77ea60983.png?x-process=image/resize,w_100 |
Duration | 整数 | いいえ | Viber メッセージテンプレートのビデオの長さ。有効な値: 0 ~ 600。単位: 秒。 | 120 |
FileType | 文字列 | いいえ | Viber メッセージテンプレートに添付されているドキュメントのタイプ。 | docx |
Name | 文字列 | はい | メッセージテンプレートの名前。 | hello_world |
Language | 文字列 | はい | メッセージテンプレートで使用される言語。詳細については、「言語コード」をご参照ください。 | en |
Example | オブジェクト | いいえ | テンプレートの例。 | |
文字列 | いいえ | サンプル変数。このパラメーターは、元の JSON 構造を文字列に変換することによって渡されます。 | {"textVariable":"text"} | |
TemplateType | 文字列 | はい | メッセージテンプレートのタイプ。有効な値:
| VIBER |
CustSpaceId | 文字列 | いいえ | 独立系ソフトウェアベンダー (ISV) アカウント内のユーザーのスペース ID。 | 293483938849493 |
レスポンスパラメーター
パラメーター | タイプ | 説明 | 例 |
- | オブジェクト | 返された結果。 | - |
RequestId | 文字列 | リクエスト ID。 | 90E63D28-E31D-1EB2-8939-A94866411B2D |
Code | 文字列 | レスポンスコード。
| OK |
Message | 文字列 | エラーメッセージ。 | User not authorized to operate on the specified resource. |
Data | オブジェクト | 返された結果。 | - |
TemplateCode | 文字列 | テンプレートコード。 | SMS_232907**** |
TemplateName | 文字列 | メッセージテンプレートの名前。 | hello_world |
AccessDeniedDetail | 文字列 | アクセス拒否の詳細。 | - |
例
成功レスポンスの例
JSON 形式
{
"RequestId": "90E63D28-E31D-1EB2-8939-A94866******",
"Code": "OK",
"Message": "User not authorized to operate on the specified resource.",
"Data": {
"TemplateCode": "MSG_232907****",
"TemplateName": "hello_world"
},
"AccessDeniedDetail": "None"
}エラーコード
HTTP ステータスコード | エラーコード | 説明 |
400 | Product.Unsubscript | 指定されたプロダクトをサブスクライブしていません。 |
400 | Ram.PermissionDeny | 操作を実行する権限がありません。 |
400 | System.LimitControl | システムはフロー制御中です。 |
400 | Unknown.ResourceOwnerId | リソースは現在のユーザーに属していません。 |
エラーコードの一覧については、「サービスエラーコード」をご参照ください。