调用SendLiveMessageGroup发送消息到群组。
接口说明
使用说明
调用本接口前,您必须已经调用 CreateLiveMessageGroup 创建互动消息群组。发送消息到群组,目标群组需要是激活状态,即当前群组中有用户已加入,才能正常往群组发送消息。如果遇到发送消息失败,请先确认当前群组中是否有用户。
QPS 限制
本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
live:SendLiveMessageGroup | none |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 是 | 接收消息的互动消息应用 ID。 | demo |
GroupId | string | 是 | 接收消息的 GroupID。 | grouptest |
SenderId | string | 是 | 发送消息的用户 ID,由大小写字母、数字组成,长度不超过 64 字节。 | uid1 |
SenderMetaInfo | string | 否 | 发送消息用户的扩展信息,长度不超过 512 字节。 | uid1meta1 |
Body | string | 否 | 消息体,长度不超过 15KB。 | hello,group |
MsgType | long | 否 | 消息类型。 | 1 |
MsgTid | string | 否 | 消息唯一标识,可作为删除消息的依据。由大小写字母、数字组成,长度不超过 64 字节。 | 169830**** |
StaticsIncrease | long | 否 | 该消息对于该类消息数量的统计增长值贡献,默认值为 1。 | 1 |
Weight | long | 否 | 消息权重,默认值为 1。对于高优消息,可设置权重为 1000000。 | 1 |
NoStorage | boolean | 否 | 设置不存储该消息。默认为 false,表示存储(当前时效 30 天),可以通过获取查询群组消息查到该消息。如果您的业务不需要存储该消息,请设置为 true。 | false |
NoCache | boolean | 否 | 设置不缓存该消息到最近消息列表中。默认为 false,表示缓存到群组最近消息列表中。 | false |
DataCenter | string | 否 | 数据中心,需要与 CreateLiveMessageApp 中的数据中心一致,当前支持上海(取值为 cn-shanghai)、新加坡(取值为 ap-southeast-1)。 | cn-shanghai |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "E4C1245F-597B-1BD1-B9BB-9D220E99****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InputInvalid | %s. | 输入参数不合法 |
403 | NoAuth | %s. | 没有权限 |
404 | ResourceNotExist | %s. | 请求资源不存在,请检查后重新尝试 |
500 | ServerError | %s. | 未知错误,请稍后重试或提交工单咨询。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-01-09 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-12-13 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |