修改群组信息
更新时间: 2024/07/17 17:57:35
群主可修改群组基本信息,包括群名称、被邀请人同意方式、反垃圾业务 ID 等。
当前默认只有群主能修改群信息,若群管理员也需要该权限,可以联系商务和技术支持进行开通。
API 使用限制
单个应用中 1 秒内所有的高级群操作 API 合计最多可调用 100 次,超过后限制调用,会返回 416 错误码。
除发送群消息 API 外,其他所有高级群 API 都属于高级群操作 API。
URL
POST https://api.netease.im/nimserver/team/update.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求参数
- POST 请求中 Headers 的设置请参考API 调用方式。
- POST 请求中 Body 的设置如下:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
tid | Long | 是 | 云信服务器产生,群唯一标识,创建群时会返回,最大长度 64 位长整型 |
tname | String | 否 | 群名称,最大长度 64 位字符 |
owner | String | 是 | 群主账号,accid,最大长度 32 位字符 |
announcement | String | 否 | 群公告,最大长度 1024 位字符 |
intro | String | 否 | 群描述,最大长度 512 位字符 |
icon | String | 否 | 群头像,最大长度 1024 位字符 |
joinmode | Integer | 否 | 群创建完成后,通过 SDK 侧操作申请入群的验证方式 0,不用验证;1,需要群主或管理员的验证;2,不允许任何人加入 |
beinvitemode | Integer | 否 | 群创建完成后,邀请入群时是否需要被邀请人的同意 0,需要同意(默认);1,不需要同意 |
invitemode | Integer | 否 | 邀请权限,即谁可以邀请他人入群 0,群主和管理员(默认);1,所有人 |
uptinfomode | Integer | 否 | 客户端修改群信息权限,即谁可以修改群信息 0,群主和管理员(默认);1,所有人 |
upcustommode | Integer | 否 | 客户端修改群自定义属性权限,即谁可以修改群自定义属性 0,群主和管理员(默认);1,所有人 |
teamMemberLimit | Integer | 否 | 群最大人数(包含群主),[2,200(默认)] |
custom | String | 否 | 自定义高级群扩展属性,第三方可以跟据此属性自定义扩展自己的群属性,建议为 JSON,最大长度 1024 位字符 |
attach | String | 否 | 自定义扩展字段,最大长度 512 位字符 |
bid | String | 否 | 反垃圾业务 ID,JSON 字符串,{"textbid":"","picbid":""},若不填则使用原来的反垃圾配置 |
示例
请求示例(curl)
curlcurl -X POST -H "AppKey: go9dnk***03mgq3" -H "Nonce: 4tgggerg**23t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&tname=mygroup&owner=zhangsan' 'https://api.netease.im/nimserver/team/update.action'
请求成功返回示例
json"Content-Type": "application/json; charset=utf-8"
{
"code":200
}
请求失败返回示例
"Content-Type": "application/json; charset=utf-8"
{
"code": 414, // 参数错误
"desc": "xxxx is empty"
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
403 | 禁止操作:
|
根据对应提示信息做出处理 |
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
416 | 调用频率超出限制 | 降低访问频率 |
500 | 服务出错 | - |
此文档是否对你有帮助?