服务端 API v2
  • API概览
  • 调用方式
  • 房间信令接口
  • 混流接口
  • 媒体服务接口
  • 媒体文件接口
  • 音视频流审核接口
  • 回调说明
  • 全局返回码
  • 调测指南

推送广播消息接口

更新时间:2021-10-25 17:43

1 描述

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

客户端接收消息使用 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 用户名。
MessageCategory Int 消息分类。
  • 1:系统消息。
  • 2:聊天消息。
一般为聊天消息。
MessageContent String 消息内容,长度不能超过 1024 个字节。

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 返回码

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

返回码 说明
50001 房间不存在。
  • 当房间内没有用户时,房间会被 SDK 自动销毁。
  • 当房间内只有一个用户时,该用户退出房间或被踢出房间,房间会被 SDK 自动销毁。
  • 当房间心跳请求超时 100 秒后,房间会被 SDK 自动销毁。
50002 用户账号不存在。
50003 查找用户在线信息失败。
50004 读取用户信息失败。
50009 审核失败。
50011 推送自定义消息目的用户个数超过限制。
50012 推送自定义消息长度超过限制。
50013 发送自定义消息失败。