创建超大群
更新时间: 2024/07/17 17:57:35
创建超大群,创建时即可通过设置群成员列表邀请用户入群。
功能描述
- 创建超大群成功会返回
tid
,云信服务器产生,超大群唯一标识,该字段需要保存,以便于加人与踢人等后续操作。 - 如果创建时邀请的成员中存在加群数量超过限制的情况,会返回
faccid
(加群失败成员的 IM 账号)。 - 每个用户可创建的超大群数量有限制,限制值由 IM 套餐的群组配置决定,具体可前往云信控制台查看。
API 使用限制
单个应用中 1 秒内所有的超大群操作 API 合计最多可调用 100 次,超过后限制调用,会返回 416 错误码。
- 除超大群消息相关 API 外,其他所有超大群 API 都属于超大群操作 API。
- 超大群消息相关 API 包括:发送超大群消息,发送超大群自定义系统通知,撤回超大群消息,根据用户 ID/消息 ID 查询超大群历史消息。
URL
POST https://api.netease.im/nimserver/superteam/create.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求参数
- POST 请求中 Headers 的设置请参考接口概述。
- POST 请求中 Body 的设置如下:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
owner | String | 是 | 超大群群主用户帐号,accid,最大长度 32 位字符 |
inviteAccids | String | 是 | 创建群时邀请的群成员列表,\["aaa","bbb"\](JSONArray 对应的 accid,如果解析出错会报 414),inviteAccids 与 owner 总和上限为 200,inviteAccids 中无需再加 owner 自己的账号 |
tname | String | 是 | 超大群名称,最大长度 64 位字符 |
intro | String | 否 | 群描述,最大长度 512 位字符 |
announcement | String | 否 | 群公告,最大长度 1024 位字符 |
serverCustom | String | 否 | 自定义群扩展属性,第三方可以根据此属性自定义扩展自己的群属性,最大长度 1024 位字符 |
icon | String | 否 | 群头像,最大长度 1024 位字符 |
msg | String | 是 | 邀请发送的文字,最大长度 150 位字符 |
joinmode | Integer | 是 | 申请入群的验证模式 0,入群不需要验证(默认);1,入群需要验证;2,不允许申请入群 |
beinvitemode | Integer | 否 | 邀请入群时是否需要被邀请人的同意 0,需要同意(默认);1,不需要同意 |
invitemode | Integer | 否 | 谁可以邀请他人入群 0,群主和管理员(默认);1,所有人 |
uptinfomode | Integer | 否 | 谁可以修改群信息 0,群主和管理员(默认);1,所有人 |
upcustommode | Integer | 否 | 谁可以修改群自定义属性 0,群主和管理员(默认);1,所有人 |
tlevel | Integer | 否 | 群人数级别,默认为 200。该参数可设置的区间为 [2 ~ 控制台设置的群人数上限] 如何在云信控制台设置超大群的群人数上限(默认为 2000),请参考配置超大群功能 |
bid | String | 否 | 反垃圾业务 ID,JSON 字符串,{"textbid":"","picbid":""},若不填则使用原来的反垃圾配置 |
返回参数
参数 | 类型 | 说明 |
---|---|---|
code | Integer | 状态码 |
tid | Integer | 云信服务器产生,超大群唯一标识 |
faccid | String | 由于加群数量超限导致无法正常加入超大群的用户列表,包含用户的账号(accid)和附言(msg) |
示例
请求示例(curl)
curlcurl -X POST -H "AppKey: go9dnk49***w0803mgq3" -H "Nonce: 4tggge**323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'owner=zhangsan&inviteAccids=%5B%22lisi%22%2C%22wangwu%22%5D&tname=%E6%88%91%E7%9A%84%E7%BE%A4' 'https://api.netease.im/nimserver/superteam/create.action'
请求成功返回示例
json"Content-Type": "application/json; charset=utf-8"
{
"code":200,
"tid":"11001"
"faccid":{ // 如果超出群人数上线,会出现此字段
"accid":["accid1","accid2","accid3"],
"msg":"team count exceed"
}
}
请求失败返回示例
"Content-Type": "application/json; charset=utf-8"
{
"code": 414,
"desc": "inviteAccids size exceed!" // inviteAccids 成员过多
}
"Content-Type": "application/json; charset=utf-8"
{
"code": 806,
"desc": "team members size exceed!" // 群成员数超出限制
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
403 | 禁止操作:
|
根据对应提示信息做出处理 |
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
416 | 调用频率超出限制 | 降低访问频率 |
500 | 服务出错 | - |
806 | 人数超过规定限制:
|
根据对应提示信息做出处理 |
此文档是否对你有帮助?