批量发送ChatApp消息。
接口说明
-
您可调用此接口批量发送消息,也可在通道管理>管理>消息发送界面手动批量发送消息。
-
在调用此接口前。请确保您已成功创建通道,且已有审核通过的模板。
-
WhatsApp 通道类型需已完成 WABA 注册及绑定、新增号码。
-
Messenger 通道类型需已完成连接公共主页账号。
-
Instagram 通道类型需已完成连接专业账户账号。
-
Viber 通道类型需已完成申请服务号。
QPS 限制
-
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
-
单次请求支持最多 1,000 个号码。
状态变更
消息发送状态可以通过 MNS/HTTP 方式监听,具体请参考回执消息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
cams:SendChatappMassMessage |
create |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ChannelType |
string |
是 |
通道类型。取值:
|
|
| TemplateCode |
string |
否 |
模板编码。在通道管理>管理>模板设计界面查看。 |
1119*************** |
| Language |
string |
是 |
语言。详细语言代码列表,请参见语言代码。 |
en |
| From |
string |
是 |
发送方号码。 |
861387777**** |
CustWabaId
deprecated
|
string |
否 |
ISV 客户 wabaId。 过时的参数,请使用 CustSpaceId,直客客户实例 ID。在通道管理>界面查看。 |
cams-8c8********* |
| FallBackId |
string |
否 |
回落策略 ID。该参数为国际站配置参数,中国站可忽略此参数。在回落策略界面查看策略 ID。 |
S0**** |
| FallBackContent |
string |
否 |
自定义回落内容。该参数为国际站配置参数,中国站可忽略此参数。 |
Fallback SMS |
| TaskId |
string |
否 |
自定义任务 ID。 |
10000**** |
| SenderList |
array<object> |
否 |
接收方号码列表。 |
|
|
array<object> |
否 |
接收方号码。 |
||
| TemplateParams |
object |
否 |
模板参数集合。 |
|
|
string |
否 |
模板参数。Key-Value 格式,Key 为参数名称,Value 为参数取值。 |
{ "param1": "value1", "param2": "value2" } |
|
| FlowAction |
object |
否 |
Flow 消息对象。 |
|
| FlowActionData |
object |
否 |
flow 默认参数集合。 |
|
|
any |
否 |
flow 默认参数。Key-Value 格式,Key 为参数名称,Value 为参数取值。 |
{ "name": "name" } |
|
| FlowToken |
string |
否 |
自定义 flow token 信息。 |
kde**** |
| Payload |
array |
否 |
按钮的触发消息标识列表。 |
|
|
string |
否 |
按钮的触发消息。 |
payloadtext |
|
| To |
string |
否 |
接收方号码。
|
861386666**** |
| ProductAction |
object |
否 |
商品信息,此参数只针对于 whatsapp 类型通道。即为您在 Meta 上上传的商品信息。 |
|
| ThumbnailProductRetailerId |
string |
否 |
商品目录 ID。可通过 ListProductCatalog 接口获取。 |
skkks99**** |
| Sections |
array |
否 |
商品分类列表(最多可以有 10 个分类,30 个商品)。 |
|
|
array<object> |
否 |
商品分类。 |
||
| Title |
string |
否 |
分类名称。在通道管理>管理>目录管理>商品管理界面查看或通过 ListProduct 接口获取。 |
abcd |
| ProductItems |
array |
否 |
商品信息列表。 |
|
|
object |
否 |
商品信息。 |
||
| ProductRetailerId |
string |
否 |
商品 ID。在通道管理>管理>目录管理>商品管理界面查看或通过 ListProduct 接口获取。 |
ksi3**** |
IsvCode
deprecated
|
string |
否 |
ISV 校验码,用于校验子账号是否由 ISV 授权,已弃用,可忽略此参数。 |
skdi3kksloslikd**** |
| CustSpaceId |
string |
否 |
ISV 子客户的 SpaceId ,直客客户实例 ID。在通道管理界面查看。 |
cams-8c8********* |
| Ttl |
integer |
否 |
Viber 消息发送超时时间。此参数为国际站参数,中国站可忽略此参数。单位:秒,取值范围 30~1209600。 |
46 |
| Label |
string |
否 |
Viber 消息类型,此参数为国际站参数,中国站可忽略此参数。 取值:
|
promotion |
| Tag |
string |
否 |
标签信息,Viber 消息发送时自定义标签信息。 |
Tag |
| FallBackDuration |
integer |
否 |
回落触发时间。此参数为国际站参数,中国站可忽略此参数。消息在指定时间内没有返回已到达回执消息时进行回落, 不填代表不根据此时间判断回落,只有发送失败和有失败的状态报告时才会回落。单位:秒。最小值:60,最大值:43200。 |
120 |
| FallBackRule |
string |
否 |
回落规则。此参数为国际站参数,中国站可忽略此参数。 取值:
|
undelivered |
| TemplateName |
string |
否 |
模板名称。在通道管理>管理>模板设计界面查看模板名称。 |
test_name |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回数据。 |
||
| AccessDeniedDetail |
string |
访问被拒绝详细信息。 |
None |
| RequestId |
string |
请求 ID。 |
90E63D28-E31D-1EB2-8939-A9486641**** |
| Message |
string |
错误提示信息。 |
User not authorized to operate on the specified resource. |
| GroupMessageId |
string |
批量消息 ID。 |
890000010002**** |
| Code |
string |
请求状态码。
|
OK |
示例
正常返回示例
JSON格式
{
"AccessDeniedDetail": "None",
"RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
"Message": "User not authorized to operate on the specified resource.",
"GroupMessageId": "890000010002****",
"Code": "OK"
}
错误码
|
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. | 资源不属于当前用户。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。