全部产品
Search

搜索本产品

    ChatAPP 消息服务：ListChatappTemplate - 查询ChatApp模板列表

    文档中心

    ChatAPP 消息服务：ListChatappTemplate - 查询ChatApp模板列表

    更新时间：Apr 11, 2024

    获取消息模板列表。

    接口说明

    QPS 限制

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

    调试

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

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    cams:ListChatappTemplateRead
    • 全部资源
      *
      无
    		无

    请求参数

    名称类型必填描述示例值
    Namestring否

    模板名称。

    		hello_whatsapp
    Languagestring否

    模板语言。 详细语言代码，请参见语言代码。

    		en
    AuditStatusstring否

    审核状态。取值：

    • pass：通过审核。

    • fail：拒绝审核。

    • auditing：审核中。

    • unaudit：审核暂停处理。

    		pass
    Pageobject否

    分页字段。

    Indexinteger是

    页码，默认为 1。

    		1
    Sizeinteger是

    每次查询模板数量，默认为 10。

    		10
    CustWabaIddeprecatedstring否

    ISV 客户 WabaId

    说明 过时的参数，请使用 CustSpaceId
    		65921621816****
    IsvCodestring否

    ISV 校验码，用于校验子账号是否由 ISV 授权。

    		skdi3kksloslikdkkdk
    CustSpaceIdstring否

    ISV 子客户的 SpaceId

    		28251486512358****
    TemplateTypestring否

    模板类型。

    • WHATSAPP

    • VIBER

    • LINE（开发中）

    		WHATSAPP

    返回参数

    名称类型描述示例值
    object

    返回数据。

    RequestIdstring

    请求 ID。

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

    请求状态码。

    • 返回 OK 代表请求成功。

    • 其他错误码，请参见错误码列表。

    		OK
    Messagestring

    错误提示信息。

    		User not authorized to operate on the specified resource.
    ListTemplateobject []

    列表数据。

    TemplateNamestring

    模板名称。

    		hello_whatsapp
    TemplateCodestring

    模板编码。

    		744c4b5c79c9432497a075bdfca3****
    AuditStatusstring

    审核状态。取值：

    • pass：通过审核。

    • fail：拒绝审核。

    • auditing：审核中。

    • unaudit：审核暂停处理。

    		pass
    Languagestring

    模板语言。 详细语言代码，请参见语言代码。

    		en
    Categorystring

    Whatsapp 模板分类。取值：

    • UTILITY：交易相关。

    • MARKETING：营销性模板。

    • AUTHENTICATION：身份验证。

    Viber 模板分类

    • text：纯文本

    • image：纯图片

    • text_image_button：文本 + 图片 + 按钮

    • text_button：文本 + 按钮

    • document： 文件

    • video：视频

    • text_video：文本 + 视频

    • text_video_button：文本 + 视频 + 按钮

    • text_image：文本 + 图片

    		UTILITY
    TemplateTypestring

    模板类型，取值为 WHATSAPP/VIBER

    		WHATSAPP
    Reasonstring

    模板审核被拒的原因

    		None
    Totalinteger

    总记录条数。

    		1
    AccessDeniedDetailstring

    访问被拒绝详细信息。

    		无

    示例

    正常返回示例

    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错误码错误信息
    400Product.UnsubscriptYou have not subscribed to the specified product.
    400Ram.PermissionDenyYou are not authorized to perform the operation.
    400System.LimitControlThe system is under flow control.
    400Unknown.ResourceOwnerIdThe resource does not belong to the current user.

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

    变更历史

    变更时间变更内容概要操作
    2023-09-14OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      删除错误码：400
    出参OpenAPI 返回结构发生变更。
    2023-07-04OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      删除错误码：400
    出参OpenAPI 返回结构发生变更。
    2023-03-29OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      删除错误码：400
    出参OpenAPI 返回结构发生变更。