すべてのプロダクト
Search

このプロダクト

    :ListChatappTemplate

    ドキュメントセンター

    :ListChatappTemplate

    最終更新日:Dec 22, 2025

    メッセージテンプレートを照会します。

    操作説明

    QPS 制限

    1 つのアカウントで、1 秒あたり最大 5 回までこの操作を呼び出すことができます。1 秒あたりの呼び出し回数が制限を超えると、速度制限がトリガーされます。その結果、ビジネスに影響が出る可能性があります。この操作を呼び出す際は、制限に注意することを推奨します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    cams:ListChatappTemplate

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Name

    string

    任意

    テンプレートの名前。

    hello_whatsapp
    Language

    string

    任意

    メッセージテンプレートで使用される言語。詳細については、「言語コード」をご参照ください。

    en
    AuditStatus

    string

    任意

    テンプレートの審査ステータス。有効な値：

    • pass：テンプレートは承認済みです。

    • fail：テンプレートは拒否されました。

    • auditing：テンプレートは審査中です。

    • unaudit：審査は一時停止されています。

    pass
    Page

    object

    任意

    ページネーション設定。

    "page": "{\"index\": 1,\"size\": 20}
    Index

    integer

    必須

    ページ番号。デフォルト値：1。

    1
    Size

    integer

    必須

    1 ページあたりのエントリ数。デフォルト値：10。

    10
    CustWabaId deprecated

    string

    任意

    独立系ソフトウェアベンダー (ISV) アカウント内の RAM ユーザーの WhatsApp Business Account (WABA) ID。

    説明

    CustWabaId は廃止されたパラメーターです。代わりに CustSpaceId を使用してください。

    65921621816****

    IsvCode

    string

    任意

    ISV 検証コード。このパラメーターは、RAM ユーザーが ISV アカウントによって承認されているかどうかを検証するために使用されます。

    skdi3kksloslikdkkdk
    CustSpaceId

    string

    必須

    ISV アカウント内の RAM ユーザーのスペース ID。

    28251486512358****
    TemplateType

    string

    任意

    メッセージテンプレートのタイプ。

    • WHATSAPP

    • VIBER

    WHATSAPP
    Code

    string

    任意

    メッセージテンプレートのコード。

    838888822*****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    RequestId

    string

    リクエスト ID。

    90E63D28-E31D-1EB2-8939-A9486641****
    Code

    string

    返される HTTP ステータスコード。

    • OK の値は、呼び出しが成功したことを示します。

    • その他の値は、呼び出しが失敗したことを示します。詳細については、「エラーコード」をご参照ください。

    OK
    Message

    string

    返されたエラーメッセージ。

    User not authorized to operate on the specified resource.
    ListTemplate

    array<object>

    メッセージテンプレート。

    object

    照会されたテンプレート。

    TemplateName

    string

    メッセージテンプレートの名前。

    hello_whatsapp
    TemplateCode

    string

    メッセージテンプレートのコード。

    744c4b5c79c9432497a075bdfca3****
    AuditStatus

    string

    テンプレートの審査ステータス。有効な値：

    • pass：テンプレートは承認済みです。

    • fail：テンプレートは拒否されました。

    • auditing：テンプレートは審査中です。

    • unaudit：審査は一時停止されています。

    pass
    Language

    string

    メッセージテンプレートで使用される言語。詳細については、「言語コード」をご参照ください。

    en
    Category

    string

    WhatsApp メッセージテンプレートのカテゴリ。有効な値：

    • UTILITY

    • MARKETING

    • AUTHENTICATION

    Viber テンプレートのカテゴリ。有効な値：

    • text：テキストのみを含むテンプレート

    • image：イメージのみを含むテンプレート

    • text_image_button：テキスト、イメージ、ボタンを含むテンプレート

    • text_button：テキストとボタンを含むテンプレート

    • document：ドキュメントのみを含むテンプレート

    • video：ビデオのみを含むテンプレート

    • text_video：テキストとビデオを含むテンプレート

    • text_video_button：テキスト、ビデオ、ボタンを含むテンプレート

    • text_image：テキストとイメージを含むテンプレート

    UTILITY
    TemplateType

    string

    テンプレートのタイプ。有効な値：WHATSAPP および VIBER。

    WHATSAPP
    Reason

    string

    テンプレートが拒否された理由。

    None
    LastUpdateTime

    integer

    テンプレートが最後に変更された時刻。この値は、1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。

    1711006633000
    Total

    integer

    返されたエントリの総数。

    1
    AccessDeniedDetail

    string

    アクセス拒否に関する詳細。

    无

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "ListTemplate": [
    {
      "TemplateName": "hello_whatsapp",
      "TemplateCode": "744c4b5c79c9432497a075bdfca3****",
      "AuditStatus": "pass",
      "Language": "en",
      "Category": "UTILITY",
      "TemplateType": "WHATSAPP",
      "Reason": "None",
      "LastUpdateTime": 1711006633000
    }
  ],
  "Total": 1,
  "AccessDeniedDetail": "无"
}

    エラーコード

    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.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。