すべてのプロダクト
Search

このプロダクト

    :ModifyChatappTemplate

    ドキュメントセンター

    :ModifyChatappTemplate

    最終更新日:Sep 29, 2026

    メッセージテンプレートを変更します。未レビュー、またはレビューに失敗したテンプレートのみ変更できます。

    操作説明

    QPS 制限

    この操作の単一ユーザーに対する QPS 制限は 1 秒あたり 50 回です。この制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響を及ぼす可能性があります。必要に応じてこの操作を呼び出してください。

    ステータスの変更

    テンプレートのステータスと品質の変更は、MNS または HTTP を通じて監視できます。詳細については、「受信確認メッセージのフォーマット」を参照してください。

    今すぐお試しください

    この 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:ModifyChatappTemplate

    update

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Components

    array<object>

    必須

    メッセージテンプレートコンポーネントのリスト。

    説明

    Category が AUTHENTICATION に設定されている場合、Components には Type が HEADER に設定されたノードを含めることはできません。Type が BODY または FOOTER に設定されている場合、Text の内容が空の場合は内容が自動的に生成されます。

    array<object>

    任意

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

    HasExpiration

    boolean

    任意

    LTO テンプレートに有効期限があるかどうかを指定します。

    true
    ThumbUrl

    string

    任意

    Viber ビデオメッセージのサムネイル URL。

    https://img.png
    FileName

    string

    任意

    ファイル名。Type が Header に設定され、Format が DOCUMENT に設定されている場合にファイル名を指定できます。

    txt.txt
    Text

    string

    任意

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

    IMAGE
    Duration

    integer

    任意

    Viber ビデオメッセージのビデオの持続時間。有効な値: 0 ～ 600。

    120
    Url

    string

    任意

    メディアリソースの URL。

    https://img.png
    Caption

    string

    任意

    字幕。Type が Header に設定され、Format が IMGAGE、DOCUMENT、または VIDEO に設定されている場合に字幕を追加できます。

    test
    AddSecretRecommendation

    boolean

    任意

    本文テキストの上に、ユーザーに認証コードを共有しないよう促すセキュリティ推奨事項を表示するかどうかを指定します。このパラメーターは、Category が Authentication に設定され、Component Type が Body に設定されている WhatsApp テンプレートに対してのみ有効です。

    false
    Type

    string

    必須

    コンポーネントタイプ。\n 有効な値: BODY、HEADER、FOOTER、BUTTONS。

    HEADER
    Format

    string

    任意

    フォーマット。\n 有効な値:\n- TEXT: テキスト。\n- IMGAGE: イメージ。\n- DOCUMENT: ドキュメント。\n- VIDEO: ビデオ。

    body
    CodeExpirationMinutes

    integer

    任意

    WhatsApp Authentication テンプレートにおける認証コードの有効期間 (分単位)。このパラメーターは、Category が Authentication に設定され、Component Type が Footer に設定されている WhatsApp メッセージに対してのみ有効です。情報はフッターセクションに表示されます。

    10
    FileType

    string

    任意

    Viber ファイルメッセージのファイルタイプ。

    txt
    Buttons

    array<object>

    任意

    ボタンのリスト。このパラメーターは BUTTONS コンポーネントにのみ適用されます。

    説明

    WhatsApp ボタン数に関するルール:

    • WhatsApp テンプレートタイプが MARKETING または UTILITY の場合、最大 10 個のボタンが許可されます。

    • PHONE_NUMBER ボタンは 1 つだけ許可されます。

    • URL ボタンは最大 2 つまで許可されます。

    • QUICK_REPLY ボタンを PHONE_NUMBER ボタンまたは URL ボタンとランダムな順序で混在させることはできません。

    array<object>

    任意

    ボタン。

    AutofillText

    string

    任意

    WhatsApp Autofill 操作のボタンテキスト。このパラメーターは、Category が Authentication に設定され、Button Type が ONE_TAP に設定されている WhatsApp テンプレートで必須です。

    Autofill
    PackageName

    string

    任意

    WhatsApp が起動するアプリケーションのパッケージ名。このパラメーターは、Category が Authentication に設定され、Button Type が ONE_TAP または ZERO_TAP に設定されている WhatsApp テンプレートで有効です。

    com.aliyun.pack.***
    Text

    string

    任意

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

    CTA
    Url

    string

    任意

    ボタンがクリックされたときにアクセスされる URL。

    https://aliyun.com
    FlowId

    string

    任意

    フロー ID。

    293882
    Type

    string

    必須

    ボタンタイプ。\n 有効な値: PHONE_NUMBER (電話呼び出し)、URL (Web ボタン)、QUICK_REPLY (クイック返信)。

    URL
    CouponCode

    string

    任意

    クーポンコード。

    23838jdjdj
    IsOptOut

    boolean

    任意

    ボタンがマーケティングオプトアウトボタンであるかどうかを指定します。このパラメーターは、Category が Marketing に設定され、Button Type が QUICK_REPLY に設定されている WhatsApp テンプレートで有効です。顧客がこのボタンをクリックし、Chat App Message サービスプラットフォームで送信コントロール操作が設定されている場合、それ以降の Marketing メッセージは顧客に送信されません。

    false
    FlowAction

    string

    任意

    フローデータイベントタイプ。\n 有効な値: NAVIGATE、DATA_EXCHANGE。

    NAVIGATE
    SignatureHash

    string

    任意

    WhatsApp が起動するアプリケーションの署名ハッシュ値。このパラメーターは、Category が Authentication に設定され、Button Type が ONE_TAP または ZERO_TAP に設定されている WhatsApp テンプレートで有効です。

    kdikie9398k
    NavigateScreen

    string

    任意

    ナビゲーション画面。\nこのパラメーターは、FlowAction が NAVIGATE に設定されている場合に必須です。

    SIGN_UP
    PhoneNumber

    string

    任意

    電話番号。

    8613800**
    SupportedApps

    array<object>

    任意

    ONE_TAP または ZERO_TAP 認証コードボタンでサポートされているアプリケーション。

    object

    任意

    ONE_TAP または ZERO_TAP 認証コードボタンでサポートされているアプリケーション。

    SignatureHash

    string

    任意

    WhatsApp が起動するアプリケーションの署名ハッシュ値。このパラメーターは、Category が Authentication に設定され、Button Type が ONE_TAP または ZERO_TAP に設定されている WhatsApp テンプレートで有効です。

    kdikie9398k
    PackageName

    string

    任意

    WhatsApp が起動するアプリケーションのパッケージ名。このパラメーターは、Category が Authentication に設定され、Button Type が ONE_TAP または ZERO_TAP に設定されている WhatsApp テンプレートで有効です。

    com.aliyun.pack.***
    UrlType

    string

    任意

    URL タイプ。有効な値:\n- static: 静的 URL。\n- dynamic: 動的 URL。

    static
    Cards

    array<object>

    任意

    カルーセルテンプレートカードのリスト。

    array<object>

    任意

    カルーセルテンプレートカード。

    CardComponents

    array<object>

    必須

    カルーセルカード内のコンポーネントのリスト。

    array<object>

    任意

    カルーセルカード内のコンポーネントのリスト。

    Type

    string

    必須

    コンポーネントタイプ。\n 有効な値: BODY、HEADER、BUTTONS。

    HEADER
    Format

    string

    任意

    カルーセルテンプレートのヘッダータイプ。IMAGE と VIDEO のみがサポートされています。ヘッダータイプはすべてのカードで同じである必要があります。\n 有効な値:\n- IMGAGE: イメージ。\n- VIDEO: ビデオ。

    IMAGE
    Text

    string

    任意

    カルーセルカードの本文の内容。

    body
    Buttons

    array<object>

    任意

    カルーセルカード内のボタン。ボタンのタイプ、名前、順序はすべてのカードで同じである必要があります。各カードは最大 2 個のボタンをサポートします。

    object

    任意

    カルーセルカード内のボタン。ボタンのタイプ、名前、順序はすべてのカードで同じである必要があります。各カードは最大 2 個のボタンをサポートします。

    Type

    string

    必須

    カルーセルテンプレートのボタンタイプ。 有効な値: URL、PHONE_NUMBER、QUICK_REQLY。

    URL
    PhoneNumber

    string

    任意

    電話番号。

    8613800**
    Text

    string

    任意

    ボタンテキスト。

    text
    UrlType

    string

    任意

    URL タイプ。有効な値:\n- static: 静的 URL。\n- dynamic: 動的 URL。

    static
    Url

    string

    任意

    ボタンがクリックされたときにアクセスされる URL。

    https://aliyun.com/image.png
    Url

    string

    任意

    ヘッダーイメージまたは動画の URL。

    https://aliyun.com/image.png
    Language

    string

    必須

    言語。

    en
    Example

    object

    任意

    キーと値の構造の変数。

    string

    任意

    テンプレートを作成するための例。

    StringConcat('a', 'b', 'c')
    CustWabaId

    string

    任意

    ISV 顧客の WabaId。このパラメーターは非推奨になります。代わりに CustSpaceId を使用してください。

    939***
    IsvCode deprecated

    string

    任意

    サブアカウントが ISV によって承認されているかどうかを確認するために使用される ISV 確認コード。

    9393***
    TemplateCode

    string

    任意

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

    93938**
    CustSpaceId

    string

    任意

    ISV サブ顧客の SpaceId または直接顧客の instanceId。

    cams-did***
    Category

    string

    任意

    テンプレートカテゴリ。このパラメーターは Viber テンプレートの更新時に変更できます。このパラメーターは WhatsApp テンプレートでは無効です。

    MARKETING
    TemplateType

    string

    任意

    変更するテンプレートの templatetype。有効な値:

    • WHATSAPP

    • VIBER

    デフォルト値: WHATSAPP。

    WHATSAPP
    MessageSendTtlSeconds

    integer

    任意

    WhatsApp 認証テンプレートメッセージを送信するための TTL。

    120
    TemplateName

    string

    任意

    テンプレート名。

    test_name
    CategoryChangePaused

    boolean

    任意

    ユーティリティテンプレートがマーケティングタイプに変更された場合に、テンプレートの送信を一時停止するかどうかを指定します。

    true
    ProductSetId

    string

    任意

    プロダクトセット ID。

    939***

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

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

    RequestId

    string

    リクエスト ID。

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

    string

    レスポンスコード。

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

    • その他のエラーコードについては、「エラーコード」を参照してください。

    OK
    Message

    string

    エラーメッセージ。

    None
    Data

    object

    返されるデータ。

    TemplateCode

    string

    テンプレートコード。

    8472929283883
    TemplateName

    string

    テンプレート名。

    hello_whatsapp
    AccessDeniedDetail

    string

    アクセス拒否の詳細。

    None
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "None",
  "Data": {
    "TemplateCode": "8472929283883",
    "TemplateName": "hello_whatsapp"
  },
  "AccessDeniedDetail": "None",
  "Success": true
}

    エラーコード

    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.

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

    変更履歴

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