すべてのプロダクト
Search

このプロダクト

    :CreateChatappTemplate

    ドキュメントセンター

    :CreateChatappTemplate

    最終更新日:Nov 13, 2025

    メッセージテンプレートを作成します。テンプレートが承認されると、それを使用してメッセージを送信できます。

    操作説明

    QPS 制限

    この操作の 1 秒あたりのクエリ数 (QPS) 制限は、ユーザーあたり 50 です。制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響を与える可能性があります。この操作は、適切な頻度で呼び出すことをお勧めします。

    ステータスの変更

    Message Service (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

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Category

    string

    必須

    WhatsApp テンプレートのカテゴリ:

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

    • MARKETING: マーケティング。

    • AUTHENTICATION: 認証。

    Viber テンプレートのカテゴリ:

    • text: プレーンテキスト

    • image: 画像のみ

    • text_image_button: テキスト、画像、ボタン

    • text_button: テキストとボタン

    • document: ファイル

    • video: ビデオ

    • text_video: テキストとビデオ

    • text_video_button: テキスト、ビデオ、ボタン

    • text_image: テキストと画像

    UTILITY
    Components

    array<object>

    必須

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

    説明

    Category が AUTHENTICATION に設定されている場合、Components 配列に HEADER コンポーネントを含めることはできません。コンポーネントの Type が BODY または FOOTER の場合、Text パラメーターは空でなければなりません。

    array<object>

    任意

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

    Type

    string

    必須

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

    • BODY

    • HEADER

    • FOOTER

    • BUTTONS

    • CAROUSEL

    • LIMITED_TIME_OFFER

    説明

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

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

    • Viber テンプレートの場合、画像、ビデオ、ファイルは HEADER に配置されます。クライアントはテキストの下に画像を表示します。

    BODY
    Text

    string

    任意

    メッセージのテキスト。

    説明

    Category が AUTHENTICATION に設定されている場合、このパラメーターは空でなければなりません。

    hello whatsapp
    Format

    string

    任意

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

    • TEXT: テキスト

    • IMAGE: 画像

    • DOCUMENT: ドキュメント

    • VIDEO: ビデオ

    TEXT
    Url

    string

    任意

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

    説明

    Viber テンプレートの場合、推奨される画像サイズは 800 × 800 ピクセルです。

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

    string

    任意

    ファイルの説明。

    这是一个视频
    FileName

    string

    任意

    ファイルの名前。

    快递视频
    Buttons

    array<object>

    任意

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

    説明

    WhatsApp テンプレートのボタン数

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

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

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

    • QUICK_REPLY ボタンは PHONE_NUMBER または URL ボタンと混在させることはできません。

    array<object>

    任意

    ボタンの定義。

    Type

    string

    必須

    ボタンのタイプ。

    • PHONE_NUMBER: 通話ボタン

    • URL: URL ボタン

    • 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
    Text

    string

    任意

    ボタンに表示される名前。

    Call Me
    PhoneNumber

    string

    任意

    電話番号。このパラメーターは、ボタンの Type が PHONE_NUMBER の場合にのみ有効です。

    +861368897****
    Url

    string

    任意

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

    https://example.com
    UrlType

    string

    任意

    URL のタイプ。

    • static: 静的

    • dynamic: 動的

    static
    SignatureHash deprecated

    string

    任意

    代わりに SupportedApps の下のパラメーターを使用してください。

    wi299382
    PackageName deprecated

    string

    任意

    代わりに SupportedApps の下のパラメーターを使用してください。

    com.demo
    AutofillText

    string

    任意

    WhatsApp 自動入力アクションのボタンテキスト。このパラメーターは、Category が AUTHENTICATION で、ボタンの Type が ONE_TAP または ZERO_TAP の WhatsApp テンプレートで必要です。

    Autofill
    IsOptOut

    boolean

    任意

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

    false
    CouponCode

    string

    任意

    クーポンコードの値。文字と数字のみを含めることができます。$(couponCode) などの変数を渡し、メッセージ送信時に実際のクーポンコードを提供できます。

    120293
    FlowId

    string

    任意

    フロー ID。

    479884093605****
    FlowAction

    string

    任意

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

    • DATA_EXCHANGE: データ交換。

    • NAVIGATE: ナビゲーション。

    NAVIGATE
    NavigateScreen

    string

    任意

    ナビゲートする画面。このパラメーターは、FlowAction が NAVIGATE に設定されている場合に必要です。

    DETAILS
    SupportedApps

    array<object>

    任意

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

    object

    任意

    SignatureHash

    string

    任意

    WhatsApp が起動するアプリケーションの署名ハッシュ。このパラメーターは、Category が AUTHENTICATION で、ボタンの Type が ONE_TAP または ZERO_TAP の WhatsApp テンプレートで必要です。

    ieid83kdiek
    PackageName

    string

    任意

    WhatsApp が起動するアプリケーションのパッケージ名。このパラメーターは、Category が AUTHENTICATION で、ボタンの Type が ONE_TAP または ZERO_TAP の WhatsApp テンプレートで必要です。

    com.kuaidian.waimaistaff
    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
    Duration

    integer

    任意

    Viber ビデオメッセージのビデオの長さ (秒単位)。値の範囲は 0 から 600 です。

    120
    FileType

    string

    任意

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

    docx
    CodeExpirationMinutes

    integer

    任意

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

    5
    AddSecretRecommendation

    boolean

    任意

    このパラメーターは、Category が AUTHENTICATION で、コンポーネントの Type が Body の WhatsApp テンプレートで有効です。これは、本文の上にメッセージが表示され、ユーザーに確認コードを他の人と共有しないように注意を促すことを示します。

    true
    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

    任意

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

    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

    任意

    電話番号。

    +86138007****
    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 顧客の WABA ID。

    説明

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

    65921621816****
    IsvCode

    string

    任意

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

    skdi3kksloslikdkkdk
    CustSpaceId

    string

    必須

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

    293483938849493
    AllowCategoryChange deprecated

    boolean

    任意

    Facebook がテンプレートカテゴリを自動的に変更することを許可するかどうかを指定します。これにより、テンプレートの承認率が向上します。このパラメーターは、TemplateType が WHATSAPP の場合にのみ有効です。

    重要 このパラメーターは非推奨です。WhatsApp はこのパラメーターをサポートしなくなりました。

    true
    MessageSendTtlSeconds

    integer

    任意

    WhatsApp のテンプレートメッセージの有効期間。

    • AUTHENTICATION テンプレートの場合、値の範囲は 30 から 900 です。

    • UTILITY テンプレートの場合、値の範囲は 30 から 43200 です。

    120

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されたデータ。

    RequestId

    string

    リクエスト ID。

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

    string

    リクエストのステータスコード。

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

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

    OK
    Message

    string

    エラーメッセージ。

    User not authorized to operate on the specified resource.
    Data

    object

    返されたデータ。

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

    string

    テンプレートコード。

    SMS_232907****
    TemplateName

    string

    テンプレート名。

    hello_whatsapp
    AccessDeniedDetail

    string

    アクセス拒否に関する詳細。

    None

    例

    成功レスポンス

    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"
}

    エラーコード

    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.

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

    変更履歴

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