调用SendChatappMassMessage批量发送ChatApp消息_Chat App 消息服务(Chat App)-阿里云帮助中心

批量发送ChatApp消息。

接口说明

QPS 限制

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

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

状态变更

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
cams:SendChatappMassMessage	create	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
ChannelType	string	是	通道类型。取值： whatsapp。 viber。 line（开发中）。	whatsapp
TemplateCode	string	否	模板编码。	744c4b5c79c9432497a075bdfca3****
Language	string	是	语言。详细语言代码列表，请参见语言代码。	en
From	string	是	发送方号码。	861387777****
CustWabaId`deprecated`	string	否	ISV 客户 wabaId。说明过时的参数，请使用 CustSpaceId。	65921621816****
FallBackId	string	否	回落策略 ID。说明中国站此字段无效。	S0****
FallBackContent	string	否	回落内容。说明中国站此字段无效。	回落短信
TaskId	string	否	任务 ID。	10000****
SenderList	array<object>	是	接收方号码列表。
	object	是	接收方号码列表。
To	string	是	接收方号码。	861388988****
TemplateParams	object	否	模板参数。
	string	否	模板参数。	{"param1":"value1","param2":"value2"}
Payload	array	否	按钮的触发消息标识。
	string	否	按钮的触发消息。	["payloadtext1","payloadtext2","payloadtext3"]
ProductAction	object	否	商品信息。
ThumbnailProductRetailerId	string	否	商品 RetailerId。	skkks99****
Sections	array<object>	否	商品列表（最多可以有 10 个分类，30 个商品）。
	object	否	商品分类。
Title	string	否	分类名称。	abcd
ProductItems	array<object>	否	商品列表。
	object	否	商品信息。
ProductRetailerId	string	否	商品 RetailerId。	ksi3****
FlowAction	object	否	Flow 消息对象。
FlowToken	string	否	flow token 信息。	kde****
FlowActionData	object	否	flow 默认参数。
	string	否	flow 默认参数。	{"name":"name"}
IsvCode	string	否	ISV 校验码，用于校验子账号是否由 ISV 授权。	skdi3kksloslikd****
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：消息不能发送到端时回落（在发送状态时模板、参数需要校验通过，模板被封、号码被封等不做校验）。参数值为空时默认使用此规则。 sentFailed：消息在校验模板、模板变量等参数时，校验不通过也会回落。只会强校验 channelType, type, messageType, to, from(是否存在) 几个参数。说明中国站此字段无效。	undelivered
TemplateName	string	否	模板名称。	test_name

返回参数

名称	类型	描述	示例值
	object	返回数据。
RequestId	string	请求 ID。	90E63D28-E31D-1EB2-8939-A9486641****
Code	string	请求状态码。返回 OK 代表请求成功。其他错误码，请参见错误码列表。	OK
Message	string	错误提示信息。	User not authorized to operate on the specified resource.
GroupMessageId	string	批量消息 ID。	890000010002****
AccessDeniedDetail	string	访问被拒绝详细信息。	无

示例

正常返回示例

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-04-10	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
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	查看变更详情