批量发送群聊/直播群消息 BatchSendGroupMessage--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

批量发送群聊/直播群消息 BatchSendGroupMessage

最近更新时间：2025.07.30 12:18:24首次发布时间：2025.07.30 11:27:13

你可以使用此接口批量在群聊或直播群中发送消息。

使用说明

接口行为

你可以调用 BatchSendGroupMessage 接口，指定你所属的 AppId 和发送者 UserId、会话类型、会话 ID、消息类型和消息内容，向多个相同类型会话同时发送消息。
该接口会触发“消息发送后”回调，但不会触发“消息发送前”回调。
发送消息前不会检查发送方是否禁言，也不会检查会话是否开启禁言。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。

注意事项

QPS 不得超过 5。
每次请求限制会话数量为 20。
每次请求限制会话类型必须一致。

请求说明

请求方式：POST
请求地址：https://rtc.volcengineapi.com?Action=BatchSendGroupMessage&Version=2020-12-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`BatchSendGroupMessage`	接口名称。当前 API 的名称为 `BatchSendGroupMessage`。
Version	String	是	`2020-12-01`	接口版本。当前 API 的版本为 `2020-12-01`。

Body

参数	类型	是否必选	示例值	描述
AppId	Integer	是	`000000`	应用的唯一标志
Sender	Long	是	`000001`	消息发送人 UserId
ConversationType	Integer	是	`100`	会话类型
ConversationShortIds	Array of Long	是	`[000001,000002,000003]`	会话 ID 列表，长度不能超过 20，且会话类型必须与 `ConversationType` 一致
MsgType	Integer	是	`10001`	消息类型
Content	String	是	`Your_Content`	消息内容。当你给客户端发消息时，`Content` 内容需符合客户端格式，详细信息请参看消息格式。
MentionedUsers	Array of Long	否	`[111111,222222]`	会话中@的人
VisibleUsers	Array of Long	否	`[111111]`	消息可见会话成员列表
InvisibleUsers	Array of Long	否	`[111111]`	消息不可见会话成员列表。VisibleUsers 和 InvisibleUsers均为空时，代表对所有人可见。
Ext	JSON Map	否	`{"key":"value"}`	消息的扩展字段，key 的数据类型为 String，value 的数据类型为 String。
ClientMsgId	String	否	`"unique-key"`	幂等id，如果创建时指定了此字段，并且数据库中存在此 id 对应的消息，不会重复发送。如果不指定，会随机生成一个。
CreateTime	Long	否	`1666613688658`	消息对应时间戳，单位为毫秒。
Priority	Integer	否	`1`	消息优先级。 `0`：低优先级。 `1`：普通优先级。 `2`：高优先级。该字段仅对直播群有效。为避免直播群中消息频率太高导致服务端压力过大，你可以设置消息的优先级。一个直播群内，普通优先级和低优先级消息共用频控阈值为 30 条/秒，高优消息频控阈值为 10 条/秒，会优先保证高优消息到达，若消息被限频，接口会返回`SendMessageFrequent`错误码。此频次限制适用于在单个直播群内发消息的场景。

返回参数

下表仅列出本接口特有的返回参数，公共返回参数请参见返回结构。

参数	类型	示例值	描述
ConversationMessageId	JSON Map		会话对应的消息 ID
FailedInfos	Array of FailedInfos		发送失败的会话信息

FailedInfos

参数	类型	示例值	描述
ConversationShortId	Long	`000001`	发送失败的会话 ID
FailedCode	String	`ConversationNotFound`	失败错误码
FailedReason	String	`conversation not found`	失败原因

请求示例

POST https://rtc.volcengineapi.com?Action=BatchSendGroupMessage&Version=2020-12-01
{
    "AppId": 000000,
    "Sender": 000001,
    "ConversationType": 100,
    "ConversationShortIds": [
        000001,
        000002
    ],
    "MsgType": 10001,
    "Content": "Your_Content",
    "ClientMsgId": "unique-message-id-123",
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202507291320251****40B471018567399",
        "Action": "BatchSendGroupMessage",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "ConversationMessageId": {
            "000001": 100001,
            "000002": 100002
        },
        "FailedInfos": []
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。