获取超大群成员信息
更新时间: 2024/07/17 17:57:35
查询指定超大群的成员信息。
API 使用限制
单个应用中 1 秒内所有的超大群操作 API 合计最多可调用 100 次,超过后限制调用,会返回 416 错误码。
- 除超大群消息相关 API 外,其他所有超大群 API 都属于超大群操作 API。
- 超大群消息相关 API 包括:发送超大群消息,发送超大群自定义系统通知,撤回超大群消息,根据用户 ID/消息 ID 查询超大群历史消息。
URL
POST https://api.netease.im/nimserver/superteam/getTlists.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求参数
- POST 请求中 Headers 的设置请参考接口概述。
- POST 请求中 Body 的设置如下:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
tid | Long | 是 | 云信服务器产生,超大群唯一标识,创建时会返回,最大长度 64 位长整型 |
timetag | Long | 是 | 毫秒级别时间戳,查询的时间起点 |
limit | Integer | 是 | 本次查询的条数上限,(0,2000] |
reverse | Integer | 否 | 查询方向 1,按时间正序排列(默认);2,按时间降序排列 |
返回参数
参数 | 类型 | 说明 |
---|---|---|
code | Integer | 状态码 |
tlists | String | 群成员信息 |
tlists 中的参数说明
参数 | 类型 | 说明 |
---|---|---|
tid | Long | 超大群 ID |
uid | Long | 云信分配的用户 ID |
accid | String | 用户账号 |
type | Integer | 群成员类型 0,普通成员;1,群主;2,管理员 |
nick | String | 群昵称 |
jointime | String | 加入群的时间 |
mute | Integer | 是否被禁言 1,禁言;0,解禁 |
invitoruid | Long | 云信分配的邀请者的 ID |
invitor | String | 邀请者的账号 |
validflag | Integer | 有效标志 0,无效;1,有效 |
custom | String | 自定义扩展属性 |
state | Integer | 激活状态 0,未激活;1,已激活 |
bits | Long | 群成员配置 |
createtime | Long | 创建时间 |
updatetime | Long | 更新时间 |
示例
请求示例(curl)
curlcurl -X POST -H "AppKey: go9dnk49b****03mgq3" -H "Nonce: 4tggger***23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&timetag=1558938768520&limit=10' 'https://api.netease.im/nimserver/superteam/getTlists.action'
请求成功返回示例
json"Content-Type": "application/json; charset=utf-8"
{
"tlists": [
{
"tid": 18035,
"uid": 123123,
"accid": "123123",
"type": 0,
"nick": "nickName",
"jointime": 1572927187464,
"custom": null,
"mute": 0,
"createtime": 1572927187464,
"updatetime": 1572927187464,
"invitoruid": 12312,
"invitor": "accid",
"validflag": 1,
"state": 1,
"bits": 123123,
},
{} // 其他记录
],
"code": 200
}
请求失败返回示例
"Content-Type": "application/json; charset=utf-8"
{
"code": 414,
"desc": "bad limit" // limit 不在有效范围内
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
403 | 禁止操作: 超大群功能未开通或 app 权限错误 |
根据对应提示信息做出处理 |
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
416 | 调用频率超出限制 | 降低访问频率 |
500 | 服务出错 | - |
此文档是否对你有帮助?