全部產品
Search

搜尋本產品

    Chat App Message Service：ListChatappTemplate - 查詢ChatApp模板列表

    文件中心

    Chat App Message Service：ListChatappTemplate - 查詢ChatApp模板列表

    更新時間：Dec 22, 2025

    擷取訊息模板列表。

    介面說明

    QPS 限制

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

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    cams:ListChatappTemplate

    list

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Name

    string

    否

    模板名稱。

    hello_whatsapp
    Language

    string

    否

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

    en
    AuditStatus

    string

    否

    審核狀態。取值：

    • pass：通過審核。

    • fail：拒絕審核。

    • auditing：審核中。

    • unaudit：審核暫停處理。

    pass
    Page

    object

    否

    分分頁欄位。

    "page": "{\"index\": 1,\"size\": 20}
    Index

    integer

    是

    頁碼，預設為 1。

    1
    Size

    integer

    是

    每次查詢範本數量，預設為 10。

    10
    CustWabaId deprecated

    string

    否

    ISV 客戶 WabaId

    說明

    過時的參數，請使用 CustSpaceId。

    65921621816****

    IsvCode

    string

    否

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

    skdi3kksloslikdkkdk
    CustSpaceId

    string

    是

    ISV 子客戶的 SpaceId/直客客戶執行個體 ID。

    28251486512358****
    TemplateType

    string

    否

    模板類型。

    • WHATSAPP

    • VIBER

    WHATSAPP
    Code

    string

    否

    模板編碼。

    838888822*****

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回資料。

    RequestId

    string

    請求 ID。

    90E63D28-E31D-1EB2-8939-A9486641****
    Code

    string

    請求狀態代碼。

    • 返回 OK 代表請求成功。

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

    OK
    Message

    string

    錯誤提示資訊。

    User not authorized to operate on the specified resource.
    ListTemplate

    array<object>

    列表資料。

    object

    模板列表。

    TemplateName

    string

    模板名稱。

    hello_whatsapp
    TemplateCode

    string

    模板編碼。

    744c4b5c79c9432497a075bdfca3****
    AuditStatus

    string

    審核狀態。取值：

    • pass：通過審核。

    • fail：拒絕審核。

    • auditing：審核中。

    • unaudit：審核暫停處理。

    pass
    Language

    string

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

    en
    Category

    string

    Whatsapp 模板分類。取值：

    • UTILITY：交易相關。

    • MARKETING：營銷性模板。

    • AUTHENTICATION：身分識別驗證。

    Viber 模板分類

    • text：純文字

    • image：純圖片

    • text_image_button：文本 + 圖片 + 按鈕

    • text_button：文本 + 按鈕

    • document： 檔案

    • video：視頻

    • text_video：文本 + 視頻

    • text_video_button：文本 + 視頻 + 按鈕

    • text_image：文本 + 圖片

    UTILITY
    TemplateType

    string

    模板類型，取值為 WHATSAPP 或 VIBER。

    WHATSAPP
    Reason

    string

    模板審核被拒的原因。

    None
    LastUpdateTime

    integer

    最後修改時間

    1711006633000
    Total

    integer

    總記錄條數。

    1
    AccessDeniedDetail

    string

    訪問被拒絕詳細資料。

    無

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "ListTemplate": [
    {
      "TemplateName": "hello_whatsapp",
      "TemplateCode": "744c4b5c79c9432497a075bdfca3****",
      "AuditStatus": "pass",
      "Language": "en",
      "Category": "UTILITY",
      "TemplateType": "WHATSAPP",
      "Reason": "None",
      "LastUpdateTime": 1711006633000
    }
  ],
  "Total": 1,
  "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. 資源不屬於目前使用者。

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

    變更歷史

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