群组类型 ID | 是否支持此 REST API |
Private | 支持,同新版本中的 Work(好友工作群) |
Public | 支持 |
ChatRoom | 支持,同新版本中的 Meeting(临时会议群) |
AVChatRoom | 支持 |
Community(社群) | 支持 |
https://xxxxxx/v4/group_open_http_svc/modify_group_base_info?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名: 中国: console.tim.qq.com 新加坡: adminapisgp.im.qcloud.com 首尔: adminapikr.im.qcloud.com 法兰克福: adminapiger.im.qcloud.com 硅谷: adminapiusa.im.qcloud.com 雅加达: adminapiidn.im.qcloud.com |
v4/group_open_http_svc/modify_group_base_info | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
{"GroupId": "@TGS#1NVTZEAE4", // 要修改哪个群的基础资料(必填)"Name": "NewName", // 群名称(选填)"Introduction": "NewIntroduction", // 群简介(选填)"Notification": "NewNotification", // 群公告(选填)"FaceUrl": "http://this.is.new.face.url", // 群头像(选填)"MaxMemberNum": 500, // 最大群成员数量(选填)"ApplyJoinOption": "NeedPermission", // 申请加群方式(选填)"MuteAllMember": "On" // 设置全员禁言(选填):"On"开启,"Off"关闭}
{"GroupId": "@TGS#1NVTZEAE4", // 要修改哪个群的基础资料(必填)"AppDefinedData": [ // 自定义字段(选填){"Key": "GroupTestData1", // 需要修改的自定义字段 key"Value": "NewData" // 自定义字段的新值}]}
{"GroupId": "@TGS#1NVTZEAE4", // 要修改哪个群的基础资料(必填)"AppDefinedData": [ // 自定义字段(选填){"Key": "GroupTestData2","Value": "" // 设置为空表示删除该项自定义字段}]}
{"GroupId": "@TGS#2J4SZEAEL", // 要修改哪个群的基础资料(必填)"Name": "NewName", // 群名称(选填)"Introduction": "NewIntroduction", // 群简介(选填)"Notification": "NewNotification", // 群公告(选填)"FaceUrl": "http://this.is.new.face.url", // 群头像(选填)"MaxMemberNum": 500, // 最大群成员数量(选填)"ApplyJoinOption": "NeedPermission", // 申请加群方式(选填)"MuteAllMember": "On", // 设置全员禁言(选填):"On"开启,"Off"关闭"AppDefinedData": [ // 自定义字段(选填){"Key": "GroupTestData1", // 需要修改的自定义字段 key"Value": "NewData" // 自定义字段的新值},{"Key": "GroupTestData2","Value": "" // 设置为空表示删除该项自定义字段}]}
字段 | 类型 | 属性 | 说明 |
GroupId | String | 必填 | 需要修改基础信息的群组的 ID |
Name | String | 选填 | 最长30字节,使用 UTF-8 编码,1个汉字占3个字节 |
Introduction | String | 选填 | 最长240字节,使用 UTF-8 编码,1个汉字占3个字节 |
Notification | String | 选填 | 最长300字节,使用 UTF-8 编码,1个汉字占3个字节 |
FaceUrl | String | 选填 | 群头像 URL,最长100字节 |
MaxMemberNum | Integer | 选填 | 最大群成员数量 好友工作群(Work),陌生人社交群(Public),临时会议群(Meeting)及社群(Community):该字段阈值请参见 群组系统 中的群成员人数上限相关说明 直播群(AVChatRoom):该字段为无效字段,无需填写 |
ApplyJoinOption | String | 选填 | 申请加群处理方式。包含 FreeAccess(自由加入),NeedPermission(需要验证),DisableApply(禁止加群)。社群目前不支持此字段 |
AppDefinedData | Array | 选填 | 默认情况是没有的。开通群组维度的自定义字段详情请参见 自定义字段 |
MuteAllMember | String | 选填 | 群内群成员禁言,只有群管理员和群主以及系统管理员可以发言 |
InviteJoinOption | String | 选填 | 邀请加群处理方式,包含 FreeAccess (直接邀请用户进群,不需要审批等操作), NeedPermission 需要群管理员或者群主审批, DisableInvite 不支持 SDK 邀请邀请进群, 该选项 AVChatRoom 群类型不支持 |
From_Account
| String | 选填 | 操作者来源账号,选填。如果不填写该字段,则修改群资料的操作者为调用该接口时使用的 App 管理员账号。除此之外,App 亦可通过该字段“伪造”修改群资料的操作者,从而实现一些特殊的功能需求。需要注意的是,如果指定该字段,必须要确保字段中的账号是存在的 |
EnablePermission | Integer | 选填 | 仅支持话题的社群可以设置该字段 是否启用权限组作为权限判断依据 0:不启用 1:启用 |
DefaultPermission | Integer | 选填 | 仅启用权限组作为权限判断依据的群可以设置该字段 群成员在该群中的默认权限 |
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0}
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果,OK 表示处理成功,FAIL 表示失败 |
ErrorCode | Integer | 错误码,0表示成功,非0表示失败 |
ErrorInfo | String | 错误信息 |
错误码 | 描述 |
10002 | 服务器内部错误,请重试 |
10003 | 请求命令字非法 |
10004 | 参数非法,请根据错误描述检查请求是否正确 |
10026 | 该 SDKAppID 请求的命令字已被禁用,请联系客服 |
10007 | 操作权限不足,请确认操作者是否是 App 管理员或者是否有权限修改请求中的字段 |
10010 | 群组不存在,或者曾经存在过,但是目前已经被解散 |
10015 | 群组 ID 非法,请检查群组 ID 是否填写正确 |
本页内容是否解决了您的问题?