全部產品
Search

搜尋本產品

    Chat App Message Service：CreateChatappTemplate - 建立ChatApp模板

    文件中心

    Chat App Message Service：CreateChatappTemplate - 建立ChatApp模板

    更新時間：Nov 13, 2025

    建立訊息模板，模板審核通過後可以發送訊息。

    介面說明

    QPS 限制

    本介面的單使用者 QPS 限制為 50 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。

    狀態變更

    模板的狀態和品質變更可以通過 MNS/HTTP 方式監聽，具體請參考回執訊息。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    cams:CreateChatappTemplate

    create

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    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 不允許出現 Type=HEADER 的節點，並且 Type=BODY 或 FOOTER 時，Text 內容應該為空白。

    array<object>

    否

    組件列表。

    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
    Text

    string

    否

    發送訊息的文本。

    說明

    在 Category=AUTHENTICATION 中，此屬性值為空白。

    hello whatsapp
    Format

    string

    否

    媒體資源類型。

    • TEXT：文本

    • IMAGE：圖片

    • DOCUMENT：文檔

    • VIDEO：視頻

    TEXT
    Url

    string

    否

    素材路徑。

    說明

    Viber 類型時圖片建議大小：800px * 800px。

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

    string

    否

    檔案的描述。

    這是一個視頻
    FileName

    string

    否

    檔案的名稱。

    快遞視頻
    Buttons

    array<object>

    否

    按鈕列表，僅適用於 BUTTONS 組件。

    說明

    Whatsapp 按鈕數量說明

    • Whatsapp 在類型為 MARKETING/UTILITY 時，最多允許 10 個按鈕

    • PHONE_NUMBER 類型的按鈕只允許存在 1 個

    • URL 類型的按鈕最多允許存在 2 個

    • QUICK_REPLY 按鍵不允許和 PHONE_NUMBER/URL 按鈕亂序出現

    array<object>

    否

    按鈕定義。

    Type

    string

    是

    按鈕類型。

    • PHONE_NUMBER：撥打到電話按鈕

    • URL：網頁按鈕

    • QUICK_REPLY：快速回複按鈕

    • COPY_CODE：複製驗證碼、優惠碼

    • ONE_TAP：AUTHENTICATION 模板時回填按鈕

    • ZERO_TAP：AUTHENTICATION 模板時回填按鈕

    • MPM：多商品目錄

    • CATALOG：目錄

    • FLOW：開啟 Whatsapp flow

    說明

    • Whatsapp 類型模板且 Category 為 AUTHENTICATION 時，按鈕只允許存在一個，並且類型只能是 COPY_CODE/ONE_TAP, 當類型選擇 COPY_CODE 時，Text 為必填。當類型選擇 ONE_TAP 時，Text（在終端沒有裝目標應用時顯示，表示採用複製驗證碼按鈕的名稱）必填，SignatureHash, PackageName, AutofillText 屬性必填。

    • Viber 類型的模板只允許一個 Button 且只能是 URL 類型。

    PHONE_NUMBER
    Text

    string

    否

    按鈕顯示的名稱。

    Call Me
    PhoneNumber

    string

    否

    電話號碼，僅按鈕類型為PHONE_NUMBER時有效。

    +861368897****
    Url

    string

    否

    點選連結按鈕將訪問的網址。

    https://example.com
    UrlType

    string

    否

    網址類型。

    • static：靜態

    • dynamic：動態

    static
    SignatureHash deprecated

    string

    否

    請使用 SupportedApps 下的屬性

    wi299382
    PackageName deprecated

    string

    否

    請使用 SupportedApps 下的屬性

    com.demo
    AutofillText

    string

    否

    Whatsapp 模板，Category 為 AUTHENTICATION 且 Button Type 為 ONE_TAP/ZERO_TAP 時必填，Whatsap Autofill 操作的按鈕文本。

    Autofill
    IsOptOut

    boolean

    否

    Whatsapp 模板，在 Category 為 Marketing,並且 Button type 為 QUICK_REPLY 時有效，表示按鈕為營銷退訂按鈕，客戶如果點擊了此按鈕，且在 ChatApp 已配置了發送控制操作，則後續 Marketing 訊息則不會發送到客戶。

    false
    CouponCode

    string

    否

    優惠碼值，只支援字母+數字，可以傳入變數如$(couponCode)，在發送時再傳入優惠碼

    120293
    FlowId

    string

    否

    Flow ID。

    479884093605****
    FlowAction

    string

    否

    Flow 資料事件類型。取值：

    • DATA_EXCHANGE：資料交換。

    • NAVIGATE：導航，

    NAVIGATE
    NavigateScreen

    string

    否

    跳轉屏，在 FlowAction=NAVIGATE 時必填。

    DETAILS
    SupportedApps

    array<object>

    否

    支援的 APP 列表。

    object

    否

    SignatureHash

    string

    否

    WhatsApp 模板，Category 為 AUTHENTICATION 且 Button Type 為 ONE_TAP/ZERO_TAP 時必填，表示 Whatsapp 調起應用的簽名 Hash 值。

    ieid83kdiek
    PackageName

    string

    否

    WhatsApp 模板，Category 為 AUTHENTICATION 且 Button 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 模板驗證碼有效期間（分鐘），只在 Whatsapp 類型訊息，Category 為 AUTHENTICATION 並且 Component Type 為 Footer 時有效（此資訊顯示在 Footer 位置）。

    5
    AddSecretRecommendation

    boolean

    否

    Whatsapp 類型模板，Category 為 AUTHENTICATION 且 Component Type 為 Body 時有效，表示在 Body 上面顯示不要將驗證碼資訊提供給其它人的提示資訊。

    true
    HasExpiration

    boolean

    否

    優惠碼是否存在到期時間，在 type = LIMITED_TIME_OFFER 時使用。

    true
    Cards

    array<object>

    否

    Carousel 模板卡片列表。

    array<object>

    否

    Carousel 模板卡片對象。

    CardComponents

    array<object>

    是

    Carousel 卡片中控制項列表。

    array<object>

    否

    Carousel 模板中卡片對象。

    Type

    string

    是

    組件類型。取值：

    • BODY

    • HEADER

    • BUTTONS

    BODY
    Format

    string

    否

    媒體資源類型，在 Type = HEADER 時有效。

    • IMAGE：圖片

    • VIDEO：視頻

    IMAGE
    Text

    string

    否

    Carousel 卡片中 BODY 的內容。

    Who is the very powerful team
    Url

    string

    否

    素材路徑。

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

    array<object>

    否

    按鈕列表，僅適用於 BUTTONS 組件。Carousel 每個卡片最多隻能有兩個按鈕。

    object

    否

    按鈕對象。

    Text

    string

    否

    按鈕文本。

    Call me
    Type

    string

    是

    按鈕類型。

    • PHONE_NUMBER：撥打到電話按鈕

    • URL：網頁按鈕

    • QUICK_REPLY：快速回複按鈕

    PHONE_NUMBER
    Url

    string

    否

    點擊按鈕後將訪問的網址。

    https://alibaba.com/xx
    UrlType

    string

    否

    網址類型

    • 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 客戶 WabaId。

    說明

    過時的參數，請使用 CustSpaceId。

    65921621816****
    IsvCode

    string

    否

    ISV 校正碼，用於校正子帳號是否由 ISV 授權。

    skdi3kksloslikdkkdk
    CustSpaceId

    string

    是

    ISV 子客戶的 SpaceId/直客客戶執行個體 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 代表請求成功。

    • 其他錯誤碼，請參見錯誤碼列表。

    OK
    Message

    string

    錯誤提示資訊。

    User not authorized to operate on the specified resource.
    Data

    object

    返回資料。

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

    string

    模板 Code。

    SMS_232907****
    TemplateName

    string

    模板名稱。

    hello_whatsapp
    AccessDeniedDetail

    string

    訪問被拒絕詳細資料。

    None

    樣本

    正常返回樣本

    JSON格式

    {
  "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 status code

    錯誤碼

    錯誤資訊

    描述
    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. 資源不屬於目前使用者。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。