跳到主要内容

批量查询是否在聊天室中

批量查询用户是否在指定聊天室中，每次最多可查询 1000 个用户。

提示

用户是否在聊天室中，可能会受到聊天室自动退出机制的影响。

了解聊天室离线成员自动退出机制​

聊天室具有离线成员自动退出机制。用户离线后，如满足以下默认预设条件，即时通讯服务端会自动将该用户踢出聊天室：

  • 从用户离线开始 30 秒内，聊天室中产生第 31 条消息时，触发自动踢出。
  • 或用户已离线 30 秒后，聊天室有新消息产生时，触发自动踢出。
提示
  • 默认预设条件均要求聊天室中必须要有新消息产生，否则无法触发踢出动作。如果聊天室中没有消息产生，则无法将异常用户踢出聊天室。
  • 如需修改默认行为对新消息的依赖，请提交工单申请开通聊天室成员异常掉线实时踢出。开通该服务后，服务端会通过 SDK 行为（要求 Android/iOS IMLib SDK 版本 ≧ 5.1.6，Web IMLib 版本 ≧ 5.3.2）判断用户是否处于异常状态，最迟 5 分钟可以将异常用户踢出聊天室。
  • 如需保护特定用户，即不自动踢出指定用户（如某些应用场景下可能希望用户驻留聊天室），可使用 Server API 提供的聊天室用户白名单功能。

请求方法​

POST https://数据中心域名/chatroom/users/exist.json

频率限制： 每秒钟限 100 次

签名规则： 所有服务端 API 请求均需要进行规则校验，详见 API 请求签名。

正文参数​

HTTP 请求正文数据格式为 application/x-www-form-urlencoded，支持以下 HTTP 表单参数：

参数类型必传说明
chatroomIdString是要查询的聊天室 ID。
userIdString是要查询的用户 ID，可重复传递多个同名参数，每次最多不超过 1000 个。

请求示例​

HTTP
POST /chatroom/users/exist.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

chatroomId=10001&userId=y41z2IXBW&userId=niCtlxnas

返回结果​

HTTP 响应正文包含具有以下结构的 JSON 对象：

返回值返回类型说明
codeInt返回码，200 表示成功。
resultArray查询结果数组。
result[i].userIdString用户 ID。
result[i].isInChrmInt用户是否在聊天室中。1 表示在，0 表示不在。

返回结果示例​

HTTP
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "code":200,
  "result":[
     {"userid":"y41z2IXBW", "isInChrm":0},
     {"userid":"niCtlxnas", "isInChrm":1}
   ]
}
最后于 更新