创建模板

post

https://api.ycloud.com/v2/whatsapp/templates

创建WhatsApp模板。

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

👍
For more specific request examples, seeWhatsApp Template Creation Examples.

👍
Configure Webhooks to keep track of template status updates. See also WhatsApp Template Reviewed Webhook Examples.

Body Params

请参阅WhatsApp模板。

wabaId

string

required

WhatsApp业务账户ID。

name

string

required

length ≤ 512

[a-z0-9]{1,512}

模板名称。

language

string

required

模板的语言代码。请参阅Supported Languages了解所有代码。

category

string

enum

required

WhatsApp模板的类别。

AUTHENTICATION：使企业能够使用一次性密码对用户进行身份验证，可能在登录过程的多个步骤中（例如，账户验证、账户恢复、完整性挑战）。
MARKETING：包括促销或优惠、信息更新或邀请客户回应/采取行动。任何不符合实用或认证资格的对话都是营销对话。
UTILITY：促进特定的、商定的请求或交易，或向客户更新正在进行的交易，包括购买后通知和定期账单声明。

Allowed:

subCategory

string

enum

WhatsApp模板的子类别。

ORDER_STATUS：订单状态模板被归类为UTILITY模板，除了选择的名称和语言外，它还具有通用模板组件，如BODY、FOOTER，另外还有ORDER_STATUS子类别。

Allowed:

messageSendTtlSeconds

int32

如果我们无法在超过其生存时间的时间内传递消息，我们将停止重试并丢弃消息。
默认情况下，使用认证模板的消息默认TTL为10分钟，使用实用或营销模板的消息默认TTL为30天。
对于认证模板，将其值设置在30到900秒之间（即30秒到15分钟），对于实用模板，设置在30到43200秒之间（即30秒到12小时），对于营销模板，设置在43200到2592000秒之间（即12小时到30天）。或者，您可以将此值设置为-1，这将为任一类型的模板设置30天的自定义TTL。
我们建议您为所有认证模板设置生存时间，最好等于或小于您的代码过期时间，以确保您的客户只在代码仍然可用时才收到消息。
2024年10月23日之前创建的认证模板默认TTL为30天。

components

array of objects

required

components*

ctaUrlLinkTrackingOptedOut

boolean

可选。
表示是否禁用模板按钮点击跟踪。设置为true以禁用模板上的按钮点击跟踪，或设置为false以启用。
您可以通过将此字段设置为true来禁用单个模板上的按钮点击跟踪。一旦禁用，在查看模板洞察时，按钮参与/点击将不会在WhatsApp管理器中显示。
如果未提供，此值默认为false，这意味着按钮点击跟踪默认启用。

Response

200成功创建WhatsApp模板。