AI 助理
备案控制台
文档
输入文档关键字查找
首页 Chat App 消息服务 开发参考 API参考 API目录 模板管理 ModifyChatappTemplate - 修改ChatApp模板

ModifyChatappTemplate - 修改ChatApp模板

更新时间：
产品详情
我的收藏

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

接口说明

QPS 限制

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

状态变更

模板的状态和质量变更可以通过 MNS/HTTP 方式监听，具体请参考回执消息。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
Componentsarray<object>是

消息模板组件列表。

说明 在 Category 为 AUTHENTICATION 时，Components 不允许出现 Type 为 HEADER 的节点，并且 Type 为 BODY/FOOTER 时，Text 内容为空，会自动生成内容。
object是

消息模板组件。

Typestring是

组件类型。

  • BODY

  • HEADER

  • FOOTER

  • BUTTONS

  • CAROUSEL

  • LIMITED_TIME_OFFER

说明
  • Whatsapp 类型模板时，BODY 组件的字符长度不超度是 1024 个字符。HEADER 和 FOOTER 组件的字符长度不超过 60 个字符。
  • Viber 类型模板时，FOOTER，CAROUSEL，LIMITED_TIME_OFFER 类型无效。
  • Viber 类型模板中，图片、视频、文件都是放在 HEADER 中（终端将图片显示在文本之下）。
    •
    		BODY
    Textstring否

    所发送消息的文本。

    说明 在 Category=AUTHENTICATION 中，此属性值为空。
    		hello chatapp
    Formatstring否

    媒体资源类型。

    • TEXT: 文本

    • IMAGE: 图片

    • DOCUMENT: 文档

    • VIDEO: 视频

    		TEXT
    Urlstring否

    素材路径。

    		https://img.****.com/png_preview/00/10/24/1GygxVK3F4.jpg
    Captionstring否

    描述。

    说明 当 Type 为 HEADER，且 Format 为IMAGE/DOCUMENT/VIDEO时可以增加描述。
    		这是一个视频
    FileNamestring否

    文件名称。

    说明 当 Type 为 HEADER，且 Format 为 DOCUMENT 时为文件指定文件名称。
    		视频
    Buttonsarray<object>否

    按钮列表，仅适用于 BUTTONS 组件。

    说明 Whatsapp 按钮数量说明
  • Whatsapp 在类型为 MARKETING/UTILITY 时，最多允许 10 个按钮
  • PHONE_NUMBER 类型的按钮只允许存在 1 个
  • URL 类型的按钮最多允许存在 2 个
  • QUICK_REPLY 按钮不允许和 PHONE_NUMBER/URL 按钮乱序出现
    •
    object否

    按钮定义。

    Typestring是

    按钮类型。

    • 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
    Textstring否

    按钮文本。

    		phone-button-text
    PhoneNumberstring否

    号码。

    		+861388888****
    Urlstring否

    点击按钮后将访问的网址。

    		https://www.website.com/***
    UrlTypestring否

    网址类型。

    • static：静态

    • dynamic：动态

    		dynamic
    SignatureHashdeprecatedstring否

    WhatsApp 模板，Category 为 AUTHENTICATION 且 Button Type 为 ONE_TAP/ZERO_TAP 时必填，表示 Whatsapp 调起应用的签名 Hash 值。

    		29dkeke
    PackageNamedeprecatedstring否

    WhatsApp 模板，Category 为 AUTHENTICATION 且 Button Type 为 ONE_TAP/ZERO_TAP 时必填，表示 Whatsapp 调起应用的包名。

    		com.demo
    AutofillTextstring否

    WhatsApp 模板，Category 为 AUTHENTICATION 且 Button Type 为 ONE_TAP/ZERO_TAP 时必填，Whatsap Autofill 操作的按钮文本。

    		Autofill
    IsOptOutboolean否

    WhatsApp 模板，在 Category 为 Marketing 且 Button type 为 QUICK_REPLY 时有效，表示按钮为营销退订按钮，客户如果点击了此按钮，并且在 ChatApp 已配置发送控制操作，则后续 Marketing 消息则不会发送到客户。

    		false
    CouponCodestring否

    优惠码值，只支持字母+数字，可以传入变量如$(couponCode)，在发送时再传入优惠码。

    		120293
    FlowIdstring否

    Flow ID。

    		664597077870605
    FlowActionstring否

    Flow 数据事件类型。取值：

    • DATA_EXCHANGE：数据交换。

    • NAVIGATE：导航。

    		NAVIGATE
    NavigateScreenstring否

    跳转屏，在 FlowAction=NAVIGATE 时必填。

    		DETAILS
    SupportedAppsarray<object>否

    支持的 APP 列表。

    object否

    支持的 APP 列表。

    SignatureHashstring否

    Whatsapp 模板，Category 为 AUTHENTICATION 且 Button Type 为 ONE_TAP/ZERO_TAP 时必填，表示 Whatsapp 调起应用的签名 Hash 值。

    		fk39kd93ks9
    PackageNamestring否

    Whatsapp 模板，Category 为 AUTHENTICATION 且 Button Type 为 ONE_TAP/ZERO_TAP 时必填，表示 Whatsapp 调起应用的包名。

    		com.example.myapplication
    ThumbUrlstring否

    Viber 带视频消息的缩略图。

    		https://cdn.multiplymall.mobiapp.cloud/cloudcode/yc-165407506207478-165511576113195/20220905/ec5b9737-1507-4208-bb27-8da3958da961.jpg?x-oss-process=image/resize,w_100
    Durationinteger否

    Viber 视频消息的视频时长，取值范围：0~600。

    		120
    FileTypestring否

    Viber 文件消息的文件类型。

    		docx
    CodeExpirationMinutesinteger否

    Whatsapp AUTHENTICATION 模板验证码有效期（分钟），只在 Whatsapp 类型消息，Category 为 AUTHENTICATION 并且 Component Type 为 Footer 时有效（此信息显示在 Footer 位置）。

    		5
    AddSecretRecommendationboolean否

    Whatsapp 类型模板，Category 为 AUTHENTICATION 且 Component Type 为 Body 时有效，表示在 Body 上面显示不要将验证码信息提供给其它人的提示信息。

    		false
    HasExpirationboolean否

    优惠码是否存在过期时间，在 type = LIMITED_TIME_OFFER 时使用。

    		true
    Cardsarray<object>否

    Carousel 模板卡片列表。

    object否

    Carousel 模板卡片列表。

    CardComponentsarray<object>是

    Carousel 卡片中控件列表

    object否

    Carousel 卡片中控件列表。

    Typestring是

    组件类型。取值：

    • BODY

    • HEADER

    • BUTTONS

    		BODY
    Formatstring否

    媒体资源类型，在 Type = HEADER 时有效

    • IMAGE: 图片

    • VIDEO: 视频

    		IMAGE
    Textstring否

    Carousel 卡片中 BODY 的内容

    		Who is the very powerful team
    Urlstring否

    素材路径。

    		https://alibaba.com/****/img.png
    Buttonsarray<object>否

    按钮列表，仅适用于 BUTTONS 组件。Carousel 每个卡片最多只能有两个按钮。

    object否

    按钮对象。

    Textstring否

    按钮文本。

    		Call me
    Typestring是

    按钮类型。

    • PHONE_NUMBER：拨打电话按钮

    • URL：网页按钮

    • QUICK_REPLY：快速回复按钮

    		PHONE_NUMBER
    Urlstring否

    点击按钮后将访问的网址。

    		https://alibaba.com/xx
    UrlTypestring否

    网址类型。

    • static：静态

    • dynamic：动态

    		static
    PhoneNumberstring否

    电话号码。

    		+861368893****
    Languagestring是

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

    		en
    Exampleobject否

    创建模板的示例。

    string否

    变量例子。通过把 JSON 结构转成 String 的方式传入。

    		{"textVariable":"text"}
    CustWabaIddeprecatedstring否

    ISV 客户 WabaId。

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

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

    		ksiekdki39ksks93939
    TemplateCodestring否

    消息模板编码。

    		8472929283883
    CustSpaceIdstring否

    ISV 子客户的 SpaceId。

    		28251486512358****
    Categorystring否

    Viber 模板分类

    • text：纯文本

    • image：纯图片

    • text_image_button：文本 + 图片 + 按钮

    • text_button：文本 + 按钮

    • document： 文件

    • video：视频

    • text_video：文本 + 视频

    • text_video_button：文本 + 视频 + 按钮

    • text_image：文本 + 图片

    说明 此属性只对 Viber 类型模板有效。
    		text
    TemplateTypestring否

    模板类型。

    • WHATSAPP

    • VIBER

    		WHATSAPP
    MessageSendTtlSecondsinteger否

    WhatsApp 中模板消息发送时的有效期。

    • AUTHENTICATION 取值范围为 30 - 900
    • UTILITY 取值范围为 30 - 43200
    		120
    TemplateNamestring否

    模板名称。

    		test_name

    返回参数

    名称类型描述示例值
    object

    返回数据。

    RequestIdstring

    请求 ID。

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

    请求状态码。

    • 返回 OK 代表请求成功。

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

    		OK
    Messagestring

    错误提示信息。

    		无
    Dataobject

    返回数据。

    TemplateCodestring

    模板 Code。

    		8472929283883
    TemplateNamestring

    模板名称。

    		hello_whatsapp
    AccessDeniedDetailstring

    访问被拒绝详细信息。

    		无

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "无",
  "Data": {
    "TemplateCode": "8472929283883",
    "TemplateName": "hello_whatsapp"
  },
  "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.资源不属于当前用户。

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

    变更历史

    变更时间变更内容概要操作
    2024-12-02OpenAPI 错误码发生变更查看变更详情
    2024-06-21OpenAPI 错误码发生变更查看变更详情
    2024-04-10OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
    2023-11-22OpenAPI 错误码发生变更查看变更详情
    2023-11-21OpenAPI 错误码发生变更查看变更详情
    2023-10-19OpenAPI 错误码发生变更查看变更详情
    2023-08-17OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
    2023-07-04OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2023-05-08OpenAPI 错误码发生变更查看变更详情
    2023-03-02OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
    2022-09-29新增 OpenAPI查看变更详情
    上一篇：模板管理下一篇：CreateChatappTemplate - 创建ChatApp模板
    文档推荐