使用ListChatappTemplate API查询ChatApp模板列表-Chat App 消息服务-阿里云-Chat App 消息服务(Chat App)-阿里云帮助中心

获取消息模板列表。

接口说明

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.	资源不属于当前用户。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。