更新时间: 2021-03-08

# 功能描述

查询聊天室基础信息,包括:聊天室 ID、名称、创建时间

# 实现方法

# 功能接口

请求地址: https://数据中心域名/chatroom/query.json

请求方法: POST

调用频率: 无限制

签名规则: 所有请求融云服务端 API 接口的请求均需要进行规则校验,详细请参考 通用 API 接口签名规则

# 输入参数
参数 类型 必传 说明
chatroomId String 要查询的聊天室 Id
# 返回结果
返回值 返回类型 说明
code Int 返回码,200 为正常。
chatRooms String[] 聊天室信息数组。
chrmId String 聊天室 ID。
name String 聊天室名称。
time String 聊天室创建时间。
# 示例代码

Request:

POST /chatroom/query.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: Application/x-www-form-urlencoded

chatroomId=10001&chatroomId=10002
已复制
1
2
3
4
5
6
7
8
9

Response:

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

{
  "code":200,
  "chatRooms":[{
    "chatroomId":"10001","name":"name1","time":"2014-01-01 1:1:1"
  },
  {
    "chatroomId":"10002","name":"name2","time":"2014-01-01 1:1:2"
  }]
}
已复制
1
2
3
4
5
6
7
8
9
10
11
12

# 获取聊天室成员

# 功能接口

获取指定聊天室中成员用户 ID,最多返回 500 个成员信息,支持按加入时间正序、倒序方式获取。

请求地址: https://数据中心域名/chatroom/user/query.json

请求方法: POST

调用频率: 无限制

签名规则: 所有请求融云服务端 API 接口的请求均需要进行规则校验,详细请参考 通用 API 接口签名规则

# 输入参数
参数 类型 必传 说明
chatroomId String 要查询的聊天室 ID
count String 要获取的聊天室成员信息数,最多返回 500 个成员信息
order String 加入聊天室的先后顺序, 1 为加入时间正序, 2 为加入时间倒序
# 返回结果
返回值 返回类型 说明
code Int 200:成功。
total Int 当前聊天室中用户数。
users String[] 聊天室成员数组,最多为 500 个。
id String 用户 Id。
time String 加入聊天室时间。
# 示例代码

Request:

POST /chatroom/user/query.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: Application/x-www-form-urlencoded

chatroomId=10001&count=2&order=1
已复制
1
2
3
4
5
6
7
8
9

Response:

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

{
  "code":200,
  "total":500,
  "users":[
  {
    "id":"uid1",
    "time":"2015-09-10 16:38:26"
  },
  {
    "id":"uid2",
    "time":"2015-09-10 16:38:26"
  }]
}
已复制
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# 查询用户是否加入

查询指定用户是否在聊天室中

聊天室成员在两种情况下会被自动退出聊天室:

一、聊天室中用户在离线 30 秒后,聊天室中有新消息产生时,该用户将被踢出聊天室,如离线 30 秒后,聊天室中没有新消息产生,用户也不被踢出聊天室,此时查询用户状态仍然显示在聊天室中。

二、用户离线后聊天室中产生 30 条消息时会被自动退出聊天室
已复制
# 功能接口

请求地址: https://数据中心域名/chatroom/user/exist.json

请求方法: POST

调用频率: 无限制

签名规则: 所有请求融云服务端 API 接口的请求均需要进行规则校验,详细请参考 通用 API 接口签名规则

# 输入参数
参数 类型 必传 说明
chatroomId String 要查询的聊天室 ID
userId String 要查询的用户 ID
# 返回结果
返回值 返回类型 说明
code Int 200:成功。
isInChrm Boolean 用户是否在聊天室中,true 表示在聊天室中,false 表示不在聊天室中。
# 示例代码

Request:

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

chatroomId=10001&userId=5
已复制
1
2
3
4
5
6
7
8
9

Response:

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

{"code":200,"isInChrm":true}
已复制
1
2
3
4

# 批量查询用户是否加入

批量查询用户是否在聊天室中,每次查询最多不超过 1000 个。

# 功能接口

请求地址: https://数据中心域名/chatroom/users/exist.json

请求方法: POST

调用频率: 无限制

签名规则: 所有请求融云服务端 API 接口的请求均需要进行规则校验,详细请参考 通用 API 接口签名规则

# 输入参数
参数 类型 必传 说明
chatroomId String 要查询的聊天室 ID
userId String 要查询的用户 ID,每次最多不超过 1000 个用户 ID
# 返回结果
返回值 返回类型 说明
code Int 200:成功。
userid String 聊天室中用户 ID。
isInChrm Int 用户是否在聊天室中,1 表示在聊天室中,0 表示不在聊天室中。
# 示例代码

Request:

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

chatroomId=10001&userId=y41z2IXBW&userId=niCtlxnas
已复制
1
2
3
4
5
6
7
8
9

Response:

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

{
  "code":200,
  "result":[
     {"userid":"y41z2IXBW", "isInChrm":0},
     {"userid":"niCtlxnas", "isInChrm":1}
   ]
}
已复制
1
2
3
4
5
6
7
8
9
10

文档是否解决您的问题 ?

如果遇到产品相关问题,您可 提交工单 寻求帮助