网易云信 IM 服务端支持查询单个聊天室的信息或批量查询多个聊天室的信息，包括聊天室创建者、全体禁言状态、聊天室公告、聊天室在线人数、聊天室进出通知的开启状态等。

查询聊天室信息

URL

httpPOST https://api.netease.im/nimserver/chatroom/get.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

请求参数

• POST 请求中 Headers 的设置请参考API调用方式。

• POST 请求中 Body 的设置如下：

参数	类型	必须	说明
roomid	long	是	聊天室id
needOnlineUserCount	Boolean	否	是否需要返回在线人数，true或false，默认false

示例

cURL请求示例

curlcurl -X POST -H "CheckSum: fc040**602b79565230155c" -H "AppKey: f1234**56847aaaaaa" -H "Nonce: 1" -H "CurTime: 1451217360"  -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=66&needOnlineUserCount=true' 'https://api.netease.im/nimserver/chatroom/get.action'

返回示例

请求成功的返回示例如下：

json"Content-Type": "application/json; charset=utf-8"
{
  "chatroom": {
    "roomid": 66,
    "valid": true,
    "muted":false, //聊天室未处于全体禁言状态 
    "announcement": null,
    "name": "mychatroom",
    "broadcasturl": "xxxxxx",
    "onlineusercount": 1,
    "ext": "",
    "creator": "zhangsan",
    "queuelevel": 0,
    "ionotify": true	// 聊天室进出通知是否开启
  },
  "code": 200
}

批量查询聊天室信息

URL

httpPOST https://api.netease.im/nimserver/chatroom/getBatch.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

请求参数

• POST 请求中 Headers 的设置请参考API调用方式。

• POST 请求中 Body 的设置如下：

参数	类型	必须	说明
roomids	String	是	多个roomid，格式为：["6001","6002","6003"]（JSONArray对应的roomid，如果解析出错，会报414错误），限20个roomid
needOnlineUserCount	Boolean	否	是否需要返回在线人数，true或false，默认false

示例

cURL请求示例

curlcurl -X POST -H "CheckSum: fc04024892**79565230155c" -H "AppKey: f1234540c12345**6847aaaaaa" -H "Nonce: 1" -H "CurTime: 1451217360"  -H "Content-Type: application/x-www-form-urlencoded" -d 'roomids=["6001","6002","6003"]&needOnlineUserCount=true' 'https://api.netease.im/nimserver/chatroom/getBatch.action'

返回示例

请求成功的返回示例如下：

json"Content-Type": "application/json; charset=utf-8"
{
    "noExistRooms": [ //不存在的聊天室id列表
        6001
    ],
    "succRooms": [
        {
            "roomid": 6002,
            "valid": true,
            "announcement": "hi,this is announcement",
            "muted": false,
            "name": "6002 chatroom",
            "broadcasturl": "",
            "onlineusercount": 0,
            "ext": "6002 ext",
            "creator": "zhangsan",
            "queuelevel": 0,
    				"ionotify": true	// 聊天室进出通知是否开启
        }
    ],
    "failRooms": [ //失败的聊天室id,有可能是查的时候有500错误
	6003
    ],
    "code": 200
}

状态码

上述 API 在 HTTPS Body 中返回请求的状态码，状态码详情请参见状态码。