メッセージテンプレートの一覧を取得します。
操作説明
QPS 制限
本オペレーションの QPS 制限は、ユーザーあたり 1 秒間に 5 回の呼び出しです。この制限を超えると、API の呼び出しがスロットルされ、ビジネスに影響を及ぼす可能性があります。適切なレートで本オペレーションを呼び出してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cams:ListChatappTemplate |
list |
*すべてのリソース。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Name |
string |
任意 |
テンプレート名。 |
hello_whatsapp |
| Language |
string |
任意 |
テンプレートの言語。言語コードについては、「言語コード」をご参照ください。 |
en |
| AuditStatus |
string |
任意 |
監査ステータス。有効な値:
|
pass |
| Page |
object |
任意 |
ページネーション設定。 |
"page": "{\"index\": 1,\"size\": 20} |
| Size |
integer |
必須 |
1 回のクエリで返すテンプレート数。デフォルト値: 10。 |
10 |
| Index |
integer |
必須 |
ページ番号。デフォルト値: 1。 |
1 |
CustWabaId
deprecated
|
string |
任意 |
ISV 顧客の WabaId。 説明
このパラメーターは非推奨です。代わりに CustSpaceId を使用してください。 |
65921621816**** |
| CustSpaceId |
string |
任意 |
ISV サブ顧客の SpaceId、または直接顧客のインスタンス ID。 |
28251486512358**** |
| TemplateType |
string |
任意 |
テンプレートタイプ。有効な値:
|
|
| Code |
string |
任意 |
テンプレートコード。 |
838888822***** |
| Category |
string |
任意 |
テンプレートカテゴリ。 |
AUTHENTICATION |
| IsvCode |
string |
任意 |
ISV によるサブアカウントの認可を検証するための ISV 検証コード。 |
skdi3kksloslikdkkdk |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
返されるデータ。 |
||
| AccessDeniedDetail |
string |
アクセス拒否の詳細。 |
None |
| Message |
string |
エラーメッセージ。 |
ユーザーは指定されたリソースで操作を実行する権限がありません |
| RequestId |
string |
リクエスト ID。 |
90E63D28-E31D-1EB2-8939-A9486641**** |
| ListTemplate |
array<object> |
リストデータ。 |
|
|
object |
テンプレートリスト。 |
||
| TemplateCode |
string |
テンプレートコード。 |
744c4b5c79c9432497a075bdfca3**** |
| AuditStatus |
string |
審査ステータス。有効な値:
|
pass |
| Category |
string |
WhatsApp テンプレートカテゴリ。有効な値:
Viber テンプレートカテゴリ:
|
UTILITY |
| Language |
string |
テンプレートの言語。言語コードについては、「言語コード」をご参照ください。 |
en |
| LastUpdateTime |
integer |
最終更新日時。ミリ秒単位のUNIXタイムスタンプで表されます。 |
1711006633000 |
| TemplateName |
string |
テンプレート名。 |
hello_whatsapp |
| TemplateType |
string |
テンプレートタイプ。有効な値:WHATSAPP または VIBER。 |
|
| Reason |
string |
テンプレートの審査が拒否された理由。 |
None |
| Total |
integer |
レコードの総数。 |
1 |
| Code |
string |
リクエストのステータスコード。
|
OK |
| Success |
boolean |
呼び出しが成功したかどうかを示します。有効な値:
|
false |
例
成功レスポンス
JSONJSON
{
"AccessDeniedDetail": "None",
"Message": "ユーザーは指定されたリソースで操作を実行する権限がありません",
"RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
"ListTemplate": [
{
"TemplateCode": "744c4b5c79c9432497a075bdfca3****",
"AuditStatus": "pass",
"Category": "UTILITY",
"Language": "en",
"LastUpdateTime": 1711006633000,
"TemplateName": "hello_whatsapp",
"TemplateType": "WHATSAPP",
"Reason": "None"
}
],
"Total": 1,
"Code": "OK",
"Success": false
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | Product.Unsubscript | You have not subscribed to the specified product. | |
| 400 | Ram.PermissionDeny | You are not authorized to perform the operation. | |
| 400 | System.LimitControl | The system is under flow control. | |
| 400 | Unknown.ResourceOwnerId | The resource does not belong to the current user. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。