服务端 API v2
  • API概览
  • 快速开始
  • 调用方式
  • 房间信令接口
  • 混流接口
  • 媒体服务接口
  • 媒体文件接口
  • 音视频流审核接口
  • 场景服务接口
  • 回调说明
  • 全局返回码
  • 使用 Postman 调试

推送广播消息接口

更新时间:2022-11-14 10:34

1 描述

调用本接口在房间内推送广播消息,即向同一房间内所有用户发送文本消息。

  • 当房间人数小于 500 人时,向同一房间内所有用户发送广播消息,房间内所有用户基本都能收到消息.
  • 当房间人数超过 500 人后,该房间升级为大房间,此时,广播消息将不再可靠,且就算房间人数再次小于 500 人了,房间内的广播消息也仍然不再可靠。

客户端接收消息使用 ZEGO SDK 回调接口:

ZegoExpress SDK LiveRoom SDK
iOS/macOS onIMRecvBroadcastMessage onRecvRoomMessage
Android onIMRecvBroadcastMessage onRecvRoomMessage
Windows onIMRecvBroadcastMessage OnRecvRoomMessage
Web IMRecvBroadcastMessage onRecvRoomMsg

2 接口原型

  • 请求方法:GET
  • 请求地址:https://rtc-api.zego.im/?Action=SendBroadcastMessage
  • 传输协议:HTTPS
  • 调用频率限制(同一个 AppID 下所有房间):100 次/秒(测试环境:10 次/秒)

3 请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数

参数 类型 是否必选 描述
RoomId
String
房间 ID。
UserId
String
发送方用户 ID(该用户不会接收消息,无需登录房间)。
UserName
String
发送方用户名(与 UserId 一一对应)。
MessageCategory
Int
消息分类。
  • 1:系统消息。
  • 2:聊天消息。
一般为聊天消息。
MessageContent
String
消息内容,长度不能超过 1024 个字节。

使用时,请对该参数内容进行 UrlEncode。

用户客户端如果使用上述 UserId 登录房间,而服务端使用该 UserId 发送请求时,会导致该客户端无法收到服务端消息。

4 请求示例

https://rtc-api.zego.im/?Action=SendBroadcastMessage
&RoomId=123
&UserId=2323
&UserName=345
&MessageCategory=1
&MessageContent=hello+zego+big+im+-+%E5%B9%BF%E6%92%AD%E6%B6%88%E6%81%AF
&<公共请求参数>

5 响应参数

参数 类型 描述
Code
Number
返回码。
Message
String
操作结果描述。
RequestId
String
请求 ID。
Data
Object
响应数据。
└ MessageId
Number
消息 ID。

6 响应示例

{
    "Code":0,
    "Data":{
        "MessageId":3
    },
    "Message":"success",
    "RequestId":"619831198646468496"
}

7 返回码

以下仅列出了常见的接口业务逻辑相关的返回码,完整返回码请参考 全局返回码

返回码 说明 处理建议
121 保存广播消息失败。 -
122 生成 message ID 失败。 请重试,或联系 ZEGO 技术支持处理。
151 推送广播消息失败。 请重试,或联系 ZEGO 技术支持处理。
5201 广播消息编码失败。 请重试,或联系 ZEGO 技术支持处理。
5202 生成 message ID 失败。 请重试,或联系 ZEGO 技术支持处理。
50012 消息长度超过限制。 请检查参数长度是否超过限制。