调用SendLiveMessageGroup发送消息到群组。
使用说明
调用本接口前,您必须已经调用CreateLiveMessageGroup创建互动消息群组。发送消息到群组,目标群组需要是激活状态,即当前群组中有用户已加入,才能正常往群组发送消息。如果遇到发送消息失败,请先确认当前群组中是否有用户。
QPS限制
本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | SendLiveMessageGroup | 系统规定参数。取值:SendLiveMessageGroup。 |
AppId | String | 是 | demo | 接收消息的互动消息应用ID。 |
GroupId | String | 是 | grouptest | 接收消息的GroupID。 |
SenderId | String | 是 | uid1 | 发送消息的用户ID,由大小写字母、数字组成,长度不超过64字节。 |
SenderMetaInfo | String | 否 | uid1meta1 | 发送消息用户的扩展信息,长度不超过512字节。 |
Body | String | 否 | hello,group | 消息体,长度不超过15KB。 |
MsgType | Long | 否 | 1 | 消息类型。 |
MsgTid | String | 否 | 169830**** | 消息唯一标识,可作为删除消息的依据。由大小写字母、数字组成,长度不超过64字节。 |
StaticsIncrease | Long | 否 | 1 | 该消息对于该类消息数量的统计增长值贡献,默认值为1。 |
Weight | Long | 否 | 1 | 消息权重,默认值为1。对于高优消息,可设置权重为1000000。 |
NoStorage | Boolean | 否 | false | 设置不存储该消息。默认为 false,表示存储(当前时效30天),可以通过获取查询群组消息查到该消息。如果您的业务不需要存储该消息,请设置为true。 |
NoCache | Boolean | 否 | false | 设置不缓存该消息到最近消息列表中。默认为false,表示缓存到群组最近消息列表中。 |
DataCenter | String | 否 | cn-shanghai | 数据中心,需要与CreateLiveMessageApp中的数据中心一致,当前支持上海(取值为cn-shanghai)、新加坡(取值为ap-southeast-1)。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
RequestId | String | E4C1245F-597B-1BD1-B9BB-9D220E99**** | 请求ID。 |
示例
请求示例
http(s)://live.aliyuncs.com/?Action=SendLiveMessageGroup
&AppId=demo
&GroupId=grouptest
&SenderId=uid1
&SenderMetaInfo=uid1meta1
&Body=hello,group
&MsgType=1
&MsgTid=169830****
&StaticsIncrease=1
&Weight=1
&NoStorage=false
&NoCache=false
&DataCenter=cn-shanghai
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<SendLiveMessageGroupResponse>
<RequestId>E4C1245F-597B-1BD1-B9BB-9D220E99****</RequestId>
</SendLiveMessageGroupResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "E4C1245F-597B-1BD1-B9BB-9D220E99****"
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
400 | InputInvalid | %s. | 输入参数不合法 |
403 | NoAuth | %s. | 没有权限 |
404 | ResourceNotExist | %s. | 请求资源不存在,请检查后重新尝试 |
500 | ServerError | %s. | 未知错误,请稍后重试或提交工单咨询。 |
访问错误中心查看更多错误码。