批量发送ChatApp消息。
接口说明
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
单次请求支持最多 1,000 个号码。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ChannelType | string | 是 | 通道类型 whatsapp/viber/line | |
TemplateCode | string | 是 | 模板编码 | 744c4b5c79c9432497a075bdfca36bf5 |
Language | string | 是 | 语言。详细语言代码列表,请参见语言代码。 | en |
From | string | 是 | 发送方 | 861387777**** |
CustWabaIddeprecated | string | 否 | ISV 客户 wabaId 说明
过时的参数,请使用 CustSpaceId
| 65921621816**** |
FallBackId | string | 否 | 回落策略 ID 说明
中国站此字段无效
| S00001 |
FallBackContent | string | 否 | 回落内容 说明
中国站此字段无效
| 回落短信 |
TaskId | string | 否 | 任务 ID | 100000001 |
SenderList | object [] | 是 | 发送号码列表 | |
To | string | 是 | 发送号码 | 861388988**** |
TemplateParams | object | 否 | 模板参数 | |
string | 否 | 模板参数 | {"param1":"value1","param2":"value2"} | |
Payload | array | 否 | payload | |
string | 否 | payload | ["payloadtext1","payloadtext2","payloadtext3"] | |
ProductAction | object | 否 | 商品信息 | |
ThumbnailProductRetailerId | string | 否 | 商品 RetailerId | skkks999393 |
Sections | object [] | 否 | 商品列表(最多可以有 10 个分类,30 个商品) | |
Title | string | 否 | 分类名称 | abcd |
ProductItems | object [] | 否 | 商品列表 | |
ProductRetailerId | string | 否 | 商品 RetailerId | ksi399d8 |
FlowAction | object | 否 | Flow 消息对象 | |
FlowToken | string | 否 | flow token 信息 | kde99d8 |
FlowActionData | object | 否 | flow 默认参数 | |
string | 否 | flow 默认参数 | {"name":"name"} | |
IsvCode | string | 否 | ISV 校验码,用于校验子账号是否由 ISV 授权。 | skdi3kksloslikdkkdk |
CustSpaceId | string | 否 | 子账户空间 ID。 | 28251486512358**** |
Ttl | long | 否 | Viber 消息发送超时时间,单位:秒,取值范围 30~1209600。 | 50 |
Label | string | 否 | Viber 消息类型,取值:pormotion 或 transaction。 | promotion |
Tag | string | 否 | Viber 消息发送时 tag 信息。 | tag |
FallBackDuration | integer | 否 | 消息在指定时间内没有返回已到达回执时回落, 不填代表不根据此时间判断回落,只有发送失败和有失败的状态报告时才会回落。时间单位为秒 最小值为 60,最大值 43200 说明
中国站此字段无效
| 120 |
FallBackRule | string | 否 | 回落规则。 说明
取值范围
说明
中国站此字段无效
| undelivered |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 |
---|---|---|
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. |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2024-03-14 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-11-21 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-09-21 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-08-01 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-07-04 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-04-13 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||
| ||||||||||
2022-11-17 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||
| ||||||||||
2022-09-30 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2022-08-18 | 新增 OpenAPI | 看变更集 |