调用ModifyChatappTemplate修改ChatApp模板_Chat App 消息服务(Chat App)-阿里云帮助中心

修改消息模板。只能修改未审核以及审核不通过的模板。

接口说明

QPS 限制

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
Components	object []	是	消息模板组件列表。说明在 Category 为 AUTHENTICATION 时，Components 不允许出现 Type 为 HEADER 的节点，并且 Type 为 BODY/FOOTER 时，Text 内容为空，会自动生成内容。
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
Text	string	否	所发送消息的文本。说明在 Category=AUTHENTICATION 中，此属性值为空。	hello chatapp
Format	string	否	媒体资源类型。 TEXT: 文本 IMAGE: 图片 DOCUMENT: 文档 VIDEO: 视频	TEXT
Url	string	否	素材路径。	https://img.tukuppt.com/png_preview/00/10/24/1GygxVK3F4.jpg
Caption	string	否	描述。说明当 Type 为 HEADER，且 Format 为IMAGE/DOCUMENT/VIDEO时可以增加描述。	这是一个视频
FileName	string	否	文件名称。说明当 Type 为 HEADER，且 Format 为 DOCUMENT 时为文件指定文件名称。	视频
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	否	按钮文本。	phone-button-text
PhoneNumber	string	否	号码。	+8613888887889
Url	string	否	点击按钮后将访问的网址。	https://www.website.com/
UrlType	string	否	网址类型。 static：静态 dynamic：动态	dynamic
SignatureHash	string	否	Whatsapp 模板，Category 为 AUTHENTICATION 且 Button Type 为 ONE_TAP 时必填，表示 Whatsapp 调起应用的签名 Hash 值。	29dkeke
PackageName	string	否	Whatsapp 模板，Category 为 AUTHENTICATION 且 Button Type 为 ONE_TAP 时必填，表示 Whatsapp 调起应用的包名。	com.demo
AutofillText	string	否	Whatsapp 模板，Category 为 AUTHENTICATION 且 Button Type 为 ONE_TAP 时必填，Whatsap Autofill 操作的按钮文本。	Autofill
IsOptOut	boolean	否	Whatsapp 模板，在 Category 为 Marketing 且 Button type 为 QUICK_REPLY 时有效，表示按钮为营销退订按钮，客户如果点击了此按钮，并且在 ChatApp 已配置发送控制操作，则后续 Marketing 消息则不会发送到客户。	false
CouponCode	string	否	优惠码值，只支持字母+数字，可以传入变量如$(couponCode)，在发送时再传入优惠码	120293
FlowId	string	否	Flow ID。	664597077870605
FlowAction	string	否	flow 数据事件类型枚举值： DATA_EXCHANGE：DATA_EXCHANGE。 NAVIGATE：NAVIGATE。	NAVIGATE
NavigateScreen	string	否	跳转屏在 FlowAction=NAVIGATE 时必填	DETAILS
ThumbUrl	string	否	Viber 带视频消息的缩略图。	https://cdn.multiplymall.mobiapp.cloud/cloudcode/yc-165407506207478-165511576113195/20220905/ec5b9737-1507-4208-bb27-8da3958da961.jpg?x-oss-process=image/resize,w_100
Duration	integer	否	Viber 视频消息的视频时长，取值范围：0~600。	120
FileType	string	否	Viber 文件消息的文件类型。	docx
CodeExpirationMinutes	integer	否	Whatsapp AUTHENTICATION 模板验证码有效期（分钟），只在 Whatsapp 类型消息，Category 为 AUTHENTICATION 并且 Component Type 为 Footer 时有效（此信息显示在 Footer 位置）。	5
AddSecretRecommendation	boolean	否	Whatsapp 类型模板，Category 为 AUTHENTICATION 且 Component Type 为 Body 时有效，表示在 Body 上面显示不要将验证码信息提供给其它人的提示信息。	false
HasExpiration	boolean	否	优惠码是否存在过期时间，在 type = LIMITED_TIME_OFFER 时使用。	true
Cards	object []	否	Carousel 模板卡片列表
CardComponents	object []	是	Carousel 卡片中控件列表
Type	string	是	组件类型。取值： BODY HEADER BUTTONS	BODY
Format	string	否	媒体资源类型，在 Type = HEADER 时有效 IMAGE: 图片 VIDEO: 视频	IMAGE
Text	string	否	Carousel 卡片中 BODY 的内容	Who is the very powerful team
Url	string	否	素材路径。	https://alibaba.com/img.png
Buttons	object []	否	按钮列表，仅适用于 BUTTONS 组件。Carousel 每个卡片最多只能有两个按钮。
Text	string	否	按钮文本。	Call me
Type	string	是	按钮类型。 PHONE_NUMBER：拨打电话按钮 URL：网页按钮 QUICK_REPLY：快速回复按钮	PHONE_NUMBER
Url	string	否	点击按钮后将访问的网址。	https://alibaba.com/xx
UrlType	string	否	网址类型。 static：静态 dynamic：动态	static
PhoneNumber	string	否	电话号码。	+8613800
Language	string	是	模板语言。详细语言代码，请参见语言代码。	en
Example	object	否	创建模板的示例。
	string	否	变量例子。通过把 JSON 结构转成 String 的方式传入。	{"textVariable":"text"}
CustWabaId`deprecated`	string	否	ISV 客户 WabaId。说明过时的参数，请使用 CustSpaceId。	659216218162179
IsvCode	string	否	Isv 校验码，用于校验子账号是否由 ISV 授权。	ksiekdki39ksks93939
TemplateCode	string	是	消息模板编码。	8472929283883
CustSpaceId	string	否	ISV 子客户的 SpaceId。	28251486512358****
Category	string	否	Viber 模板分类 text：纯文本 image：纯图片 text_image_button：文本 + 图片 + 按钮 text_button：文本 + 按钮 document：文件 video：视频 text_video：文本 + 视频 text_video_button：文本 + 视频 + 按钮 text_image：文本 + 图片说明此属性只对 Viber 类型模板有效。	text
TemplateType	string	否	模板类型。 WHATSAPP VIBER LINE（开发中）	WHATSAPP
MessageSendTtlSeconds	integer	否	Whatsapp 中 Authentication 模板消息发送有效期说明此属性需要提前提供 waba 给阿里运营人员开白名单，不然会导致模板送审失败	120

返回参数

名称	类型	描述	示例值
	object	返回数据。
RequestId	string	请求 ID。	90E63D28-E31D-1EB2-8939-A9486641****
Code	string	请求状态码。返回 OK 代表请求成功。其他错误码，请参见错误码列表。	OK
Message	string	错误提示信息。	无
Data	object	返回数据。
TemplateCode	string	模板 Code。	8472929283883
TemplateName	string	模板名称。	hello_whatsapp
AccessDeniedDetail	string	访问被拒绝详细信息。	无

示例

正常返回示例

JSON格式

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "无",
  "Data": {
    "TemplateCode": "8472929283883",
    "TemplateName": "hello_whatsapp"
  },
  "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-22

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400

2023-11-21

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400

2023-10-19

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400

2023-08-17

OpenAPI 错误码发生变更、OpenAPI 入参发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
入参	OpenAPI 入参发生变更。
	新增入参：MessageSendTtlSeconds

2023-07-04

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

看变更集

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

2023-05-08

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400

2023-03-02

OpenAPI 错误码发生变更、OpenAPI 入参发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
入参	OpenAPI 入参发生变更。
	新增入参：Category
	新增入参：TemplateType

2022-09-29

新增 OpenAPI

看变更集