批量获取群组信息与成员列表
更新时间: 2024/07/17 17:57:35
批量查询高级群的群组信息和相应的群成员列表。查询群成员会使查询时间增加,所以如果不需要群成员列表可以只查群信息。
API 使用限制
单个应用中 1 秒内所有的高级群操作 API 合计最多可调用 100 次,超过后限制调用,会返回 416 错误码。
除发送群消息 API 外,其他所有高级群 API 都属于高级群操作 API。
URL
httpPOST https://api.netease.im/nimserver/team/query.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求参数
- POST 请求中 Headers 的设置请参考API 调用方式。
- POST 请求中 Body 的设置如下:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
tids | String | 是 | 群 ID 列表,如["3083","3084"],一次最多查询 10 个群,最大长度 1024 位字符 |
ope | Integer | 是 | 1,表示带上群成员列表;0,表示不带群成员列表,只返回群信息 |
返回参数
参数 | 类型 | 说明 |
---|---|---|
code | Integer | 状态码 |
tinfos | String | 群组信息,JSONArray 格式 |
tinfos中的参数说明
参数 | 类型 | 说明 |
---|---|---|
tname | String | 群名称 |
icon | String | 群头像 |
owner | String | 群主用户帐号 |
maxusers | Integer | 群成员最大数量 |
tid | Long | 群 ID |
size | Integer | 当前群成员数量 |
announcement | String | 群公告 |
intro | String | 群介绍 |
joinmode | Integer | 申请入群的验证方式 0,不用验证;1,需要验证;2,不允许任何人加入 |
beinvitemode | Integer | 群创建完成后,邀请入群时是否需要被邀请人的同意 0,需要同意(默认);1,不需要同意 |
invitemode | Integer | 邀请权限,即谁可以邀请他人入群 0,群主和管理员(默认);1,所有人 |
uptinfomode | Integer | 客户端修改群信息权限,即谁可以修改群信息 0,群主和管理员(默认);1,所有人 |
upcustommode | Integer | 客户端修改群自定义属性权限,即谁可以修改群自定义属性 0,群主和管理员(默认);1,所有人 |
muteType | Integer | 群禁言类型 0,解除禁言;1,禁言普通成员;3,禁言整个群(包括群主) |
isNotifyCloseOnline | Boolean | 群通知消息是否关闭在线发送(开启该功能才会有该字段) |
isNotifyClosePersistent | Boolean | 群通知消息是否关闭持久化存储(开启该功能才会有该字段) |
custom | String | 自定义高级群扩展属性 |
clientCustom | String | 客户端自定义字段 |
mute | Boolean | 是否全员禁言 |
admins | String | 管理员账号 |
members | String | 群成员列表 |
createtime | Long | 创建时间 |
updatetime | Long | 更新时间 |
示例
请求示例(curl)
curlcurl -X POST -H "AppKey: go9dnk49b**w0803mgq3" -H "Nonce: 4tggger**323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tids=%5B%223083%22%2C%223084%22%5D&ope=1' 'https://api.netease.im/nimserver/team/query.action'
请求成功返回示例
json"Content-Type": "application/json; charset=utf-8"
//查询不带群成员的群列表信息
{
"code":200,
"tinfos":[
{"tname":"aa", /
"announcement":"aa",
"owner":"v4",
"maxusers":50,
"joinmode":1,
"tid":3083,
"intro":"test",
"size":3,
"custom":"",
"clientCustom:"",
"mute":true,
"createtime": 1506652312445,
"updatetime": 1521082125400},
{"tname":"bb","announcement":"bb","owner":"v4","maxusers":50,"joinmode":1,"tid":3084,"intro":"test","size":3,"custom":"","clientCustom"","mute":false,"createtime": 1506652312445,"updatetime": 1521082125400}
]
}
//查询带群成员的群列表信息
{
"code":200,
"tinfos":[
{"tname":"aa","announcement":"aa","owner":"v4","maxusers":50,"joinmode":1,"tid":3083,"intro":"test","size":3,"custom":"","mute":true,"createtime": 1506652312445,"updatetime": 1521082125400,"admins":["v1"],"members":["v1","v2"]},
{"tname":"bb","announcement":"bb","owner":"v4","maxusers":50,"joinmode":1,"tid":3084,"intro":"test","size":3,"custom":"","mute":false,"createtime": 1506652312445,"updatetime": 1521082125400,"admins":["v1"],"members":["v1","v2"]}
] //admins表示是管理员
}
请求失败返回示例
"Content-Type": "application/json; charset=utf-8"
{
"code": 414, // 参数错误
"desc": "xxxx is empty"
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
403 | 禁止操作: 非高级群不支持该操作 |
根据对应提示信息做出处理 |
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
416 | 调用频率超出限制 | 降低访问频率 |
500 | 服务出错 | - |
此文档是否对你有帮助?