全部產品
Search
文件中心

Chat App Message Service:ListChatappTemplate

更新時間:Aug 10, 2026

取得訊息範本清單。

介面說明

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}

Size

integer

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

10

Index

integer

頁碼,預設為 1。

1

CustWabaId deprecated

string

ISV 客戶 WabaId。

說明

已過時的參數,請使用 CustSpaceId。

65921621816****

CustSpaceId

string

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

28251486512358****

TemplateType

string

範本類型。

  • WHATSAPP

  • VIBER

WHATSAPP

Code

string

範本編碼。

838888822*****

Category

string

範本分類。

AUTHENTICATION

IsvCode

string

ISV 驗證碼,用於驗證子帳號是否由 ISV 授權。

skdi3kksloslikdkkdk

返回參數

名稱

類型

描述

樣本值

object

返回資料。

AccessDeniedDetail

string

存取被拒絕詳細資訊。

Message

string

錯誤提示訊息。

User not authorized to operate on the specified resource.

RequestId

string

請求 ID。

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

ListTemplate

array<object>

清單資料。

object

範本清單。

TemplateCode

string

範本編碼。

744c4b5c79c9432497a075bdfca3****

AuditStatus

string

審核狀態。取值:

  • pass:通過審核。

  • fail:拒絕審核。

  • auditing:審核中。

  • unaudit:審核暫停處理。

pass

Category

string

Whatsapp 範本分類。取值:

  • UTILITY:交易相關。

  • MARKETING:行銷性範本。

  • AUTHENTICATION:身分驗證。

Viber 範本分類:

  • UTILITY:交易相關。

  • MARKETING:行銷性範本。

  • AUTHENTICATION:身分驗證。

UTILITY

Language

string

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

en

LastUpdateTime

integer

最後修改時間。

1711006633000

TemplateName

string

範本名稱。

hello_whatsapp

TemplateType

string

範本類型,取值為 WHATSAPP 或 VIBER。

WHATSAPP

Reason

string

範本審核被拒的原因。

None

Total

integer

總記錄筆數。

1

Code

string

請求狀態碼。

  • 返回 OK 代表請求成功。

  • 其他錯誤碼,請參見錯誤碼清單

OK

Success

boolean

是否呼叫成功:

  • true:呼叫成功。

  • false:呼叫失敗。

false

樣本

正常返回樣本

JSON格式

{
  "AccessDeniedDetail": "無",
  "Message": "User not authorized to operate on the specified resource.",
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "ListTemplate": [
    {
      "TemplateCode": "744c4b5c79c9432497a075bdfca3****",
      "AuditStatus": "pass",
      "Category": "UTILITY",
      "Language": "en",
      "LastUpdateTime": 1711006633000,
      "TemplateName": "hello_whatsapp",
      "TemplateType": "WHATSAPP",
      "Reason": "None"
    }
  ],
  "Total": 1,
  "Code": "OK",
  "Success": false
}

錯誤碼

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.

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

變更歷史

更多資訊,參考變更詳情