文档

SendChatappMassMessage - 批量发送ChatApp消息

更新时间:

批量发送ChatApp消息。

接口说明

QPS 限制

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

单次请求支持最多 1,000 个号码。

状态变更

消息发送状态可以通过 MNS/HTTP 方式监听,具体请参考回执消息

调试

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

授权信息

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

请求参数

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

通道类型。取值:

  • whatsapp
  • viber
  • line(开发中)。
whatsapp
TemplateCodestring

模板编码。

744c4b5c79c9432497a075bdfca3****
Languagestring

语言。详细语言代码列表,请参见语言代码

en
Fromstring

发送方号码。

861387777****
CustWabaIddeprecatedstring

ISV 客户 wabaId。

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

回落策略 ID。

说明 中国站此字段无效。
S0****
FallBackContentstring

回落内容。

说明 中国站此字段无效。
回落短信
TaskIdstring

任务 ID。

10000****
SenderListarray<object>

接收方号码列表。

object

接收方号码列表。

Tostring

接收方号码。

861388988****
TemplateParamsobject

模板参数。

string

模板参数。

{"param1":"value1","param2":"value2"}
Payloadarray

按钮的触发消息标识。

string

按钮的触发消息。

["payloadtext1","payloadtext2","payloadtext3"]
ProductActionobject

商品信息。

ThumbnailProductRetailerIdstring

商品 RetailerId。

skkks99****
Sectionsarray<object>

商品列表(最多可以有 10 个分类,30 个商品)。

object

商品分类。

Titlestring

分类名称。

abcd
ProductItemsarray<object>

商品列表。

object

商品信息。

ProductRetailerIdstring

商品 RetailerId。

ksi3****
FlowActionobject

Flow 消息对象。

FlowTokenstring

flow token 信息。

kde****
FlowActionDataobject

flow 默认参数。

string

flow 默认参数。

{"name":"name"}
IsvCodestring

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

skdi3kksloslikd****
CustSpaceIdstring

子账户空间 ID。

28251486512358****
Ttllong

Viber 消息发送超时时间,单位:秒,取值范围 30~1209600。

50
Labelstring

Viber 消息类型,取值:

  • pormotion
  • transaction
promotion
Tagstring

Viber 消息发送时 tag 信息。

tag
FallBackDurationinteger

消息在指定时间内没有返回已到达回执时回落, 不填代表不根据此时间判断回落,只有发送失败和有失败的状态报告时才会回落。时间单位为秒 最小值为 60,最大值 43200。

说明 中国站此字段无效。
120
FallBackRulestring

回落规则。取值:

  • undelivered:消息不能发送到端时回落(在发送状态时模板、参数需要校验通过,模板被封、号码被封等不做校验)。参数值为空时默认使用此规则。
  • sentFailed:消息在校验模板、模板变量等参数时,校验不通过也会回落。只会强校验 channelType, type, messageType, to, from(是否存在) 几个参数。
说明 中国站此字段无效。
undelivered
TemplateNamestring

模板名称。

test_name

返回参数

名称类型描述示例值
object

返回数据。

RequestIdstring

请求 ID。

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

请求状态码。

  • 返回 OK 代表请求成功。

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

OK
Messagestring

错误提示信息。

User not authorized to operate on the specified resource.
GroupMessageIdstring

批量消息 ID。

890000010002****
AccessDeniedDetailstring

访问被拒绝详细信息。

示例

正常返回示例

JSON格式

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "GroupMessageId": "890000010002****",
  "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-04-10OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2024-03-14OpenAPI 错误码发生变更查看变更详情
2023-11-21OpenAPI 错误码发生变更查看变更详情
2023-09-21OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2023-08-01OpenAPI 错误码发生变更查看变更详情
2023-07-04OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-04-13OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2022-11-17OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2022-09-30OpenAPI 错误码发生变更查看变更详情
2022-08-18新增 OpenAPI查看变更详情