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

获取消息模板列表。

接口说明

QPS 限制

本接口的单用户 QPS 限制为 5 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Name	string	否	模板名称。	hello_whatsapp
Language	string	否	模板语言。详细语言代码，请参见语言代码。	en
AuditStatus	string	否	审核状态。取值： pass：通过审核。 fail：拒绝审核。 auditing：审核中。 unaudit：审核暂停处理。	pass
Page	object	否	分页字段。
Index	integer	是	页码，默认为 1。	1
Size	integer	是	每次查询模板数量，默认为 10。	10
CustWabaId`deprecated`	string	否	ISV 客户 WabaId 说明过时的参数，请使用 CustSpaceId	65921621816****
IsvCode	string	否	ISV 校验码，用于校验子账号是否由 ISV 授权。	skdi3kksloslikdkkdk
CustSpaceId	string	否	ISV 子客户的 SpaceId	28251486512358****
TemplateType	string	否	模板类型。 WHATSAPP VIBER LINE（开发中）	WHATSAPP

返回参数

名称	类型	描述	示例值
	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	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
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"
    }
  ],
  "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.

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

变更历史

变更时间

变更内容概要

操作

2023-09-14

OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
出参	OpenAPI 返回结构发生变更。

2023-07-04

OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
出参	OpenAPI 返回结构发生变更。

2023-03-29

OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
出参	OpenAPI 返回结构发生变更。