tencent cloud

功能说明

App 管理员可以通过该接口向所有直播群下发广播消息。

注意：

直播群广播消息功能支持需要终端 SDK 6.5.2803 增强版及以上版本、Web SDK v2.21.0及以上版本，需 购买旗舰版 并在 控制台>群功能配置>群功能配置>直播群广播消息 打开开关后方可使用。

接口调用说明

适用的群组类型

即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。

请求 URL 示例

https://xxxxxx/v4/group_open_http_svc/send_broadcast_msg?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参考 REST API 简介。

最高调用频率

1次/秒。

请求包示例

• 基础形式

用来向所有直播群下发广播消息。

{
    "From_Account": "test",  // 指定消息发送者（选填）
    "Random":8912345,  // 随机数字，五分钟数字相同认为是重复消息
    "MsgBody": [ 
        {
            "MsgType": "TIMCustomElem",  // 自定义消息
            "MsgContent": {
                "Data": "{ \"type\":1, \"content\":\"hello world\"}"
            }
        }
    ],
    "CloudCustomData": "your cloud custom data"
}

注意：

MsgBody 支持多个消息元素，如果1次/秒不够用，业务端可以做消息合并处理，合并消息大小不超过12K字节

请求包字段说明

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "MsgSeq": 1283
}

应答包字段说明

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：

接口调试工具

通过 REST API 在线调试工具 调试本接口。

参考

• 在群组中发送普通消息（v4/group_open_http_svc/send_group_msg）
• 消息格式描述