GetChatappTemplateDetail - 查询ChatApp模板详情 - ChatAPP 消息服务

获取消息模板的详细信息。

接口说明

QPS 限制

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
cams:GetChatappTemplateDetail	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
TemplateCode	string	是	模板 Code。	****4b5c79c9432497a075bdfca36bf5
Language	string	是	模板语言。详细语言代码，请参见语言代码。	en_US
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。	744c4b5c79c9432497a075bdfca3****
Code	string	请求状态码。返回 OK 代表请求成功。其他错误码，请参见错误码列表。	OK
Message	string	错误提示信息。	User not authorized to operate on the specified resource.
Data	object	返回数据。
Category	string	Whatsapp 模板分类。取值： UTILITY：交易相关。 MARKETING：营销性模板。 AUTHENTICATION：身份验证。 Viber 模板分类 text：纯文本 image：纯图片 text_image_button：文本 + 图片 + 按钮 text_button：文本 + 按钮 document：文件 video：视频 text_video：文本 + 视频 text_video_button：文本 + 视频 + 按钮 text_image：文本 + 图片说明当 Viber 模板取值为 text_video_button 时，按钮并不能打开网页，只是在网页中打开当前消息的视频，所以按钮的 URL 中不需要填写任何地址信息	UTILITY
TemplateCode	string	模板 Code。	744c4b5c79c9432497a075bdfca3****
Name	string	模板名称。	hello_whatsapp
Language	string	模板语言。详细语言代码，请参见语言代码。	en_US
Example	object	变量举例。
	string	模板变量对应的实际值，参数格式为 JSON 格式。	{\"textVariable\":\"text\",\"linkVariable\":\"https://image.developer.aliy\"}
AuditStatus	string	审核状态。取值： pass：通过审核。 fail：拒绝审核。 auditing：审核中。 unaudit：审核暂停处理。	pass
Components	object []	消息模板组件列表。
Type	string	组件类型。 BODY HEADER FOOTER BUTTONS CAROUSEL LIMITED_TIME_OFFER 说明 Whatsapp 类型模板时，BODY 组件的字符长度不超度是 1024 个字符。HEADER 和 FOOTER 组件的字符长度不超过 60 个字符。 Viber 类型模板时，FOOTER，CAROUSEL，LIMITED_TIME_OFFER 类型无效。 Viber 类型模板中，图片、视频、文件都是放在 HEADER 中（终端将图片显示在文本之下）。	BODY
Url	string	素材路径。	https://image.developer.aliyundoc.com
Text	string	发送消息的文本。	你好
Caption	string	文件的描述。	新文件已上传
FileName	string	文件的名称。	快递文件
Format	string	格式。	TEXT
Buttons	object []	按钮列表，仅适用于 BUTTONS 组件。说明 Whatsapp 按钮数量说明 Whatsapp 在类型为 MARKETING/UTILITY 时，最多允许 10 个按钮 PHONE_NUMBER 类型的按钮只允许存在 1 个 URL 类型的按钮最多允许存在 2 个 QUICK_REPLY 按钮不允许和 PHONE_NUMBER/URL 按钮乱序出现
Type	string	按钮类型。 PHONE_NUMBER：拨打电话按钮 URL：网页按钮 QUICK_REPLY：快速回复按钮 COPY_CODE：复制验证码、优惠码 ONE_TAP：AUTHENTICATION 模板时回填按钮说明 Whatsapp 类型模板且 Category 为 AUTHENTICATION 时，按钮只允许存在一个，并且类型只能是 COPY_CODE/ONE_TAP, 当类型选择 COPY_CODE 时，Text 为必填。当类型选择 ONE_TAP 时，Text（在终端没有装目标应用时显示，表示采用复制验证码按钮的名称）必填，SignatureHash, PackageName, AutofillText 属性必填。 Viber 类型的模板只允许一个 Button 且只能是 URL 类型。	PHONE_NUMBER
Text	string	按钮显示的名称。	打电话
PhoneNumber	string	电话号码，仅按钮类型为PHONE_NUMBER时有效。	861398745****
Url	string	点击链接按钮将访问的网址。	https://example.com
UrlType	string	网址类型。 static：静态 dynamic：动态	static
SignatureHash	string	Whatsapp 模板，Category 为 Authentication，并且 Button Type 为 ONE_TAP 时必填，表示 Whatsapp 调起应用的签名 Hash 值。	2993839
PackageName	string	Whatsapp 模板，Category 为 Authentication，并且 Button Type 为 ONE_TAP 时必填，表示 Whatsapp 调起应用的包名。	com.aliyun
AutofillText	string	Whatsapp 模板，Category 为 Authentication，并且 Button Type 为 ONE_TAP 时必填，Whatsap Autofill 操作的按钮文本。	Autofill
IsOptOut	boolean	Whatsapp 模板，在 Category 为 Marketing,并且 Button type 为 QUICK_REPLY 时有效，表示按钮为营销退订按钮，客户如果点击了此按钮，并且在 chatapp 平台上配置了发送控制操作，则后续 Marketing 消息则不会发送到客户。	false
ExtendAttrs	object	扩展字段。
NextTemplateCode	string	下一个模板编码。	20939920093993
NextTemplateName	string	下一个模板名称。	abc
NextLanguageCode	string	下一个模板语言。	en
Action	string	事件类型。	nextCard
IntentCode	string	意图编码。	test
CouponCode	string	优惠券码	202039ksjs
FlowId	string	Flow ID	3838292983
FlowAction	string	flow 数据事件类型取值范围：NAVIGATE/DATA_EXCHANGE	NAVIGATE
NavigateScreen	string	跳转屏在 FlowAction=NAVIGATE 时必填	DETAILS
ThumbUrl	string	Viber 带视频消息的缩略图。	https://img.png
Duration	integer	Viber 视频消息的视频时长，取值范围：0~600	50
FileType	string	Viber 文件消息的文件类型。	docx
Latitude	string	位置纬度属性。	28.001
Longitude	string	位置经度属性。	120.002
LocationName	string	位置名称。	杭州
LocationAddress	string	位置地址。	杭州
AddSecretRecommendation	boolean	Whatsapp 类型模板，Category 为 Authentication，并且 Component Type 为 Body 时有效，表示在 Body 上面显示不要将验证码信息提供给其它人的提示信息。	false
CodeExpirationMinutes	integer	Whatsapp Authentication 模板验证码有效期（分钟），只在 Whatsapp 类型消息，Category 为 Authentication 并且 Component Type 为 Footer 时有效（此信息显示在 Footer 位置）。	5
hasExpiration	boolean	LTO 模板中，优惠码是否有过期时间	true
OfferExpirationTimeMs	string	LTO 模板时，优惠码过期变量	$(offerExpirationTimeMs)
Cards	object []	轮播卡片列表
CardComponents	object []	卡片控件列表
Type	string	组件类型	HEADER
Text	string	卡片文本内容	Body
Url	string	网页地址	https://aliyun.com
Format	string	Carousel 模板中 Header 的类型，只支持 IMAGE/VIDEO，所有卡片的 Header 必须一致格式 IMGAGE-图片 VIDEO-视频	HEADER
Buttons	object []	卡片按钮列表
Type	string	Carousel 模板的按钮类型取值：URL/PHONE_NUMBER/QUICK_REQLY	URL
Text	string	按钮内容	按钮文本
Url	string	点击按钮后将访问的网址	https://aliyun.com
UrlType	string	网址类型 static-静态 dynamic-动态	static
PhoneNumber	string	号码	+86138000
TemplateType	string	模板类型。 WHATSAPP VIBER LINE（开发中）	WHATSAPP
QualityScore	string	模板质量。	GREEN
MessageSendTtlSeconds	integer	Whatsapp 中 Authentication 类型模板发送消息时的消息有效期。	120
Reason	string	模板审核被拒的原因。	None
AccessDeniedDetail	string	访问被拒绝详细信息。	无

示例

正常返回示例

JSON格式

{
  "RequestId": "744c4b5c79c9432497a075bdfca3****",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "Data": {
    "Category": "UTILITY",
    "TemplateCode": "744c4b5c79c9432497a075bdfca3****",
    "Name": "hello_whatsapp",
    "Language": "en_US",
    "Example": {
      "key": "{\\\"textVariable\\\":\\\"text\\\",\\\"linkVariable\\\":\\\"https://image.developer.aliy\\\"}"
    },
    "AuditStatus": "pass",
    "Components": [
      {
        "Type": "BODY",
        "Url": "https://image.developer.aliyundoc.com",
        "Text": "你好",
        "Caption": "新文件已上传",
        "FileName": "快递文件",
        "Format": "TEXT",
        "Buttons": [
          {
            "Type": "PHONE_NUMBER",
            "Text": "打电话",
            "PhoneNumber": "861398745****",
            "Url": "https://example.com\n",
            "UrlType": "static",
            "SignatureHash": "2993839",
            "PackageName": "com.aliyun",
            "AutofillText": "Autofill",
            "IsOptOut": false,
            "ExtendAttrs": {
              "NextTemplateCode": "20939920093993",
              "NextTemplateName": "abc",
              "NextLanguageCode": "en",
              "Action": "nextCard",
              "IntentCode": "test"
            },
            "CouponCode": "202039ksjs",
            "FlowId": "3838292983",
            "FlowAction": "NAVIGATE",
            "NavigateScreen": "DETAILS"
          }
        ],
        "ThumbUrl": "https://img.png",
        "Duration": 50,
        "FileType": "docx",
        "Latitude": "28.001",
        "Longitude": "120.002",
        "LocationName": "杭州",
        "LocationAddress": "杭州",
        "AddSecretRecommendation": false,
        "CodeExpirationMinutes": 5,
        "hasExpiration": true,
        "OfferExpirationTimeMs": "$(offerExpirationTimeMs)",
        "Cards": [
          {
            "CardComponents": [
              {
                "Type": "HEADER",
                "Text": "Body",
                "Url": "https://aliyun.com",
                "Format": "HEADER",
                "Buttons": [
                  {
                    "Type": "URL",
                    "Text": "按钮文本",
                    "Url": "https://aliyun.com",
                    "UrlType": "static",
                    "PhoneNumber": "+86138000"
                  }
                ]
              }
            ]
          }
        ]
      }
    ],
    "TemplateType": "WHATSAPP",
    "QualityScore": "GREEN",
    "MessageSendTtlSeconds": 120,
    "Reason": "None"
  },
  "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-11-21