分页查询频道成员列表
更新时间: 2024/07/17 17:57:35
云信服务端支持分页查询频道成员列表。频道成员指可以访问频道的服务器成员。成员是否可以访问(即是否对成员可见)通过频道的黑白名单管控。
- 如果是公开频道,被加入黑名单的用户无法访问频道。
- 如果是私密频道,没有被加入白名单的成员都无法访问频道。
URL
httpPOST https://api.netease.im/nimserver/qchat/getChannelMemberListPage.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参考API调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
serverId | Long | 是 | 服务器 ID |
channelId | Long | 是 | 频道 ID |
timetag | Long | 是 | 频道创建时间,单位毫秒,如果传 0 则表示查询首页,分页查询按照创建时间逆序查询 |
limit | String | 是 | 本次查询的数量上限,最大数量 200 |
accid | String | 否 | 操作者的帐号,如果传,则会校验该账号是否为服务器成员和频道成员。如果不是,则会判定为无权限查询,返回 403 状态码 |
返回参数
参数 |
说明 |
---|---|
code | 状态码 |
pageInfo | 分页信息,hasMore:是否查询下一页,nextTimetag:查询下一页时需要的时间戳 |
members | 返回的频道成员列表,具体字段说明参见下表 |
members 字段 |
说明 |
---|---|
nick | 成员昵称 |
joinTime | 该成员加入服务器的时间 |
validFlag | 有效标志,0-无效,1-有效。如果频道对该成员不可见了,则为 0 |
createTime | 成员记录在数据库的创建时间 |
custom | 自定义扩展字段 |
accid | 成员的 IM 账号 |
inviter | 邀请该成员的用户的 IM 账号 |
updateTime | 成员记录在数据库的更新时间 |
avatar | 成员头像 |
type | 成员类型,0-普通成员,1-服务器所有者 |
serverId | 频道所属的服务器的ID |
分页时请根据分页参数确定是否翻页,返回结果可能不足 limit,但是 hasMore 为 true。此外,首页可能返回 limit+1 条。
示例
请求示例(cURL)
curlcurl -X POST -H "AppKey: go9dnk4**03mgq3" -H "Nonce: 4tggg**23t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&serverId=1235&timetag=1558938768520&limit=10' 'https://api.netease.im/nimserver/qchat/getChannelMemberListPage.action'
返回示例
请求成功返回示例如下。
{
"code": 200, //状态码
"pageInfo": {
"hasMore": true, //是否有下一页
"nextTimetag": 1234 //查询下一页时需要的timetag
},
"members": [ //是一个数组,每一项都是一个服务器成员信息
{
"nick": "一个昵称",
"joinTime": 1660902513871,
"validFlag": 1,
"createTime": 1660902513871,
"custom": "custom",
"accid": "98676476700",
"inviter": "inviter",
"updateTime": 1660902513871,
"avatar": "avatar",
"type": 1,
"serverId": 12345
}
]
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
403 | 非法操作或没有权限 |
|
404 | 对象不存在 |
|
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
431 | HTTP重复请求 | - |
此文档是否对你有帮助?