发送消息到群组。
接口说明
调用本接口前,您必须已经调用 CreateLiveMessageGroup 创建互动消息群组。发送消息到群组,目标群组需要是激活状态,即当前群组中有用户已加入,才能正常往群组发送消息。不支持离线消息,如果遇到发送消息失败,请先确认当前群组中是否有用户。若需离线发送,建议将先消息存在本地,待用户上线后重新发送。
QPS 限制
本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
live:SendLiveMessageGroup |
none |
*Rtc
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
AppId |
string |
是 |
接收消息的互动消息应用 ID。 |
demo |
GroupId |
string |
是 |
接收消息的 GroupId。 说明
请确保传入的 GroupId 是存在的!否则会返回 ResourceNotExist 错误。 |
grouptest |
SenderId |
string |
是 |
发送消息的用户 ID,由大小写字母、数字组成,长度不超过 64 字节。 |
uid1 |
SenderMetaInfo |
string |
否 |
发送消息用户的扩展信息,长度不超过 512 字节。 |
uid1meta1 |
Body |
string |
否 |
消息体,长度不超过 15KB。 |
hello,group |
MsgType |
integer |
否 |
消息类型,单群内发送消息的总类型数不超过 30 种。 |
1 |
MsgTid |
string |
否 |
消息唯一标识,可作为删除消息的依据。由大小写字母、数字组成,长度不超过 64 字节。 |
169830**** |
StaticsIncrease |
integer |
否 |
该消息对于该类消息数量的统计增长值贡献,默认值为 1。 |
1 |
Weight |
integer |
否 |
消息权重,默认值为 1。
|
1 |
NoStorage |
boolean |
否 |
设置不存储该消息。默认为 false,表示存储(当前时效 30 天),可以通过获取查询群组消息查到该消息。如果您的业务不需要存储该消息,请设置为 true。 |
false |
NoCache |
boolean |
否 |
设置不缓存该消息到最近消息列表中。默认为 false,表示缓存到群组最近消息列表中。 |
false |
DataCenter |
string |
否 |
数据中心,需要与 CreateLiveMessageApp 中的数据中心一致,当前支持上海(取值为 cn-shanghai)、新加坡(取值为 ap-southeast-1)。 |
cn-shanghai |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
返回参数。 |
||
RequestId |
string |
请求 ID。 |
E4C1245F-597B-1BD1-B9BB-9D220E99**** |
MsgTid |
string |
消息唯一标识,可作为删除消息的依据。由大小写字母、数字组成,长度不超过 64 字节。 |
169830**** |
示例
正常返回示例
JSON
格式
{
"RequestId": "E4C1245F-597B-1BD1-B9BB-9D220E99****",
"MsgTid": "169830****"
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | InputInvalid | %s. | 输入参数不合法 |
400 | ErrorTooManyMsgTypes | %s. | |
500 | ServerError | %s. | 未知错误,请稍后重试或提交工单咨询。 |
403 | NoAuth | %s. | 没有权限 |
404 | ResourceNotExist | %s. | 请求资源不存在,请检查后重新尝试 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。