提交工单
咨询集成、功能及报价等问题
发送房间消息,推送给房间内的所有在线用户。
调用频率限制:10 次/秒。
客户端将通过 ZIM SDK 的回调接口,接收房间内的消息通知。
平台 | 接口 |
---|---|
iOS/macOS |
zim:receiveRoomMessage:fromRoomID: |
Android |
onReceiveRoomMessage |
Windows |
onReceiveRoomMessage |
Web/小程序 |
receiveRoomMessage |
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
FromUserId |
String |
是 |
发送方的用户 ID。 |
RoomId |
String |
是 |
房间 ID。 |
MessageType |
Number |
是 |
消息类型,取值如下:
|
Priority |
Number |
是 |
消息优先级,取值如下:
|
MessageBody |
Object |
是 |
消息内容。 |
└ Message |
String |
是 |
文本消息内容,默认为 2 KB;最大为 32 KB,如有需要请联系 ZEGO 技术支持配置。 |
└ ExtendedData |
String |
否 |
扩展字段。 |
FromUserId、RoomId 仅支持数字,英文字符和 '!','#','$','%','&','(',')','+','-',':',';','<','=','.','>','?','@','[',']','^','_',' ','{','}','|','~'。
请求地址 URL:
https://zim-api.zego.im/?Action=SendRoomMessage
&<公共请求参数>
请求消息体:
{
"FromUserId": "u1",
"RoomId": "r1",
"MessageType": 1,
"Priority": 1,
"MessageBody": {
"Message":"hello world",
"ExtendedData":"d"
}
}
参数 | 类型 | 描述 |
---|---|---|
Code |
Number |
返回码。 |
Message |
String |
请求结果的说明信息。 |
RequestId |
String |
请求 ID。 |
{
"Code":0,
"Message":"success",
"RequestId":"343649807833778782"
}
以下仅列出了接口业务逻辑相关的返回码,完整返回码请参考 全局返回码。
返回码 | 说明 | 处理建议 |
---|---|---|
660300001 |
输入的 RoomId 不存在。 |
请确认输入的 RoomId 是否正确。 |
660400001 |
输入的消息大小超出限制。 |
请检查输入的消息大小。 |
660500002 |
消息发送者未登录过 SDK。 |
请用户先登录后再发送消息。 |
联系我们
文档反馈