全部產品
Search

搜尋本產品

    Chat App Message Service：建立WhatsApp訊息模板

    文件中心

    Chat App Message Service：建立WhatsApp訊息模板

    更新時間：Jan 23, 2025

    介面說明

    QPS 限制

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

    調試

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

    授權資訊

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

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

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

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

    • 對於必選的資源類型，用背景高亮的方式表示。

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    cams:CreateChatappTemplate

    Write

    • 全部資源*

    無

    無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值

    Category

    string

    是

    Whatsapp模板分類。取值：

    • UTILITY：交易相關。

    • MARKETING：營銷性模板。

    • AUTHENTICATION：身分識別驗證。

    UTILITY

    Components

    object []

    是

    訊息模板組件列表。

    說明

    在Category=AUTHENTICATION時，Components不允許出現Type=HEADER的節點，並且Type=BODY/FOOTER時，Text內容應該為空白。

    -

    Type

    string

    是

    組件類型。

    • BODY

    • HEADER

    • FOOTER

    • BUTTONS

    • CAROUSEL

    • LIMITED_TIME_OFFER

    說明

    Whatsapp類型模板時，BODY組件的字元長度不超過1024個字元。HEADER和FOOTER組件的字元長度不超過60個字元。

    BODY

    Text

    string

    否

    發送訊息的文本。

    說明

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

    hello

    Format

    string

    否

    媒體資源類型。

    • TEXT：文本

    • IMAGE：圖片

    • DOCUMENT：文檔

    • VIDEO：視頻

    TEXT

    Url

    string

    否

    素材路徑。

    說明

    素材大小需符合要求，具體參數參見媒體支援類型及大小限制。

    https://image.developer.aliyundoc.com

    Caption

    string

    否

    檔案的描述。

    這是一個視頻

    FileName

    string

    否

    檔案的名稱。

    快遞視頻

    Buttons

    object []

    否

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

    說明

    Whatsapp按鈕數量說明

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

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

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

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

    Type

    string

    是

    按鈕類型。

    • PHONE_NUMBER：撥打到電話按鈕

    • URL：網頁按鈕

    • QUICK_REPLY：快速回複按鈕

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

    • ONE_TAP：AUTHENTICATION模板時回填按鈕

    • CATALOG：商品目錄按鈕

    • MPM：多商品按鈕

    • Flow：WhatsApp Flow按鈕

    • ZERO_TAP：零點擊身分識別驗證按鈕

    說明

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

    PHONE_NUMBER

    Text

    string

    否

    按鈕顯示的名稱。

    Call Me

    PhoneNumber

    string

    否

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

    +861368897****

    Url

    string

    否

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

    https://example.com

    UrlType

    string

    否

    網址類型。

    • static：靜態

    • dynamic：動態

    static

    SignatureHash

    string

    否

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

    wi299382

    PackageName

    string

    否

    Whatsapp模板，Category為AUTHENTICATION且Button Type為ONE_TAP時必填，表示Whatsapp調起應用的包名。

    com.demo

    AutofillText

    string

    否

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

    Autofill

    IsOptOut

    boolean

    否

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

    false

    CouponCode

    string

    否

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

    120293

    FlowId

    string

    否

    WhatsApp Flow ID。

    479884093605183

    FlowAction

    string

    否

    WhatsApp Flow資料事件類型

    枚舉值：

    • DATA_EXCHANGE：DATA_EXCHANGE。

    • NAVIGATE：NAVIGATE。

    NAVIGATE

    NavigateScreen

    string

    否

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

    DETAILS

    CodeExpirationMinutes

    integer

    否

    Whatsapp AUTHENTICATION模板驗證碼有效期間（分鐘），只在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

    object []

    否

    Carousel模板卡片列表。

    CardComponents

    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

    object []

    否

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

    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

    否

    電話號碼。

    +8613800

    Name

    string

    是

    模板名稱。

    hello_whatsapp

    Language

    string

    是

    範本語言。詳細語言代碼，請參見語言代碼。

    en

    Example

    object

    否

    建立模板的樣本。

    string

    否

    變數例子。

    通過把JSON結構轉成String的方式傳入。

    {"textVariable":"text"}

    TemplateType

    string

    是

    模板類型。

    WHATSAPP

    WHATSAPP

    CustSpaceId

    string

    否

    ISV子客戶的SpaceId。

    293483938849493

    AllowCategoryChange

    boolean

    否

    是否允許facebook自動變更模板的目錄（這樣能提高模板的審核通過率）。

    true

    MessageSendTtlSeconds

    integer

    否

    Whatsapp中Authentication模板訊息發送時的有效期間。

    說明

    此屬性需要提前提供WABA給阿里營運人員開白名單，不然會導致模板送審失敗。

    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

    string

    模板Code。

    SMS_232907****

    TemplateName

    string

    模板名稱。

    hello_world

    AccessDeniedDetail

    string

    訪問被拒絕詳細資料。

    -

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866******",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "Data": {
    "TemplateCode": "MSG_232907****",
    "TemplateName": "hello_world"
  },
  "AccessDeniedDetail": "無"
}

    錯誤碼

    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.

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