即时通信 IM
有奖捉虫：行业应用 & 管理与支持文档专题 HOT
文档中心 > 即时通信 IM > 服务端 API > REST API > 消息相关 > 发送消息 > 直播群广播消息

直播群广播消息

最近更新时间：2023-12-12 15:56:22

我的收藏

本页目录：

功能说明

App 管理员可以通过该接口向所有直播群下发广播消息。
注意
直播群广播消息功能支持需要终端 SDK 6.5.2803 增强版及以上版本、Web SDK v2.21.0及以上版本，需 购买旗舰版套餐包 并在 控制台 > 群功能配置 > 群功能配置 > 直播群广播消息 打开开关后方可使用。

接口调用说明

适用的群组类型

群组类型 ID
支持此 REST API
Private
不支持，同新版本中的 Work（好友工作群）
Public
不支持
ChatRoom
不支持，同新版本中的 Meeting（临时会议群）
AVChatRoom
支持，发给所有直播群
Community（社群）
不支持
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。

请求 URL 示例

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

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参考 REST API 简介。
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名：
中国：console.tim.qq.com
新加坡：adminapisgp.im.qcloud.com
首尔： adminapikr.im.qcloud.com
法兰克福：adminapiger.im.qcloud.com
孟买：adminapiind.im.qcloud.com
硅谷：adminapiusa.im.qcloud.com
雅加达：adminapiidn.im.qcloud.com
v4/group_open_http_svc/send_broadcast_msg
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

1次/秒。

请求包示例

基础形式
用来向所有直播群下发广播消息。
{
    "From_Account": "test",  // 指定消息发送者（选填）
    "Random":8912345,  // 随机数字，五分钟数字相同认为是重复消息
    "MsgBody": [ 
        {
            "MsgType": "TIMCustomElem",  // 自定义消息
            "MsgContent": {
                "Data": "{ \\"type\\":1, \\"content\\":\\"hello world\\"}"
            }
        }
    ],
    "CloudCustomData": "your cloud custom data"
}
注意
MsgBody 支持多个消息元素，如果1次/秒不够用，业务端可以做消息合并处理，合并消息大小不超过12K字节

请求包字段说明

字段
类型
属性
说明
From_Account
String
选填
消息来源账号，选填。如果不填写该字段，则默认消息的发送者为调用该接口时使用的 App 管理员账号。除此之外，App 亦可通过该字段“伪造”消息的发送者，从而实现一些特殊的功能需求。需要注意的是，如果指定该字段，必须要确保字段中的账号是存在的
Random
Integer
必填
无符号32位整数。如果5分钟内两条消息的内容和 Random 随机值都相同的情况下，后一条消息将被当做重复消息而丢弃
MsgBody
Array
必填
消息体，详细可参阅 消息格式描述
CloudCustomData
String
选填
消息自定义数据

应答包体示例

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

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果：
OK：表示处理成功
FAIL：表示失败
ErrorCode
Integer
错误码：
0：表示成功
非0：表示失败
ErrorInfo
String
错误信息
MsgSeq
Integer
消息序列号，唯一标示一条消息

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。 公共错误码（60000到79999）参见 错误码 文档。 本 API 私有错误码如下：
错误码
描述
10002
服务器内部错误，请重试
10003
请求命令字非法
10004
参数非法，请根据错误描述检查请求是否正确
10007
操作权限不足，例如：控制台开关没打开 或者 操作账号不是 root 账号
10023
发消息的频率超限，请延长两次发消息时间的间隔

接口调试工具

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

参考

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

中国站