AI 助理
备案控制台
文档
输入文档关键字查找
首页 Chat App 消息服务 操作指南 可用通道 WhatsApp WhatsApp相关API 创建WhatsApp消息模板

创建WhatsApp消息模板

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

接口说明

QPS 限制

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

调试

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

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

  • 对于必选的资源类型，用背景高亮的方式表示。

  • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cams:CreateChatappTemplate

Write

  • 全部资源*

无

无

请求参数

名称

类型

必填

描述

示例值

Category

string

是

Whatsapp 模板分类。取值：

  • UTILITY：交易相关。

  • MARKETING：营销性模板。

  • AUTHENTICATION：身份验证。

UTILITY

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个字符。

BODY

Text

string

否

发送消息的文本。

说明

在Category=AUTHENTICATION中，此属性值为空。

hello

Format

string

否

媒体资源类型。

  • TEXT：文本

  • IMAGE：图片

  • DOCUMENT：文档

  • VIDEO：视频

TEXT

Url

string

否

素材路径。

说明

素材大小需符合要求，具体参数参见媒体支持类型及大小限制

https://image.developer.aliyundoc.com

Caption

string

否

文件的描述。

这是一个视频

FileName

string

否

文件的名称。

快递视频

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 模板时回填按钮

  • CATALOG：商品目录按钮

  • MPM：多商品按钮

  • Flow：WhatsApp Flow按钮

  • ZERO_TAP：零点击身份验证按钮

说明

Whatsapp 类型模板且 Category 为 AUTHENTICATION 时，按钮只允许存在一个，并且类型只能是 COPY_CODE/ONE_TAP, 当类型选择 COPY_CODE 时，Text 为必填。当类型选择 ONE_TAP 时，Text（在终端没有装目标应用时显示，表示采用复制验证码按钮的名称）必填，SignatureHash, PackageName, AutofillText 属性必填。

PHONE_NUMBER

Text

string

否

按钮显示的名称。

Call Me

PhoneNumber

string

否

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

+861368897****

Url

string

否

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

https://example.com

UrlType

string

否

网址类型。

  • static：静态

  • dynamic：动态

static

SignatureHash

string

否

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

wi299382

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 时有效，表示按钮为营销退订按钮，客户如果点击了此按钮，并且在 Chat App 已配置了发送控制操作，则后续 Marketing 消息则不会发送到客户。

false

CouponCode

string

否

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

120293

FlowId

string

否

WhatsApp Flow ID。

479884093605183

FlowAction

string

否

WhatsApp Flow 数据事件类型

枚举值：

  • DATA_EXCHANGE：DATA_EXCHANGE。

  • NAVIGATE：NAVIGATE。

NAVIGATE

NavigateScreen

string

否

跳转屏。

在 FlowAction=NAVIGATE 时必填

DETAILS

CodeExpirationMinutes

integer

否

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

5

AddSecretRecommendation

boolean

否

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

true

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

Name

string

是

模板名称。

hello_whatsapp

Language

string

是

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

en

Example

object

否

创建模板的示例。

string

否

变量例子。

通过把 JSON 结构转成 String 的方式传入。

{"textVariable":"text"}

TemplateType

string

是

模板类型。

WHATSAPP

WHATSAPP

CustSpaceId

string

否

ISV 子客户的 SpaceId。

293483938849493

AllowCategoryChange

boolean

否

是否允许 facebook 自动变更模板的目录（这样能提高模板的审核通过率）

true

MessageSendTtlSeconds

integer

否

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

说明

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

120

返回参数

名称

类型

描述

示例值

object

返回数据。

RequestId

string

请求 ID。

90E63D28-E31D-1EB2-8939-A94866411B2D

Code

string

请求状态码。

  • 返回 OK 代表请求成功。

  • 其他错误码，请参见API错误码。

OK

Message

string

错误提示信息。

User not authorized to operate on the specified resource.

Data

object

返回数据。

TemplateCode

string

模板 Code。

SMS_232907****

TemplateName

string

模板名称。

hello_world

AccessDeniedDetail

string

访问被拒绝详细信息。

无

示例

正常返回示例

JSON格式

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

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

上一篇：WhatsApp相关API下一篇：修改WhatsApp消息模板
文档推荐