すべてのプロダクト
Search

このプロダクト

    :CreateChatappTemplate

    ドキュメントセンター

    :CreateChatappTemplate

    最終更新日:Jun 09, 2026

    メッセージテンプレートを作成します。テンプレートが承認された後、メッセージの送信に使用できます。

    操作説明

    QPS 制限

    この API の秒間クエリ数 (QPS) 制限は、ユーザーあたり 50 です。制限を超えると、API 呼び出しはレート制限され、ビジネスに影響を及ぼす可能性があります。適切な頻度でこの 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 テンプレートのカテゴリ：

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

    • MARKETING：マーケティング。

    • AUTHENTICATION：認証。

    UTILITY
    Components

    array<object>

    必須

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

    説明

    Category が AUTHENTICATION に設定されている場合、Components 配列に HEADER タイプのコンポーネントを含めることはできません。コンポーネントタイプが 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 コンポーネントに配置されます。

    BODY
    Text

    string

    任意

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

    説明

    WhatsApp テンプレートの場合、Category が AUTHENTICATION に設定されている場合、このパラメーターは空です。

    hello whatsapp
    Format

    string

    任意

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

    • TEXT：テキスト

    • IMAGE：画像

    • DOCUMENT：ドキュメント

    • VIDEO：動画

    TEXT
    Url

    string

    任意

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

    説明

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

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

    string

    任意

    ファイルの説明。

    This is a video
    FileName

    string

    任意

    ファイルの名前。

    Express delivery video
    Buttons

    array<object>

    任意

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

    説明

    WhatsApp のボタン数

    • MARKETING または UTILITY テンプレートの場合、最大 10 個のボタンを追加できます。

    • PHONE_NUMBER タイプのボタンは 1 つのみ追加できます。

    • URL タイプのボタンは最大 2 つまで追加できます。

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

    説明

    Viber のボタン数

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

    • HEADER コンポーネントに動画が含まれている場合、ボタンタイプは URL ですが、URL を設定することはできません。

    array<object>

    任意

    ボタンの定義。

    Type

    string

    必須

    ボタンタイプ。

    • PHONE_NUMBER：通話ボタン。

    • URL：URL ボタン。

    • QUICK_REPLY：クイック返信ボタン。

    • COPY_CODE：認証コードまたはクーポンコードをコピーするボタン。

    • ONE_TAP：AUTHENTICATION テンプレート用の自動入力ボタン。

    • ZERO_TAP：AUTHENTICATION テンプレート用の自動入力ボタン。

    • MPM：マルチプロダクトメッセージ。

    • CATALOG：カタログ。

    • FLOW：WhatsApp フローを開きます。

    説明

    • WhatsApp テンプレートの場合、Category が AUTHENTICATION に設定されている場合、ボタンは 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

    任意

    電話番号。このパラメーターは、ボタンタイプが 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 に設定され、ボタンタイプが ONE_TAP または ZERO_TAP の場合に必要です。WhatsApp 自動入力アクションのボタンテキストを指定します。

    Autofill
    IsOptOut

    boolean

    任意

    このパラメーターは、WhatsApp テンプレートで Category が MARKETING に設定され、ボタンタイプが QUICK_REPLY の場合に有効です。ボタンがマーケティングオプトアウトボタンであることを示します。顧客がこのボタンをクリックし、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 に設定され、ボタンタイプが ONE_TAP または ZERO_TAP の場合に必要です。WhatsApp が起動するアプリの署名ハッシュを指定します。

    ieid83kdiek
    PackageName

    string

    任意

    このパラメーターは、WhatsApp テンプレートで Category が AUTHENTICATION に設定され、ボタンタイプが 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 テンプレートの認証コードの有効期間 (分単位)。このパラメーターは、WhatsApp メッセージで Category が AUTHENTICATION に設定され、コンポーネントタイプが FOOTER の場合にのみ有効です。この情報はフッターに表示されます。

    5
    AddSecretRecommendation

    boolean

    任意

    このパラメーターは、WhatsApp テンプレートで Category が AUTHENTICATION に設定され、コンポーネントタイプが BODY の場合に有効です。本文の上にセキュリティの推奨事項が表示され、ユーザーに認証コードを共有しないよう警告します。

    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) の顧客の WhatsApp Business アカウント (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 におけるテンプレートメッセージの Time-to-Live (TTL)。

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

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

    変更履歴

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