文档

CreateChatappTemplate - 创建ChatApp模板

更新时间:

创建消息模板,模板审核通过后可以发送消息。

接口说明

QPS 限制

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

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
Categorystring

Whatsapp 模板分类。取值:

  • UTILITY:交易相关。

  • MARKETING:营销性模板。

  • AUTHENTICATION:身份验证。

Viber 模板分类

  • text:纯文本

  • image:纯图片

  • text_image_button:文本 + 图片 + 按钮

  • text_button:文本 + 按钮

  • document:文件

  • video:视频

  • text_video:文本 + 视频

  • text_video_button:文本 + 视频 + 按钮

  • text_image:文本 + 图片

UTILITY
Componentsobject []

消息模板组件列表。

说明 在 Category=AUTHENTICATION 时,Components 不允许出现 Type=HEADER 的节点,并且 Type=BODY/FOOTER 时,Text 内容应该为空。
Typestring

组件类型。

  • BODY

  • HEADER

  • FOOTER

  • BUTTONS

  • CAROUSEL

  • LIMITED_TIME_OFFER

说明
  • Whatsapp 类型模板时,BODY 组件的字符长度不超度是 1024 个字符。HEADERFOOTER 组件的字符长度不超过 60 个字符。
  • Viber 类型模板时,FOOTERCAROUSELLIMITED_TIME_OFFER 类型无效。
  • Viber 类型模板中,图片、视频、文件都是放在 HEADER 中(终端将图片显示在文本之下)。
  • BODY
    Textstring

    发送消息的文本。

    说明 在 Category=AUTHENTICATION 中,此属性值为空。
    hello whatsapp
    Formatstring

    媒体资源类型。

    • TEXT:文本

    • IMAGE:图片

    • DOCUMENT:文档

    • VIDEO:视频

    TEXT
    Urlstring

    素材路径。

    说明 Viber 类型时图片建议大小:800px * 800px。
    https://image.developer.aliyundoc.com
    Captionstring

    文件的描述。

    这是一个视频
    FileNamestring

    文件的名称。

    快递视频
    Buttonsobject []

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

    说明 Whatsapp 按钮数量说明
  • Whatsapp 在类型为 MARKETING/UTILITY 时,最多允许 10 个按钮
  • PHONE_NUMBER 类型的按钮只允许存在 1 个
  • URL 类型的按钮最多允许存在 2 个
  • QUICK_REPLY 按钮不允许和 PHONE_NUMBER/URL 按钮乱序出现
  • 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

    按钮显示的名称。

    Call Me
    PhoneNumberstring

    电话号码,仅按钮类型为PHONE_NUMBER时有效。

    +861368897****
    Urlstring

    点击链接按钮将访问的网址。

    https://example.com
    UrlTypestring

    网址类型。

    • static:静态

    • dynamic:动态

    static
    SignatureHashstring

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

    wi299382
    PackageNamestring

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

    com.demo
    AutofillTextstring

    Whatsapp 模板,Category 为 AUTHENTICATION 且 Button Type 为 ONE_TAP 时必填,Whatsap Autofill 操作的按钮文本。

    Autofill
    IsOptOutboolean

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

    false
    CouponCodestring

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

    120293
    FlowIdstring

    Flow ID。

    479884093605183
    FlowActionstring

    flow 数据事件类型

    枚举值:
    • DATA_EXCHANGEDATA_EXCHANGE
    • NAVIGATENAVIGATE
    NAVIGATE
    NavigateScreenstring

    跳转屏 在 FlowAction=NAVIGATE 时必填

    DETAILS
    ThumbUrlstring

    Viber 带视频消息的缩略图。

    https://cdn.multiplymall.mobiapp.cloud/yunmall/B-LM-LMALL202207130001/20220730/d712a057-a6af-4513-bbe6-7ee57ea60983.png?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 上面显示不要将验证码信息提供给其它人的提示信息。

    true
    HasExpirationboolean

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

    true
    Cardsobject []

    Carousel 模板卡片列表。

    CardComponentsobject []

    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
    Buttonsobject []

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

    Textstring

    按钮文本。

    Call me
    Typestring

    按钮类型。

    • PHONE_NUMBER:拨打电话按钮

    • URL:网页按钮

    • QUICK_REPLY:快速回复按钮

    PHONE_NUMBER
    Urlstring

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

    https://alibaba.com/xx
    UrlTypestring

    网址类型

    • static: 静态

    • dynamic: 动态

    static
    PhoneNumberstring

    电话号码。

    +8613800
    Namestring

    模板名称。

    hello_whatsapp
    Languagestring

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

    en
    Exampleobject

    创建模板的示例。

    string

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

    {"textVariable":"text"}
    TemplateTypestring

    模板类型。

    • WHATSAPP

    • VIBER

    • LINE(开发中)

    WHATSAPP
    CustWabaIddeprecatedstring

    ISV 客户 WabaId。

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

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

    skdi3kksloslikdkkdk
    CustSpaceIdstring

    ISV 子客户的 SpaceId。

    293483938849493
    AllowCategoryChangeboolean

    是否允许 facebook 自动变更模板的目录(这样能提高模板的审核通过率)此属性只对 TemplateType=WHATSAPP 有效。

    true
    MessageSendTtlSecondsinteger

    Whatsapp 中 Authentication 模板消息发送时的有效期

    说明 此属性需要提前提供 waba 给阿里运营人员开白名单,不然会导致模板送审失败
    120

    返回参数

    名称类型描述示例值
    object

    返回数据。

    RequestIdstring

    请求 ID。

    90E63D28-E31D-1EB2-8939-A94866411B2D
    Codestring

    请求状态码。

    • 返回 OK 代表请求成功。

    • 其他错误码,请参见错误码列表

    OK
    Messagestring

    错误提示信息。

    User not authorized to operate on the specified resource.
    Dataobject

    返回数据。

    TemplateCodestring

    模板 Code。

    SMS_232907****
    TemplateNamestring

    模板名称。

    hello_whatsapp
    AccessDeniedDetailstring

    访问被拒绝详细信息。

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2D",
      "Code": "OK",
      "Message": "User not authorized to operate on the specified resource.",
      "Data": {
        "TemplateCode": "SMS_232907****",
        "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.

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

    变更历史

    变更时间变更内容概要操作
    2023-11-22OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    2023-11-21OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    2023-10-19OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    2023-08-17OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    入参OpenAPI 入参发生变更
      新增入参:MessageSendTtlSeconds
    2023-07-04OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    出参OpenAPI 返回结构发生变更
    2023-05-08OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    2023-04-13OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    入参OpenAPI 入参发生变更
      新增入参:AllowCategoryChange
    2023-03-02OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    • 本页导读 (1)