查询房间历史成员信息
更新时间: 2024/03/25 11:00:41
您可以调用本接口查询指定房间的创建者、历史成员列表、成员进入和退出房间的具体时间,帮助您了解计费的详细依据信息。
房间关闭后仅支持72小时内的记录查询。
URL
- 请求方法:POST
- URL:网易云信为该功能提供以下两个 API 请求地址,使用 V3 地址需在 URL 中指定 cname,您可以根据业务需求调用任一接口。
https://logic-dev.netease.im/v2/api/room/history https://logic-dev.netease.im/v3/api/room/history?cname=meeting_name
- Content-Type:application/json
URL 中参数说明:
参数名称 | 类型 | 是否必传 | 示例 | 描述 |
---|---|---|---|---|
cname | String | V2 不传,V3 必传 | meeting_name111 | 房间名称。仅在调用 V3 接口时需要设置。 |
接口请求频率
默认上限为 50 次/秒,若请求频率超出限制,可能会返回 429 错误码。
若您需要上调上限,请参考如何处理调用服务端 RESTful API 超出频率限制。
请求参数
-
请求中 Header 的设置请参考请求结构描述。
-
请求中 Body 须为 JSON 格式,参数说明如下:
参数名称 | 类型 | 是否必传 | 示例 | 描述 |
---|---|---|---|---|
cid | Long | V2 必传,V3 不传 | 111 | 房间 ID。该 ID 为创建房间接口调用成功后返回的房间 ID。仅在调用 V2 接口时需要设置。 |
pageNum | Integer | 否 | 1 | 总页数。 默认值为 1,如果不填写,则使用默认值 1。 |
pageSize |
Integer |
否 |
10 |
每页返回的房间成员记录数。 |
返回参数
参数名称 | 类型 | 示例 | 描述 |
---|---|---|---|
code | Integer | 200 | 状态码。 |
requestId | String | f8f274c1-0e9f-4583-a243-c61c06a19475 | 请求 ID。 |
currentPage | Integer | 2 | 当前页码。 |
uid | Long | 123456789 | 用户 ID。 |
cname | String | 2044867 | 房间名称。 |
login_time | Long | 1636452191163 | 用户加入房间的时间。UTC 时间戳,即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到事件发生时的毫秒数。 |
logout_time | Long | 1636452763092 | 用户退出房间的时间。UTC 时间戳,即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到事件发生时的毫秒数。 |
type |
Integer |
1 |
用户的操作类型。
|
pageNum | Integer | 2 | 总页数。 |
pageSize | Integer | 10 | 每页返回的房间成员记录数。 |
totalRecords | Integer | 122 | 总成员记录数。同一用户多次进出显示多条记录。 |
示例
V2 请求示例
{
"cid": 111,
"pageNum": 1,
"pageSize": 2
}
V3 请求示例
{
"pageNum": 1,
"pageSize": 2
}
正常返回示例
{
"code": 200,
"requestId": "f8f274c1-0e9f-4583-a243-c61c06a19475",
"data": {
"currentPage": 2,
"list": [
{
"uid": "123456789",
"login_time": 1636452576442,
"cname": "2044867",
"logout_time": 0
"type": 1
},
{
"uid": "123456789",
"login_time": 1636452576443,
"cname": "2044867",
"logout_time": 1636452748724
"type": 4
},
{
"uid": "123456789",
"login_time": 1636452191163,
"cname": "2044867",
"logout_time": 0
"type": 1
},
{
"uid": "123456789",
"login_time": 1636452576453,
"cname": "2044867",
"logout_time": 1636452802235
"type": 4
},
{
"uid": "123456789",
"login_time": 1636452748724,
"cname": "2044867",
"logout_time": 0
"type": 1
},
{
"uid": "123456789",
"login_time": 1636452576466,
"cname": "2044867",
"logout_time": 1636452840837
"type": 4
},
{
"uid": "123456789",
"login_time": 1636452858844,
"cname": "2044867",
"logout_time": 0
"type": 1
},
{
"uid": "123456789",
"login_time": 1636452802235,
"cname": "2044867",
"logout_time": 1636452862129
"type": 4
},
{
"uid": "123456789",
"login_time": 1636452840837,
"cname": "2044867",
"logout_time": 0
"type": 1
},
{
"uid": "123456789",
"login_time": 1636452802256,
"cname": "2044867",
"logout_time": 1636452882916
"type": 4
}
],
"pageNum": 13,
"pageSize": 10,
"totalRecords": 122
}
}
错误码
-
header 中的状态码:
状态码列表请参考header 中的 HTTP 状态码。
-
body 中的错误码(code):
该接口在 HTTP Body 中返回错误码(code),错误码列表请参考业务错误码。
此文档是否对你有帮助?