SendLiveMessageGroup - 发送消息到群组

更新时间:2025-04-07 03:23

发送消息到群组。

接口说明

调用本接口前,您必须已经调用 CreateLiveMessageGroup 创建互动消息群组。发送消息到群组,目标群组需要是激活状态,即当前群组中有用户已加入,才能正常往群组发送消息。不支持离线消息,如果遇到发送消息失败,请先确认当前群组中是否有用户。若需离线发送,建议将先消息存在本地,待用户上线后重新发送。

QPS 限制

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
操作访问级别资源类型条件关键字关联操作
live:SendLiveMessageGroupnone
*Rtc
acs:live::{#accountId}:rtc/{#AppId}

请求参数

名称类型必填描述示例值
名称类型必填描述示例值
AppIdstring

接收消息的互动消息应用 ID。

demo
GroupIdstring

接收消息的 GroupId。

说明
请确保传入的 GroupId 是存在的!否则会返回 ResourceNotExist 错误。
grouptest
SenderIdstring

发送消息的用户 ID,由大小写字母、数字组成,长度不超过 64 字节。

uid1
SenderMetaInfostring

发送消息用户的扩展信息,长度不超过 512 字节。

uid1meta1
Bodystring

消息体,长度不超过 15KB。

hello,group
MsgTypelong

消息类型。

1
MsgTidstring

消息唯一标识,可作为删除消息的依据。由大小写字母、数字组成,长度不超过 64 字节。

169830****
StaticsIncreaselong

该消息对于该类消息数量的统计增长值贡献,默认值为 1。

1
Weightlong

消息权重,默认值为 1。对于高优消息,可设置权重为 1000000。

1
NoStorageboolean

设置不存储该消息。默认为 false,表示存储(当前时效 30 天),可以通过获取查询群组消息查到该消息。如果您的业务不需要存储该消息,请设置为 true。

false
NoCacheboolean

设置不缓存该消息到最近消息列表中。默认为 false,表示缓存到群组最近消息列表中。

false
DataCenterstring

数据中心,需要与 CreateLiveMessageApp 中的数据中心一致,当前支持上海(取值为 cn-shanghai)、新加坡(取值为 ap-southeast-1)。

cn-shanghai

返回参数

名称类型描述示例值
名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

E4C1245F-597B-1BD1-B9BB-9D220E99****
MsgTidstring

消息唯一标识,可作为删除消息的依据。由大小写字母、数字组成,长度不超过 64 字节。

169830****

示例

正常返回示例

JSON格式

{
  "RequestId": "E4C1245F-597B-1BD1-B9BB-9D220E99****",
  "MsgTid": "169830****"
}

错误码

HTTP status code错误码错误信息描述
HTTP status code错误码错误信息描述
400InputInvalid%s.输入参数不合法
403NoAuth%s.没有权限
404ResourceNotExist%s.请求资源不存在,请检查后重新尝试
500ServerError%s.未知错误,请稍后重试或提交工单咨询。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
变更时间变更内容概要操作
2025-01-23OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2025-01-13OpenAPI 错误码发生变更查看变更详情
2024-01-09OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2023-12-13OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
  • 本页导读 (1)
  • 接口说明
  • QPS 限制
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
  • 变更历史
文档反馈