修改消息模板。只能修改未审核以及审核不通过的模板。
接口说明
QPS 限制
本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。
状态变更
模板的状态和质量变更可以通过 MNS/HTTP 方式监听，具体请参考回执消息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
cams:ModifyChatappTemplate |
update |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Components |
array<object> |
是 |
消息模板组件列表。 说明
在 Category 为 AUTHENTICATION 时，Components 不允许出现 Type 为 HEADER 的节点，并且 Type 为 BODY/FOOTER 时，Text 内容为空，会自动生成内容。 |
|
|
array<object> |
否 |
消息模板组件。 |
||
| HasExpiration |
boolean |
否 |
LTO 模板中，是否有过期时间" |
true |
| ThumbUrl |
string |
否 |
Viber 带视频消息的缩略图 |
https://img.png |
| FileName |
string |
否 |
文件名称，当 Type 为 Header，且 Format 为 DOCUMENT 时可以给文件指定名称 |
txt.txt |
| Text |
string |
否 |
所发送消息的文本 |
IMAGE |
| Duration |
integer |
否 |
Viber 视频消息的视频时长，取值范围 0 - 600 |
|
| Url |
string |
否 |
素材路径 |
https://img.png |
| Caption |
string |
否 |
描述，当 Type 为 Header，且 Format 为 IMGAGE/DOCUMENT/VIDEO 可以增加描述 |
test |
| AddSecretRecommendation |
boolean |
否 |
Whatsapp 类型模板，Category 为 Authentication，并且 Component Type 为 Body 时有效，表示在 Body 上面显示不要将验证码信息提供给其它人的提示信息 |
false |
| Type |
string |
是 |
组件类型\n 值：BODY、HEADER、FOOTER 和 BUTTONS |
HEADER |
| Format |
string |
否 |
格式\nTEXT-文本 IMGAGE-图片 DOCUMENT-文档 VIDEO-视频 |
body |
| CodeExpirationMinutes |
integer |
否 |
Whatsapp Authentication 模板验证码有效期（分钟），只在 Whatsapp 类型消息，Category 为 Authentication 并且 Component Type 为 Footer 时有效（此信息显示在 Footer 位置） |
10 |
| FileType |
string |
否 |
Viber 文件消息的文件类型 |
txt |
| Buttons |
array<object> |
否 |
按钮列表，仅适用于 BUTTONS 组件。 说明
Whatsapp 按钮数量说明
|
|
|
array<object> |
否 |
按钮 |
||
| AutofillText |
string |
否 |
Whatsapp 模板，Category 为 Authentication，并且 Button Type 为 ONE_TAP 时必填，Whatsap Autofill 操作的按钮文本 |
Autofill |
| PackageName |
string |
否 |
Whatsapp 模板，Category 为 Authentication，并且 Button Type 为 ONE_TAP/ZERO_TAP，表示 Whatsapp 调起应用的包名 |
com.aliyun.pack.*** |
| Text |
string |
否 |
所发送消息的文本 |
CTA |
| Url |
string |
否 |
点击按钮后将访问的网址 |
https://aliyun.com |
| FlowId |
string |
否 |
Flow id |
293882 |
| Type |
string |
是 |
按钮类型\nPHONE_NUMBER（电话）,URL（网页按钮）和 QUICK_REPLY（快速回复） |
URL |
| CouponCode |
string |
否 |
优惠券码 |
23838jdjdj |
| IsOptOut |
boolean |
否 |
Whatsapp 模板，在 Category 为 Marketing,并且 Button type 为 QUICK_REPLY 时有效，表示按钮为营销退订按钮，客户如果点击了此按钮，并且在 chatapp 平台上配置了发送控制操作，则后续 Marketing 消息则不会发送到客户 |
false |
| FlowAction |
string |
否 |
flow 数据事件类型\n 取值范围：NAVIGATE/DATA_EXCHANGE |
NAVIGATE |
| SignatureHash |
string |
否 |
Whatsapp 模板，Category 为 Authentication，并且 Button Type 为 ONE_TAP/ZERO_TAP，表示 Whatsapp 调起应用的签名 Hash 值 |
kdikie9398k |
| NavigateScreen |
string |
否 |
跳转屏 \n 在 FlowAction=NAVIGATE 时必填 |
SIGN_UP |
| PhoneNumber |
string |
否 |
号码 |
8613800** |
| SupportedApps |
array<object> |
否 |
验证码 ONE_TAP/ZERO_TAP 支持的应用 |
|
|
object |
否 |
验证码 ONE_TAP/ZERO_TAP 支持的应用 |
||
| SignatureHash |
string |
否 |
Whatsapp 模板，Category 为 Authentication，并且 Button Type 为 ONE_TAP/ZERO_TAP，表示 Whatsapp 调起应用的签名 Hash 值 |
kdikie9398k |
| PackageName |
string |
否 |
Whatsapp 模板，Category 为 Authentication，并且 Button Type 为 ONE_TAP/ZERO_TAP，表示 Whatsapp 调起应用的包名 |
com.aliyun.pack.*** |
| UrlType |
string |
否 |
网址类型 static-静态 dynamic-动态 |
static |
| Cards |
array<object> |
否 |
Carousel 模板卡片列表。 |
|
|
array<object> |
否 |
Carousel 模板卡片。 |
||
| CardComponents |
array<object> |
是 |
Carousel 卡片中的控件列表 |
|
|
array<object> |
否 |
Carousel 卡片中的控件列表 |
||
| Type |
string |
是 |
组件类型\n 值：BODY、HEADER 和 BUTTONS |
HEADER |
| Format |
string |
否 |
Carousel 模板中 Header 的类型，只支持 IMAGE/VIDEO，所有卡片的 Header 必须一致\n 格式\n IMGAGE-图片 VIDEO-视频 |
IMAGE |
| Text |
string |
否 |
Carousel 轮播卡片中 Body 的内容 |
body |
| Buttons |
array<object> |
否 |
Carousel 卡片中的按钮，所有卡片中的按钮类型、名称、顺序必须一致,每个卡片最多有 2 个按钮 |
|
|
object |
否 |
Carousel 卡片中的按钮，所有卡片中的按钮类型、名称、顺序必须一致,每个卡片最多有 2 个按钮 |
||
| Type |
string |
是 |
Carousel 模板的按钮类型\n 取值：URL/PHONE_NUMBER/QUICK_REQLY |
URL |
| PhoneNumber |
string |
否 |
号码 |
8613800** |
| Text |
string |
否 |
按钮内容 |
text |
| UrlType |
string |
否 |
网址类型 static-静态 dynamic-动态 |
static |
| Url |
string |
否 |
点击按钮后将访问的网址 |
https://aliyun.com/image.png |
| Url |
string |
否 |
Header，图片或视频的路径 |
https://aliyun.com/image.png |
| Language |
string |
是 |
语言 |
en |
| Example |
object |
否 |
变量，KEY-VALUE 结构 |
|
|
string |
否 |
|||
| CustWabaId |
string |
否 |
ISV 客户 WabaId, 后续会被弃用，请使用 CustSpaceId |
939*** |
IsvCode
deprecated
|
string |
否 |
Isv 校验码，用于校验子帐号是否由 ISV 授权 |
9393*** |
| TemplateCode |
string |
否 |
消息模板编码 |
93938** |
| CustSpaceId |
string |
否 |
ISV 子客户的 SpaceId/直客的 instanceId |
cams-did*** |
| Category |
string |
否 |
Viber 修改模板时，可以修改模板 Category(Whatsapp 修改时此参数无效） |
MARKETING |
| TemplateType |
string |
否 |
修改模板的模板类型，取值为 WHATSAPP/VIBER， 当未传递此值时，默认值为 WHATSAPP |
|
| MessageSendTtlSeconds |
integer |
否 |
Whatsapp 中 Authentication 模板消息发送有效期 |
120 |
| TemplateName |
string |
否 |
模板名称 |
test_name |
| CategoryChangePaused |
boolean |
否 |
Utility 类型模板变更为 Marketing 类型时，模板暂停发送 |
true |
| ProductSetId |
string |
否 |
productSetId |
939*** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回数据。 |
||
| RequestId |
string |
请求 ID。 |
90E63D28-E31D-1EB2-8939-A9486641**** |
| Code |
string |
请求状态码。
|
OK |
| Message |
string |
错误提示信息。 |
None |
| Data |
object |
返回数据。 |
|
| TemplateCode |
string |
模板 Code。 |
8472929283883 |
| TemplateName |
string |
模板名称。 |
hello_whatsapp |
| AccessDeniedDetail |
string |
访问被拒绝详细信息。 |
None |
| Success |
boolean |
请求是否成功。 |
true |
示例
正常返回示例
JSON格式
{
"RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
"Code": "OK",
"Message": "None",
"Data": {
"TemplateCode": "8472929283883",
"TemplateName": "hello_whatsapp"
},
"AccessDeniedDetail": "None",
"Success": true
}错误码
|
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. | 资源不属于当前用户。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。