すべてのプロダクト
Search

このプロダクト

    :GetChatappTemplateDetail

    ドキュメントセンター

    :GetChatappTemplateDetail

    最終更新日:Dec 22, 2025

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

    操作説明

    QPS 制限

    この API 操作は、アカウントごとに 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:GetChatappTemplateDetail

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    TemplateCode

    string

    任意

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

    ****4b5c79c9432497a075bdfca36bf5
    Language

    string

    必須

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

    en_US
    CustWabaId deprecated

    string

    任意

    独立系ソフトウェアベンダー (ISV) アカウント内のユーザーの WhatsApp ビジネスアカウント (WABA) ID です。

    説明

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

    65921621816****

    IsvCode

    string

    任意

    独立系ソフトウェアベンダー (ISV) の検証コードです。 このパラメーターは、ユーザーが ISV アカウントによって承認されているかどうかを検証するために使用されます。

    skdi3kksloslikdkkdk
    CustSpaceId

    string

    必須

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

    28251486512358****
    TemplateType

    string

    任意

    メッセージテンプレートのタイプです。 有効な値：

    • WHATSAPP

    • VIBER

    • LINE (開発中)

    WHATSAPP
    TemplateName

    string

    任意

    テンプレートの名前です。

    test_name

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

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

    RequestId

    string

    リクエスト ID です。

    744c4b5c79c9432497a075bdfca3****
    Code

    string

    HTTP ステータスコードです。

    • 例：OK。 この値は、リクエストが成功したことを示します。

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

    OK
    Message

    string

    エラーメッセージです。

    User not authorized to operate on the specified resource.
    Data

    object

    返されたデータです。

    { "category": "ACCOUNT_UPDATE", "name": "account_notice", "language": "en_US", "templateCode": "744c4b5c79c9432497a075bdfca3****", "auditStatus": "APPROVED", "components": "[{\"type\":\"BODY\",\"text\":\"body_text$(textVariable)\"},{\"type\":\"HEADER\",\"formate\":\"IMAGE\",\"url\":\"$(linkVariable)\"},{\"type\":\"FOOTER\",\"text\":\"footer-text\"},{\"type\":\"BUTTONS\",\"buttons\":[{\"type\":\"PHONE_NUMBER\",\"text\":\"phone-button-text\",\"phone_number\":\"+861388888****\"},{\"type\":\"URL\",\"text\":\"url-button-text\",\"url\":\"https://www.website.com/\"}]}]", "example": "{\"textVariable\": \"text\", \"linkVariable\": \"link\"}" }
    Category

    string

    TemplateType の戻り値が WHATSAPP の場合のテンプレートのカテゴリです。 有効な値：

    • UTILITY：トランザクションテンプレート

    • MARKETING：マーケティングテンプレート

    • AUTHENTICATION：ID 認証テンプレート

    TemplateType パラメーターの戻り値が VIBER の場合のテンプレートのカテゴリです。 有効な値：

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

    • image：画像のみを含むテンプレート

    • text_image_button：テキスト、画像、ボタンを含むテンプレート

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

    • document：ファイルのみを含むテンプレート

    • video：動画のみを含むテンプレート

    • text_video：テキストと動画を含むテンプレート

    • text_video_button：テキスト、動画、ボタンを含むテンプレート

    • text_image：テキストと画像を含むテンプレート

    説明

    Category が text_video_button に設定されている場合、ユーザーはボタンをクリックして Web ページを開くことはできません。 ユーザーはメッセージ内の動画のみを開くことができます。 この場合、テンプレートの URL ボタンに Url パラメーターを指定する必要はありません。

    UTILITY
    TemplateCode

    string

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

    744c4b5c79c9432497a075bdfca3****
    Name

    string

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

    hello_whatsapp
    Language

    string

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

    en_US
    Example

    object

    変数の例です。

    string

    メッセージテンプレートに含まれる変数の値です。 値は JSON 形式である必要があります。

    {\"textVariable\":\"text\",\"linkVariable\":\"https://image.developer.aliy\"}
    AuditStatus

    string

    メッセージテンプレートの審査ステータスです。 有効な値：

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

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

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

    • unaudit：審査は一時停止されました。

    pass
    Components

    array<object>

    メッセージテンプレートのコンポーネントです。

    array<object>

    配列オブジェクトに関する情報です。

    Type

    string

    コンポーネントタイプです。 有効な値：

    • BODY

    • HEADER

    • FOOTER

    • BUTTONS

    • CAROUSEL

    • LIMITED_TIME_OFFER

    説明

    • WhatsApp メッセージテンプレートでは、Body コンポーネントの長さは 1,024 文字を超えることはできません。 HEADER または FOOTER コンポーネントの長さは 60 文字を超えることはできません。

    • FOOTER、CAROUSEL、および LIMITED_TIME_OFFER コンポーネントは、Viber メッセージテンプレートではサポートされていません。

    • Viber メッセージテンプレートでは、画像、動画、ドキュメントなどのメディアリソースは HEADER コンポーネントに配置されます。 Viber メッセージにテキストと画像が含まれている場合、画像はデバイスで受信されたメッセージのテキストの下に配置されます。

    BODY
    Url

    string

    メディアリソースの URL です。

    https://image.developer.aliyundoc.com
    Text

    string

    送信するメッセージのテキストです。

    你好
    Caption

    string

    ドキュメントの説明です。

    新文件已上传
    FileName

    string

    ドキュメントの名前です。

    快递文件
    Format

    string

    フォーマットです。

    TEXT
    Buttons

    array<object>

    ボタンです。 このパラメーターは、Components パラメーターの Type サブパラメーターが BUTTONS に設定されている場合にのみ返されます。

    説明

    • マーケティングまたはユーティリティの WhatsApp メッセージテンプレートには、最大 10 個のボタンを含めることができます。

    • WhatsApp メッセージテンプレートには、電話ボタンを 1 つだけ含めることができます。

    • WhatsApp メッセージテンプレートには、最大 2 つの URL ボタンを含めることができます。

    • WhatsApp メッセージテンプレートでは、クイック返信ボタンを電話ボタンまたは URL ボタンと併用することはできません。

    array<object>

    配列オブジェクトに関する情報です。

    Type

    string

    ボタンのタイプです。 有効な値：

    • PHONE_NUMBER：電話ボタン

    • URL：URL ボタン

    • QUICK_REPLY：クイック返信ボタン

    • COPY_CODE：コードコピーボタン

    • ONE_TAP：Category が AUTHENTICATION に設定されている場合のワンタップ自動入力ボタン

    説明

    • WhatsApp メッセージテンプレートの Category が AUTHENTICATION に設定されている場合、WhatsApp メッセージテンプレートに追加できるボタンは 1 つだけで、Buttons パラメーターの Type サブパラメーターを COPY_CODE または ONE_TAP に設定する必要があります。 Type が COPY_CODE に設定されている場合、Buttons パラメーターの Text サブパラメーターは必須です。 Type が ONE_TAP に設定されている場合、Buttons パラメーターの Text、SignatureHash、PackageName、および AutofillText サブパラメーターは必須です。 Text の値は、目的のアプリがデバイスにインストールされていない場合に表示されます。 Text の値は、検証コードを手動でコピーする必要があることを示します。

    • Viber メッセージテンプレートに追加できるボタンは 1 つだけで、Buttons パラメーターの Type サブパラメーターを URL に設定する必要があります。

    PHONE_NUMBER
    Text

    string

    ボタンの表示名です。

    打电话
    PhoneNumber

    string

    電話番号です。 このパラメーターは、Buttons パラメーターの Type サブパラメーターが PHONE_NUMBER に設定されている場合にのみ有効です。

    +861398745****
    Url

    string

    URL ボタンをクリックしたときにリダイレクトされる URL です。

    https://example.com

    UrlType

    string

    URL のタイプです。 有効な値：

    • static

    • dynamic

    static
    SignatureHash

    string

    WhatsApp がアプリをロードするために使用するアプリ署名キーハッシュです。 このパラメーターは、WhatsApp メッセージテンプレートで Category が AUTHENTICATION に設定され、Buttons パラメーターの Type サブパラメーターが ONE_TAP に設定されている場合に必須です。

    2993839
    PackageName

    string

    WhatsApp がアプリをロードするために使用するアプリパッケージ名です。 このパラメーターは、WhatsApp メッセージテンプレートで Category が AUTHENTICATION に設定され、Buttons パラメーターの Type サブパラメーターが ONE_TAP に設定されている場合に必須です。

    com.aliyun
    AutofillText

    string

    ワンタップ自動入力ボタンのテキストです。 このパラメーターは、WhatsApp メッセージテンプレートで Category が AUTHENTICATION に設定され、Buttons パラメーターの Type サブパラメーターが ONE_TAP に設定されている場合に必須です。

    Autofill
    IsOptOut

    boolean

    配信停止ボタンです。 このパラメーターは、WhatsApp メッセージテンプレートの Category が MARKETING に設定され、Buttons パラメーターの Type サブパラメーターが QUICK_REPLY に設定されている場合に有効です。 Chat App Message Service コンソールでメッセージ送信を設定し、顧客がこのボタンをクリックした場合、マーケティングメッセージは顧客に送信されません。

    false
    ExtendAttrs

    object

    拡張フィールドです。

    NextTemplateCode

    string

    次のテンプレートのコードです。

    20939920093993
    NextTemplateName

    string

    次のテンプレートの名前です。

    abc
    NextLanguageCode

    string

    次のテンプレートの言語です。

    en
    Action

    string

    イベントタイプです。

    nextCard
    IntentCode

    string

    インテントコードです。

    test
    CouponCode

    string

    クーポンコードです。

    202039ksjs
    FlowId

    string

    フロー ID です。

    3838292983
    FlowAction

    string

    フローアクションです。 有効な値：NAVIGATE および DATA_EXCHANGE。

    NAVIGATE
    NavigateScreen

    string

    フローの最初の画面です。 このパラメーターは、FlowAction が NAVIGATE に設定されている場合に返されます。

    DETAILS
    SupportedApps

    array<object>

    ワンタップ認証とゼロタップ認証をサポートするアプリです。

    object

    SignatureHash

    string

    アプリ署名キーハッシュです。

    29kdkeik939
    PackageName

    string

    アプリパッケージ名です。

    com.test
    ThumbUrl

    string

    Viber メッセージテンプレート内の動画のサムネイル URL です。

    https://img.png
    Duration

    integer

    Viber メッセージテンプレート内の動画の長さです。 単位：秒。 有効な値：0～600。

    50
    FileType

    string

    Viber メッセージテンプレートにアタッチされたドキュメントのタイプです。

    docx
    Latitude

    string

    場所の緯度です。

    28.001
    Longitude

    string

    場所の経度です。

    120.002
    LocationName

    string

    場所の名前です。

    杭州
    LocationAddress

    string

    場所の住所です。

    杭州
    AddSecretRecommendation

    boolean

    顧客が検証コードを他人と共有できないことを示す注意書きです。 注意書きはメッセージ本文に表示されます。 このパラメーターは、WhatsApp メッセージテンプレートの Category が AUTHENTICATION に設定され、Components パラメーターの Type サブパラメーターが BODY に設定されている場合に有効です。

    false
    CodeExpirationMinutes

    integer

    WhatsApp 認証テンプレートの検証コードの有効期間です。 単位：分。 このパラメーターは、WhatsApp メッセージテンプレートの Category が AUTHENTICATION に設定され、Components パラメーターの Type サブパラメーターが FOOTER に設定されている場合にのみ有効です。 検証コードの有効期間はフッターに表示されます。

    5
    hasExpiration

    boolean

    期間限定オファーテンプレートでクーポンコードに有効期限があるかどうかを示します。

    true
    OfferExpirationTimeMs

    string

    期間限定オファーテンプレートでクーポンコードが有効期限切れになる際の変数です。

    $(offerExpirationTimeMs)
    Cards

    array<object>

    カルーセルカードです。

    array<object>

    CardComponents

    array<object>

    カルーセルカードのコンポーネントです。

    array<object>

    Type

    string

    コンポーネントタイプです。

    HEADER
    Text

    string

    カルーセルカードのテキストです。

    Body
    Url

    string

    URL です。

    https://aliyun.com
    Format

    string

    カルーセルテンプレートのヘッダーのタイプです。 ヘッダーは画像または動画のみにできます。 すべてのカルーセルカードのヘッダーは同じである必要があります。 メッセージに含まれるメディアリソースのタイプです。 有効な値：IMGAGE および VIDEO。

    HEADER
    Buttons

    array<object>

    カルーセルカードのボタンです。

    object

    Type

    string

    カルーセルテンプレートのボタンのタイプです。 有効な値：URL、PHONE_NUMBER、および QUICK_REQLY。

    URL
    Text

    string

    ボタンテキストです。

    按钮文本
    Url

    string

    URL ボタンをクリックしたときにリダイレクトされる URL です。

    https://aliyun.com
    UrlType

    string

    URL のタイプです。 有効な値：static および dynamic。

    static
    PhoneNumber

    string

    電話番号です。

    +861380005****
    TemplateType

    string

    メッセージテンプレートのタイプです。 有効な値：

    • WHATSAPP

    • VIBER

    • LINE (開発中)

    WHATSAPP
    QualityScore

    string

    テンプレートの品質です。

    列挙値:

    • RED :

      低品質

    • YELLOW :

      中品質

    • UNKNOWN :

      不明な品質

    • GREEN :

      高品質

    GREEN
    MessageSendTtlSeconds

    integer

    WhatsApp 認証メッセージの有効期間です。

    120
    Reason

    string

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

    None
    AccessDeniedDetail

    string

    アクセス拒否の詳細です。

    无

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "744c4b5c79c9432497a075bdfca3****",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "Data": {
    "Category": "UTILITY",
    "TemplateCode": "744c4b5c79c9432497a075bdfca3****",
    "Name": "hello_whatsapp",
    "Language": "en_US",
    "Example": {
      "key": "{\\\"textVariable\\\":\\\"text\\\",\\\"linkVariable\\\":\\\"https://image.developer.aliy\\\"}"
    },
    "AuditStatus": "pass",
    "Components": [
      {
        "Type": "BODY",
        "Url": "https://image.developer.aliyundoc.com",
        "Text": "你好",
        "Caption": "新文件已上传",
        "FileName": "快递文件",
        "Format": "TEXT",
        "Buttons": [
          {
            "Type": "PHONE_NUMBER",
            "Text": "打电话",
            "PhoneNumber": "+861398745****",
            "Url": "https://example.com\n",
            "UrlType": "static",
            "SignatureHash": "2993839",
            "PackageName": "com.aliyun",
            "AutofillText": "Autofill",
            "IsOptOut": false,
            "ExtendAttrs": {
              "NextTemplateCode": "20939920093993",
              "NextTemplateName": "abc",
              "NextLanguageCode": "en",
              "Action": "nextCard",
              "IntentCode": "test"
            },
            "CouponCode": "202039ksjs",
            "FlowId": "3838292983",
            "FlowAction": "NAVIGATE",
            "NavigateScreen": "DETAILS",
            "SupportedApps": [
              {
                "SignatureHash": "29kdkeik939",
                "PackageName": "com.test"
              }
            ]
          }
        ],
        "ThumbUrl": "https://img.png",
        "Duration": 50,
        "FileType": "docx",
        "Latitude": "28.001",
        "Longitude": "120.002",
        "LocationName": "杭州",
        "LocationAddress": "杭州",
        "AddSecretRecommendation": false,
        "CodeExpirationMinutes": 5,
        "hasExpiration": true,
        "OfferExpirationTimeMs": "$(offerExpirationTimeMs)",
        "Cards": [
          {
            "CardComponents": [
              {
                "Type": "HEADER",
                "Text": "Body",
                "Url": "https://aliyun.com",
                "Format": "HEADER",
                "Buttons": [
                  {
                    "Type": "URL",
                    "Text": "按钮文本",
                    "Url": "https://aliyun.com",
                    "UrlType": "static",
                    "PhoneNumber": "+861380005****"
                  }
                ]
              }
            ]
          }
        ]
      }
    ],
    "TemplateType": "WHATSAPP",
    "QualityScore": "GREEN",
    "MessageSendTtlSeconds": 120,
    "Reason": "None"
  },
  "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.

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

    変更履歴

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