すべてのプロダクト
Search

このプロダクト

    :CreateChatappTemplate

    ドキュメントセンター

    :CreateChatappTemplate

    最終更新日: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:CreateChatappTemplate

    create

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Category

    string

    必須

    WhatsApp テンプレートのカテゴリ。有効な値:

    • UTILITY: トランザクション関連。

    • MARKETING: マーケティング。

    • AUTHENTICATION: 本人確認。

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

    • UTILITY: トランザクション関連。

    • MARKETING: マーケティング。

    • AUTHENTICATION: 本人確認。

    UTILITY
    Components

    array<object>

    必須

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

    説明

    Category=AUTHENTICATION の場合、Components に Type=HEADER のノードを含めることはできません。Type=BODY または FOOTER の場合、Text コンテンツは空である必要があります。

    array<object>

    任意

    コンポーネントのリスト。

    HasExpiration

    boolean

    任意

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

    true
    ThumbUrl

    string

    任意

    Viber 動画メッセージのサムネイル。

    https://cdn.multiplymall.mobiapp.cloud/yunmall/B-LM-LMALL202207130001/20220730/d712a057-a6af-4513-bbe6-7ee57ea60983.png?x-oss-process=image/resize,w_100
    FileName

    string

    任意

    ファイルの名前。

    Express delivery video
    Text

    string

    任意

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

    説明

    WHATSAPP タイプの場合、Category=AUTHENTICATION のときこのプロパティ値は空になります。

    hello whatsapp
    Duration

    integer

    任意

    Viber 動画メッセージの持続時間 (秒単位)。有効な値: 0～600。

    120
    Url

    string

    任意

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

    説明

    Viber タイプの場合、推奨イメージサイズは 800 px × 800 px です。

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

    string

    任意

    ファイルの説明。

    This is a video
    AddSecretRecommendation

    boolean

    任意

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

    true
    Type

    string

    必須

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

    • BODY

    • HEADER

    • FOOTER

    • BUTTONS

    • CAROUSEL

    • LIMITED_TIME_OFFER

    説明

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

    • Viber テンプレートの場合、FOOTER、CAROUSEL、LIMITED_TIME_OFFER タイプは無効です。

    • Viber テンプレートの場合、イメージ、動画、ファイルは HEADER に配置されます (デバイスではテキストの下にイメージが表示されます)。テキストは BODY に配置されます。

    BODY
    Format

    string

    任意

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

    • TEXT: テキスト

    • IMAGE: イメージ

    • DOCUMENT: ドキュメント

    • VIDEO: 動画

    TEXT
    CodeExpirationMinutes

    integer

    任意

    WhatsApp AUTHENTICATION テンプレートの確認コードの有効期間 (分単位)。Category が AUTHENTICATION で Component Type が Footer の WhatsApp メッセージでのみ有効 (Footer 位置に表示)。

    5
    FileType

    string

    任意

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

    docx
    Buttons

    array<object>

    任意

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

    説明

    WhatsApp ボタン数のルール:

    • Category が MARKETING/UTILITY の WhatsApp テンプレートでは、最大値 10 個のボタンが許可されます。

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

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

    • QUICK_REPLY ボタンを PHONE_NUMBER/URL ボタンと混在させてセットすることはできません。

    説明

    Viber ボタン数のルール:

    • URL タイプのみがサポートされており、ボタンは 1 つのみ許可されます。

    • HEADER に VIDEO が含まれる場合、ボタンタイプは URL ですが、URL アドレスを設定することはできません。

    array<object>

    任意

    ボタンの定義。

    AutofillText

    string

    任意

    Category が AUTHENTICATION で Button Type が ONE_TAP/ZERO_TAP の WhatsApp テンプレートで必須。WhatsApp 自動入力操作のボタンテキスト。

    Autofill
    PackageName deprecated

    string

    任意

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

    com.demo
    Text

    string

    任意

    ボタンの表示名。

    Call Me
    Url

    string

    任意

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

    https://example.com
    FlowId

    string

    任意

    フロー ID。

    479884093605****
    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 が必須です。

    • Viber テンプレートではボタンは 1 つのみ許可され、URL タイプである必要があります。

    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 の下のプロパティを使用してください。

    wi299382
    NavigateScreen

    string

    任意

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

    DETAILS
    PhoneNumber

    string

    任意

    電話番号。ボタンタイプが PHONE_NUMBER の場合にのみ有効。

    +861368897****
    SupportedApps

    array<object>

    任意

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

    object

    任意

    SignatureHash

    string

    任意

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

    ieid83kdiek
    PackageName

    string

    任意

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

    com.kuaidian.waimaistaff
    UrlType

    string

    任意

    URL のタイプ。

    • static: 静的

    • dynamic: 動的

    static
    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

    任意

    電話番号。

    +86138007****
    Text

    string

    任意

    ボタンのテキスト。

    Call me
    UrlType

    string

    任意

    URL のタイプ。

    • static: 静的。

    • dynamic: 動的。

    静的
    Url

    string

    任意

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

    https://alibaba.com/xx
    Url

    string

    任意

    マテリアルのパス。

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

    string

    必須

    テンプレート名。

    hello_whatsapp
    Language

    string

    必須

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

    en
    Example

    object

    任意

    テンプレート作成用の例。

    hello_whatsapp

    string

    任意

    テンプレート作成用の例。

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

    string

    必須

    テンプレートタイプ。有効な値:

    • WHATSAPP

    • VIBER

    WHATSAPP
    CustWabaId deprecated

    string

    任意

    ISV 顧客の WabaId。

    説明

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

    65921621816****
    IsvCode deprecated

    string

    任意

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

    skdi3kksloslikdkkdk
    CustSpaceId

    string

    任意

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

    293483938849493
    AllowCategoryChange deprecated

    boolean

    任意

    Facebook によるテンプレートカテゴリの自動変更を許可するかどうかを指定します (テンプレートの承認率向上のため)。このプロパティは TemplateType が WHATSAPP に設定されている場合にのみ有効です。

    重要 このプロパティは非推奨となりました。WhatsApp はこのプロパティをサポートしなくなりました。

    true
    MessageSendTtlSeconds

    integer

    任意

    WhatsApp におけるテンプレートメッセージの TTL (有効時間)。

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

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

    120
    CategoryChangePaused

    boolean

    任意

    Utility テンプレートが Marketing タイプに変更された際にテンプレートの送信を一時停止するかどうかを指定します。このプロパティは WhatsApp テンプレートに対してのみ有効です。

    false

    任意

    プロダクトセット ID。

    9928**

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

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

    RequestId

    string

    リクエスト ID。

    90E63D28-E31D-1EB2-8939-A94866411B2D
    Code

    string

    リクエスト状態コード。

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

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

    OK
    Message

    string

    エラーメッセージ。

    ユーザーは指定されたリソースに対する操作レート権限がありません。
    Data

    object

    返されるデータ。

    {"templateCode": "****4b5c79c9432497a075bdfca36bf5"，"templateName": "hello_whatsapp"}
    TemplateCode

    string

    テンプレートコード。

    SMS_232907****
    TemplateName

    string

    テンプレート名。

    hello_whatsapp
    AccessDeniedDetail

    string

    アクセス拒否の詳細。

    None
    Success

    boolean

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2D",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "Data": {
    "TemplateCode": "SMS_232907****",
    "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.

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

    変更履歴

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