获取超大群信息
更新时间: 2024/07/17 17:57:35
获取超大群的详细信息,可以批量查询,一次最多查询 20 个超大群。
API 使用限制
单个应用中 1 秒内所有的超大群操作 API 合计最多可调用 100 次,超过后限制调用,会返回 416 错误码。
- 除超大群消息相关 API 外,其他所有超大群 API 都属于超大群操作 API。
- 超大群消息相关 API 包括:发送超大群消息,发送超大群自定义系统通知,撤回超大群消息,根据用户 ID/消息 ID 查询超大群历史消息。
URL
POST https://api.netease.im/nimserver/superteam/getTinfos.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求参数
- POST 请求中 Headers 的设置请参考接口概述。
- POST 请求中 Body 的设置如下:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
tids | String | 是 | 超大群 ID 列表(tids),如["3083","3084"],一次最多查询 20 个超大群,最大长度 1024 位字符 |
返回参数
参数 | 类型 | 说明 |
---|---|---|
code | Integer | 状态码 |
tinfos | String | 超大群的详细信息 |
tinfos 中的参数说明
参数 | 类型 | 说明 |
---|---|---|
tid | Long | 超大群 ID |
tname | String | 超大群名称 |
creator | String | 群主,创建者 |
tlevel | Integer | 超大群级别,群最大人数 |
size | Integer | 超大群大小,即当前群人数 |
intro | String | 超大群介绍 |
announcement | String | 超大群公告 |
clientCustom | String | 第三方客户端自定义字段 |
serverCustom | String | 第三方服务器扩展字段 |
icon | String | 超大群头像 |
muteType | Integer | 群禁言类型 |
joinmode | Integer | 申请入群的验证方式 |
beinvitemode | Integer | 邀请入群的验证方式 |
invitemode | Integer | 邀请入群的权限,即谁可以邀请他人入群 |
uptinfomode | Integer | 修改群信息权限 |
upcustommode | Integer | 修改群自定义属性的权限 |
createtime | Long | 创建时间 |
updatetime | Long | 更新时间 |
示例
请求示例(curl)
curlcurl -X POST -H "AppKey: go9dnk49bkd9**03mgq3" -H "Nonce: 4tgggergig**t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tids=%5B%223083%22%2C%223084%22%5D' 'https://api.netease.im/nimserver/superteam/getTinfos.action'
请求成功返回示例
json"Content-Type": "application/json; charset=utf-8"
{
"code":200,
//以下参数可参照创建超大群接口
"tinfos":[
{
"tid": 111,
"tname": "tname",
"creator": "creator",
"tlevel": 1,
"size": 12,
"intro": "intro",
"announcement": "announcement",
"clientCustom": "clientCustom",
"serverCustom": "serverCustom",
"icon": "icon",
"muteType": 2,
"joinmode": 0,
"beinvitemode": 0,
"invitemode": 0,
"uptinfomode": 0,
"upcustommode": 0,
"createtime": 1234,
"updatetime": 1234,
},
{} // 其他记录
]
}
请求失败返回示例
"Content-Type": "application/json; charset=utf-8"
{
"code": 414,
"desc": "tids size exceed!" // tids列表中群过多
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
403 | 禁止操作: 超大群功能未开通或 app 权限错误 |
根据对应提示信息做出处理 |
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
416 | 调用频率超出限制 | 降低访问频率 |
500 | 服务出错 | - |
此文档是否对你有帮助?