使用方法
QPS 制限
この操作は、アカウントごとに 1 秒あたり最大 50 回呼び出すことができます。この制限を超えるリクエストは破棄され、サービス中断が発生します。この操作を呼び出すときは、この制限に注意することをお勧めします。
デバッグ
OpenAPI Explorer は署名の値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。
認証情報
次の表に、API に対応する認証情報を示します。認証情報は、Action ポリシー要素で使用して、RAM (Resource Access Management) ユーザーまたは RAM ロールにこの API 操作を呼び出す権限を付与できます。説明:
操作: リソースに対する操作を指定するために Action 要素で使用できる値。
アクセスレベル: 各操作のアクセスレベル。レベルは読み取り、書き込み、およびリストです。
リソースタイプ: RAM ユーザーまたは RAM ロールが操作を実行することを承認できるリソースのタイプ。次の項目に注意してください。
必須のリソースタイプは強調表示されています。
リソースレベルで権限を付与できない場合は、操作の「リソースタイプ」列に「すべてのリソース」が使用されます。
条件キー: Alibaba Cloud サービスによって定義された条件キー。
関連付けられた操作: 操作を完了するために RAM ユーザーまたは RAM ロールが実行する権限を持っている必要があるその他の操作。操作を完了するには、RAM ユーザーまたは RAM ロールが関連付けられた操作を実行する権限を持っている必要があります。
操作 | アクセスレベル | リソースタイプ | 条件キー | 関連付けられた操作 |
cams:ModifyChatappTemplate | 書き込み |
| なし | なし |
リクエストパラメーター
パラメーター | タイプ | 必須 | 説明 | 例 | ||||
Components | object [] | はい | メッセージテンプレートのコンポーネント。 | |||||
Type | string | はい | コンポーネントタイプ。有効な値:
説明 Viber メッセージテンプレートでは、画像、動画、ドキュメントなどのメディアリソースは HEADER コンポーネントに配置されます。 Viber メッセージにテキストと画像の両方が含まれている場合、画像はデバイスで受信したメッセージのテキストの下に配置されます。 | BODY | ||||
Text | string | いいえ | 送信するメッセージのテキスト。 | hello chatapp | ||||
Format | string | いいえ | メディアリソースのタイプ。有効な値:
| TEXT | ||||
Url | string | いいえ | メディアリソースの URL。 | https://img.tukuppt.com/png_preview/00/10/24/1GygxVK3F4.jpg | ||||
FileName | string | いいえ | ドキュメントの名前。 説明 Components パラメーターの Type サブパラメーターが HEADER に設定され、Format サブパラメーターが DOCUMENT に設定されている場合、このパラメーターを指定できます。 | Introduction Video | ||||
Buttons | object [] | いいえ | ボタン。 Components パラメーターの Type サブパラメーターを BUTTONS に設定した場合にのみ、このパラメーターを指定できます。 | |||||
Type | string | はい | ボタンのタイプ。有効な値:
| URL | ||||
Text | string | いいえ | ボタンのテキスト。 | Click | ||||
Url | string | いいえ | URL ボタンをクリックしたときにリダイレクトされる URL。 | https://www.website.com/ | ||||
UrlType | string | いいえ | URL タイプ。有効な値:
| dynamic | ||||
ThumbUrl | string | いいえ | Viber メッセージテンプレートの動画のサムネイル URL。 | https://cdn.multiplymall.mobiapp.cloud/cloudcode/yc-165407506207478-165511576113195/20220905/ec5b9737-1507-4208-bb27-8da3958da961.jpg?x-oss-process=image/resize,w_100 | ||||
Duration | integer | いいえ | Viber メッセージテンプレートの動画の長さ。有効な値: 0 ~ 600。単位: 秒。 | 120 | ||||
FileType | string | いいえ | Viber メッセージテンプレートに添付されているドキュメントのタイプ。 | docx | ||||
Language | string | はい | テンプレート言語。 詳細については、「言語コード」をご参照ください。 | en | ||||
Example | object | いいえ | メッセージテンプレートを作成するときに使用される変数の例。 | |||||
string | いいえ | 変数の値。このパラメーターを指定する前に、値の形式を JSON から文字列に変更する必要があります。 | {"textVariable":"text"} | |||||
TemplateCode | string | はい | メッセージテンプレートコード。 | 8472929283883 | ||||
CustSpaceId | string | いいえ | ISV (独立系ソフトウェアベンダー) アカウント内の RAM ユーザーのスペース ID。 | 28251486512358**** | ||||
Category | string | いいえ | Viber テンプレートのカテゴリ。有効な値:
| text | ||||
TemplateType | string | いいえ | メッセージテンプレートのタイプ。有効な値:
| VIBER |
レスポンスパラメーター
パラメーター | タイプ | 説明 | 例 | |
object | レスポンスパラメーター。 | |||
RequestId | string | リクエスト ID。 | 90E63D28-E31D-1EB2-8939-A9486641**** | |
Code | string | エラーコード。
| OK | |
Message | string | エラーメッセージ。 | なし | |
Data | object | 返された結果。 | ||
TemplateCode | string | テンプレートコード。 | 8472929283883 | |
TemplateName | string | テンプレートの名前。 | hello_whatsapp | |
AccessDeniedDetail | string | アクセス拒否に関する詳細。 | なし |
例
成功レスポンスの例
JSON 形式
{
"RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
"Code": "OK",
"Message": "None",
"Data": {
"TemplateCode": "8472929283883",
"TemplateName": "hello_world"
},
"AccessDeniedDetail": "None"
}
エラーコード
HTTP ステータスコード | エラーコード | エラーメッセージ |
400 | Product.Unsubscript | 指定されたプロダクトをサブスクライブしていません。 |
400 | Ram.PermissionDeny | 操作を実行する権限がありません。 |
400 | System.LimitControl | システムはフロー制御中です。 |
400 | Unknown.ResourceOwnerId | リソースは現在のユーザーに属していません。 |
エラーコードのリストについては、「サービスエラーコード」をご参照ください。