获取用户已加入的群组信息
更新时间: 2024/07/17 17:57:35
根据用户的账号(accid)查询该用户已加入的群组信息,包括群名称、群主、群用户上限等。
API 使用限制
单个应用中 1 秒内所有的高级群操作 API 合计最多可调用 100 次,超过后限制调用,会返回 416 错误码。
除发送群消息 API 外,其他所有高级群 API 都属于高级群操作 API。
URL
POST https://api.netease.im/nimserver/team/joinTeams.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求参数
- POST 请求中 Headers 的设置请参考API 调用方式。
- POST 请求中 Body 的设置如下:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
accid | String | 是 | 需要查询的用户账户,accid,最大长度 32 位字符 |
返回参数
参数 | 类型 | 说明 |
---|---|---|
code | Integer | 状态码,请求成功则返回 200 |
count | Integer | 该用户已加入的群组的数量 |
infos | String | 该用户已加入的群组的详细信息,JSONArray 格式 |
infos 中的参数说明
参数 | 类型 | 说明 |
---|---|---|
owner | String | 群主账户,accid |
tname | String | 群名称 |
maxusers | Integer | 群人数上限 |
tid | Long | 群 ID |
size | Integer | 当前群成员数量 |
custom | String | 群组自定义信息 |
示例
请求示例(curl)
curlcurl -X POST -H "AppKey: go9dnk***lw0803mgq3" -H "Nonce: 4tggger**3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan' 'https://api.netease.im/nimserver/team/joinTeams.action'
返回示例
json"Content-Type": "application/json; charset=utf-8"
{
"code":200,
"count":2,
"infos":[ //群的具体信息
{"owner":"t2",
"tname":"test1",
"maxusers":50,
"tid":3620,
"size":3,
"custom":"" },
{"owner":"t1","tname":"test2","maxusers":50,"tid":3622,"size":4, "custom":""}
]
}
请求失败返回示例
"Content-Type": "application/json; charset=utf-8"
{
"code": 414, // 参数错误
"desc": "xxxx is empty"
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
416 | 调用频率超出限制 | 降低访问频率 |
500 | 服务出错 | - |
此文档是否对你有帮助?