提交工单
咨询集成、功能及报价等问题
调用本接口在房间内推送广播消息,即向同一房间内所有用户发送文本消息。
客户端接收消息使用 ZEGO SDK 回调接口:
ZegoExpress SDK | LiveRoom SDK | |
---|---|---|
iOS/macOS | onIMRecvBroadcastMessage | onRecvRoomMessage |
Android | onIMRecvBroadcastMessage | onRecvRoomMessage |
Windows | onIMRecvBroadcastMessage | OnRecvRoomMessage |
Web | IMRecvBroadcastMessage | onRecvRoomMsg |
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
RoomId |
String |
是 |
房间 ID。 |
UserId |
String |
是 |
发送方用户 ID(该用户不会接收消息,无需登录房间)。 |
UserName |
String |
否 |
发送方用户名(与 UserId 一一对应)。 |
MessageCategory |
Int |
是 |
消息分类。
|
MessageContent |
String |
是 |
消息内容,长度不能超过 1024 个字节。 使用时,请对该参数内容进行 UrlEncode。 |
用户客户端如果使用上述 UserId 登录房间,而服务端使用该 UserId 发送请求时,会导致该客户端无法收到服务端消息。
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
&<公共请求参数>
参数 | 类型 | 描述 |
---|---|---|
Code |
Number |
返回码。 |
Message |
String |
操作结果描述。 |
RequestId |
String |
请求 ID。 |
Data |
Object |
响应数据。 |
└ MessageId |
Number |
消息 ID。 |
{
"Code":0,
"Data":{
"MessageId":3
},
"Message":"success",
"RequestId":"619831198646468496"
}
以下仅列出了接口业务逻辑相关的返回码,完整返回码请参考 全局返回码。
返回码 | 说明 | 处理建议 |
---|---|---|
104 | 房间不存在,与 5024、50001 内部判断逻辑相同。 | 请确认请求房间 RoomId 是否存在。 |
206 | App 请求 QPS 过高被限制。 | 降低请求频率,或联系 ZEGO 技术支持提高 QPS 限制阈值。 |
5018 | 房间状态不一致。 | 请稍后重试。 |
5024 | 房间不存在,与 104、50001 内部判断逻辑相同。 | 请确认请求房间 RoomId 是否存在。 |
50001 | 房间不存在,与 104、5024 内部判断逻辑相同。
|
请确认请求房间 RoomId 是否存在。 |
50002 | 用户账号不存在。 | 请确认请求用户 UserId 是否在线。 |
50003 | 查找用户在线信息失败。 | 请确认请求用户 UserId 是否在线。 |
50004 | 读取用户信息失败。 | 请确认请求用户 UserId 是否在线。 |
50009 | 审核失败。 | 请稍后重试,或 ZEGO 联系技术支持。 |
50011 | 推送自定义消息目的用户个数超过限制。 | 请检查请求包中的用户个数是否超过限制。 |
50012 | 推送自定义消息长度超过限制。 | 请检查消息长度是否超过限制。 |
50013 | 发送自定义消息失败。 | 请联系 ZEGO 技术支持处理。 |
联系我们
文档反馈