すべてのプロダクト
Search
ドキュメントセンター

:ModifyChatappTemplate

最終更新日:Aug 27, 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

任意

クーポンコードに有効期間があるかどうかを指定します。このパラメーターは、type が LIMITED_TIME_OFFER の場合に使用します。

true

ThumbUrl

string

任意

有効なフィールドではありません。

https://cdn.multiplymall.mobiapp.cloud/cloudcode/yc-165407506207478-165511576113195/20220905/ec5b9737-1507-4208-bb27-8da3958da961.jpg?x-oss-process=image/resize,w_100

FileName

string

任意

ファイル名。

説明

Type が HEADER で Format が DOCUMENT の場合にファイル名を指定します。

video

Text

string

任意

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

説明

Category が AUTHENTICATION の場合、このプロパティ値は空です。

hello chatapp

Duration

integer

任意

有効なフィールドではありません。

120

Url

string

任意

メディアリソースのパス。

https://img.****.com/png_preview/00/10/24/1GygxVK3F4.jpg

Caption

string

任意

説明。

説明

Type が HEADER で Format が IMAGE/DOCUMENT/VIDEO の場合に説明を追加できます。

This is a video

AddSecretRecommendation

boolean

任意

Category が AUTHENTICATION で Component Type が Body の WhatsApp テンプレートで有効です。本文の上部に、確認コードを他人と共有しないよう促すプロンプトを表示します。

false

Type

string

必須

コンポーネントのタイプ。

  • BODY

  • HEADER

  • FOOTER

  • BUTTONS

  • CAROUSEL

  • LIMITED_TIME_OFFER

説明
  • WhatsApp テンプレートの場合、BODY コンポーネントは 1024 文字を超えることはできません。HEADER および FOOTER コンポーネントは 60 文字を超えることはできません。

BODY

Format

string

任意

メディアのリソースタイプ。

  • TEXT: テキスト

  • IMAGE: イメージ

  • DOCUMENT: ドキュメント

  • VIDEO: ビデオ

TEXT

CodeExpirationMinutes

integer

任意

WhatsApp AUTHENTICATION テンプレートの確認コードの有効期間 (分単位)。Category が AUTHENTICATION で Component Type が Footer の WhatsApp メッセージでのみ有効です。この情報はフッター位置に表示されます。

5

FileType

string

任意

有効なフィールドではありません。

docx

Buttons

array<object>

任意

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

説明

WhatsApp ボタン数量ルール:

  • Category が MARKETING/UTILITY の場合、最大値は 10 個のボタンです。

  • PHONE_NUMBER ボタンは 1 つのみ許可されます。

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

  • QUICK_REPLY ボタンは、PHONE_NUMBER/URL ボタンと順序を入れ替えて配置することはできません。

array<object>

任意

ボタンの定義。

AutofillText

string

任意

Category が AUTHENTICATION で Button Type が ONE_TAP/ZERO_TAP の WhatsApp テンプレートで必須です。WhatsApp オートフィル操作のボタンテキスト。

Autofill

PackageName deprecated

string

任意

代わりに SupportedApps の下のプロパティを使用してください。

com.demo

Text

string

任意

ボタンのテキスト。

phone-button-text

Url

string

任意

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

https://www.website.com/***

FlowId

string

任意

フロー ID。

664597077870605

Type

string

必須

ボタンのタイプ。

  • PHONE_NUMBER: 電話呼び出しボタン

  • URL: Web ボタン

  • QUICK_REPLY: クイックリプライボタン

  • COPY_CODE: 確認コードまたはクーポンコードのコピー

  • ONE_TAP: AUTHENTICATION テンプレート用のオートフィルボタン

  • ZERO_TAP: AUTHENTICATION テンプレート用のオートフィルボタン

  • MPM: マルチ製品カタログ

  • CATALOG: カタログ

  • FLOW: WhatsApp フローを開く

説明
  • Category が AUTHENTICATION の WhatsApp テンプレートの場合、ボタンは 1 つのみ許可され、タイプは COPY_CODE または ONE_TAP のみです。タイプが COPY_CODE の場合、Text は必須です。タイプが ONE_TAP の場合、Text (対象アプリケーションがデバイスにインストールされていない場合に表示され、確認コードコピーボタンの名前を表す)、SignatureHash、PackageName、および AutofillText が必須です。

PHONE_NUMBER

CouponCode

string

任意

クーポンコードの値。英数字のみサポートされています。$(couponCode) のような変数を渡すことができ、メッセージ送信時に実際のクーポンコードを提供します。

120293

IsOptOut

boolean

任意

Category が Marketing で Button type が QUICK_REPLY の WhatsApp テンプレートで有効です。ボタンがマーケティングオプトアウトボタンであることを示します。顧客がこのボタンをクリックし、ChatApp で送信コントロールが設定されている場合、その後の Marketing メッセージは顧客に送信されません。

false

FlowAction

string

任意

フローデータイベントのタイプ。有効な値:

  • DATA_EXCHANGE: データ交換。

  • NAVIGATE: ナビゲーション。

NAVIGATE

SignatureHash deprecated

string

任意

代わりに SupportedApps の下のプロパティを使用してください。

29dkeke

NavigateScreen

string

任意

ナビゲーション画面。FlowAction が NAVIGATE の場合に必須です。

DETAILS

PhoneNumber

string

任意

電話番号。

+861388888****

SupportedApps

array<object>

任意

サポートされるアプリケーションのリスト。

object

任意

サポートされるアプリケーションのリスト。

SignatureHash

string

任意

Category が AUTHENTICATION で Button Type が ONE_TAP/ZERO_TAP の WhatsApp テンプレートで必須です。WhatsApp が呼び出すアプリケーションの署名ハッシュ値。

fk39kd93ks9

PackageName

string

任意

Category が AUTHENTICATION で Button Type が ONE_TAP/ZERO_TAP の WhatsApp テンプレートで必須です。WhatsApp が呼び出すアプリケーションのパッケージ名。

com.example.myapplication

UrlType

string

任意

URL のタイプ。

  • static: 静的

  • dynamic: 動的

dynamic

Cards

array<object>

任意

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

array<object>

任意

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

CardComponents

array<object>

必須

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

array<object>

任意

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

Type

string

必須

コンポーネントのタイプ。有効な値:

  • BODY

  • HEADER

  • BUTTONS

BODY

Format

string

任意

メディアのリソースタイプ。Type が HEADER の場合に有効です。

  • IMAGE: イメージ

  • VIDEO: ビデオ

IMAGE

Text

string

任意

カルーセルカード内の BODY コンテンツ。

Who is the very powerful team

Buttons

array<object>

任意

ボタンのリスト。BUTTONS コンポーネントにのみ適用されます。各カルーセルカードには最大値として 2 つのボタンを設定できます。

object

任意

ボタンオブジェクト。

Type

string

必須

ボタンのタイプ。

  • PHONE_NUMBER: 電話呼び出しボタン

  • URL: Web ボタン

  • QUICK_REPLY: クイックリプライボタン

PHONE_NUMBER

PhoneNumber

string

任意

電話番号。

+861368893****

Text

string

任意

ボタンのテキスト。

Call me

UrlType

string

任意

URL のタイプ。

  • static: 静的

  • dynamic: 動的

静的

Url

string

任意

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

https://alibaba.com/xx

Url

string

任意

メディアリソースのパス。

https://alibaba.com/****/img.png

Language

string

必須

テンプレートの言語。言語コードについては、「言語コード」を参照してください。

en

Example

object

任意

テンプレート作成の例。

string

任意

テンプレート作成の例。

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

CustWabaId deprecated

string

任意

ISV 顧客の WabaId。

説明

このパラメーターは非推奨です。代わりに CustSpaceId を使用してください。

65921621816****

IsvCode deprecated

string

任意

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

ksiekdki39ksks93939

TemplateCode

string

任意

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

8472929283883

CustSpaceId

string

任意

ISV サブ顧客の SpaceId または直接顧客のインスタンス ID。

28251486512358****

Category

string

任意

テンプレートタイプは変更済みです。

text

TemplateType

string

任意

テンプレートタイプ。

  • WHATSAPP

WHATSAPP

MessageSendTtlSeconds

integer

任意

WhatsApp でテンプレートメッセージを送信するための有効期間。

  • AUTHENTICATION: 有効値の範囲は 30 から 900 です。

  • UTILITY: 有効値の範囲は 30 から 43200 です。

120

TemplateName

string

任意

テンプレート名。

test_name

CategoryChangePaused

boolean

任意

Utility テンプレートが Marketing タイプに変更されると、テンプレートの送信が一時停止されます。

120

任意

プロダクトセット 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.

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

変更履歴

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