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

:ModifyChatappTemplate

最終更新日:Jul 07, 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>

任意

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

Type

string

必須

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

  • BODY

  • HEADER

  • FOOTER

  • BUTTONS

  • CAROUSEL

  • LIMITED_TIME_OFFER

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

BODY

Text

string

任意

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

説明

Category が AUTHENTICATION に設定されている場合、このプロパティ値は空になります。

hello chatapp

Format

string

任意

メディアリソースタイプ。有効な値: TEXT (テキスト)、IMAGE (イメージ)、DOCUMENT (ドキュメント)、VIDEO (ビデオ)。

  • TEXT: テキスト

  • IMAGE: イメージ

  • DOCUMENT: ドキュメント

  • VIDEO: ビデオ

TEXT

Url

string

任意

素材のパス。

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

Caption

string

任意

説明。

説明

Type が HEADER に設定され、Format が IMAGE/DOCUMENT/VIDEO に設定されている場合に説明を追加できます。

This is a video

FileName

string

任意

ファイル名。

説明

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

video

Buttons

array<object>

任意

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

説明

WhatsApp ボタンの制限:

  • Category が MARKETING または UTILITY に設定されている WhatsApp テンプレートでは、最大 10 個のボタンを使用できます。

  • PHONE_NUMBER ボタンは 1 つだけ使用できます。

  • URL ボタンは最大 2 つまで使用できます。

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

array<object>

任意

ボタンの定義。

Type

string

必須

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

  • 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

Text

string

任意

ボタンのテキスト。

phone-button-text

PhoneNumber

string

任意

電話番号。

+861388888****

Url

string

任意

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

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

UrlType

string

任意

URL タイプ。有効な値: static (静的)、dynamic (動的)。

  • static: 静的

  • dynamic: 動的

dynamic

SignatureHash deprecated

string

任意

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

29dkeke

PackageName deprecated

string

任意

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

com.demo

AutofillText

string

任意

WhatsApp テンプレートの Category が AUTHENTICATION で Button Type が ONE_TAP または ZERO_TAP の場合に必須です。WhatsApp の自動入力操作用のボタンテキスト。

Autofill

IsOptOut

boolean

任意

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

false

CouponCode

string

任意

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

120293

FlowId

string

任意

フロー ID。

664597077870605

FlowAction

string

任意

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

  • DATA_EXCHANGE: データ交換。

  • NAVIGATE: ナビゲーション。

NAVIGATE

NavigateScreen

string

任意

ナビゲーション画面。FlowAction が NAVIGATE に設定されている場合に必須です。

DETAILS

SupportedApps

array<object>

任意

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

object

任意

サポートされているアプリのリスト。

SignatureHash

string

任意

Category が AUTHENTICATION で、ボタンタイプが ONE_TAP または ZERO_TAP の WhatsApp テンプレートで必須です。これは WhatsApp によって起動されるアプリケーションの署名ハッシュです。

fk39kd93ks9

PackageName

string

任意

Category が AUTHENTICATION で、ボタンタイプが ONE_TAP または ZERO_TAP の WhatsApp テンプレートで必須です。これは WhatsApp によって起動されるアプリケーションのパッケージ名です。

com.example.myapplication

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

Duration

integer

任意

無効なフィールド。

120

FileType

string

任意

無効なフィールド。

docx

CodeExpirationMinutes

integer

任意

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

5

AddSecretRecommendation

boolean

任意

Category が AUTHENTICATION で Component Type が Body の WhatsApp テンプレートで有効です。Body セクションに、認証コードを他人と共有しないよう助言するメッセージを表示します。

false

HasExpiration

boolean

任意

クーポンコードに有効期限時間があるかどうかを指定します。Type が LIMITED_TIME_OFFER に設定されている場合に使用します。

true

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

Url

string

任意

メディアアセットの URL。

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

Buttons

array<object>

任意

ボタンのリスト。これは BUTTONS コンポーネントにのみ適用されます。各カルーセルカードには最大 2 つのボタンを含めることができます。

object

任意

ボタンオブジェクト。

Text

string

任意

ボタンのテキスト。

Call me

Type

string

必須

ボタンタイプ。

  • PHONE_NUMBER:通話ボタン

  • URL:URL ボタン

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

PHONE_NUMBER

Url

string

任意

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

https://alibaba.com/xx

UrlType

string

任意

URL タイプ。

  • static

  • dynamic

static

PhoneNumber

string

任意

電話番号。

+861368893****

Language

string

必須

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

en

Example

object

任意

テンプレート作成用の例。KEY-VALUE フォーマットの変数。

string

任意

テンプレート作成用の例。KEY-VALUE フォーマットの変数。

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

CustWabaId deprecated

string

任意

ISV 顧客の WabaId。

説明

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

65921621816****

IsvCode

string

任意

RAM ユーザーが ISV によって承認されているかどうかを確認するために使用される ISV 認証コード。

ksiekdki39ksks93939

TemplateCode

string

任意

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

8472929283883

CustSpaceId

string

必須

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

28251486512358****

Category

string

任意

テンプレートタイプは変更できません。Viber テンプレートを変更する場合、テンプレートカテゴリを変更できます (WhatsApp テンプレートを変更する場合、このパラメーターは無効です)。

text

TemplateType

string

任意

テンプレートタイプ。有効な値: WHATSAPP、VIBER。デフォルト値: WHATSAPP。

  • WHATSAPP

WHATSAPP

MessageSendTtlSeconds

integer

任意

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

  • AUTHENTICATION: 有効な値は 30 ~ 900 です。

  • UTILITY: 有効な値は 30 ~ 43200 です。

120

TemplateName

string

任意

テンプレート名。

test_name

任意

Utility テンプレートが Marketing タイプに変更されたときに送信を一時停止するかどうかを指定します。

レスポンスフィールド

フィールド

説明

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

成功レスポンス

JSONJSON

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

エラーコード

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.

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

変更履歴

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