发送房间消息

更新时间：2022-04-02 11:46

1 描述

发送房间消息，推送给房间内的所有在线用户。

调用频率限制：10 次/秒。

客户端将通过 ZIM SDK 的回调接口，接收房间内的消息通知。

平台	接口
iOS/macOS	zim:receiveRoomMessage:fromRoomID:
Android	onReceiveRoomMessage
Windows	onReceiveRoomMessage
Web/小程序	receiveRoomMessage

2 接口原型

请求方法：POST
请求地址：https://zim-api.zego.im/?Action=SendRoomMessage
传输协议：HTTPS

3 请求参数

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

参数	类型	是否必选	描述
FromUserId	String	是	发送方的用户 ID。
RoomId	String	是	房间 ID。
MessageType	Number	是	消息类型，取值如下： 1：文本消息。 2：Command 消息，即信令消息（Command 消息不存储，不保证可靠）。
Priority	Number	是	消息优先级，取值如下： 1：低。 2：中。 3：高。
MessageBody	Object	是	消息内容。
└ Message	String	是	文本消息内容，默认为 2 KB；最大为 32 KB，如有需要请联系 ZEGO 技术支持配置。
└ ExtendedData	String	否	扩展字段。

FromUserId、RoomId 仅支持数字，英文字符和 '!'，'#'，'$'，'%'，'&'，'('，')'，'+'，'-'，':'，';'，'<'，'='，'.'，'>'，'?'，'@'，'['，']'，'^'，'_'，' '，'{'，'}'，'|'，'~'。

4 请求示例

请求地址 URL：

https://zim-api.zego.im/?Action=SendRoomMessage
&<公共请求参数>

请求消息体：

{
"FromUserId": "u1",
"RoomId": "r1",
"MessageType": 1,
"Priority": 1,
    "MessageBody": {
        "Message":"hello world",
        "ExtendedData":"d"
    }
}

5 响应参数

参数	类型	描述
Code	Number	返回码。
Message	String	请求结果的说明信息。
RequestId	String	请求 ID。

6 响应示例

{
    "Code":0,
    "Message":"success",
    "RequestId":"343649807833778782"
}

7 返回码

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

返回码	说明	处理建议
660300001	输入的 RoomId 不存在。	请确认输入的 RoomId 是否正确。
660400001	输入的消息大小超出限制。	请检查输入的消息大小。
660500002	消息发送者未登录过 SDK。	请用户先登录后再发送消息。

云通讯产品

低代码互动产品

Meta 元宇宙

扩展服务

Meta 元宇宙

社交娱乐

电商直播

在线教育

医疗健康

互动游戏

协同办公

物联网