一、功能描述
群资料指的是与群组相关的一些信息，相关属性在核心类 Group 中。
二、获取群资料
接口
chat.getGroupProfile(options);
参数
参数 options 为 Object 类型，包含的属性值如下：
| 参数 | 类型 | 说明 |
| groupID | String | 群组 ID |
| groupCustomFieldFilter | Array | undefined | 群维度的自定义字段过滤器，指定需要获取的群维度的自定义字段，详情请参阅 自定义字段 |
返回值
Promise
示例
let promise = chat.getGroupProfile({ groupID: 'group1', groupCustomFieldFilter: ['key1','key2'] });promise.then(function(imResponse) { console.log(imResponse.data.group);}).catch(function(imError) { console.warn('getGroupProfile error:', imError); // 获取群详细资料失败的相关信息});
三、修改群资料
接口
chat.updateGroupProfile(options);
参数 options 为 Object 类型，包含的属性值如下：
| 参数 | 类型 | 说明 |
| groupID | String | 群组 ID |
| name | String | undefined | 群名称，最长30字节 |
| avatar | String | undefined | 群头像 URL，最长100字节 |
| introduction | String | undefined | 群简介，最长240字节 |
| notification | String | undefined | 群公告，最长300字节 |
| maxMemberNum | Number | undefined | 最大群成员数量，最大为6000 |
| muteAllMembers | Boolean | undefined | 设置全体禁言：true 表示全体禁言false 表示取消全体禁言 |
| joinOption | String | 申请加群处理方式。TencentCloudChat.TYPES.JOIN_OPTIONS_FREE_ACCESS （自由加入）TencentCloudChat.TYPES.JOIN_OPTIONS_NEED_PERMISSION （需要验证）TencentCloudChat.TYPES.JOIN_OPTIONS_DISABLE_APPLY （禁止加群）注意：TencentCloudChat.TYPES.GRP_WORK, TencentCloudChat.TYPES.GRP_MEETING, TencentCloudChat.TYPES.GRP_AVCHATROOM 类型群组的该属性不允许修改。好友工作群禁止申请加群，临时会议群和直播群自由加入。 |
| inviteOption | String | 邀请进群处理方式。TencentCloudChat.TYPES.INVITE_OPTIONS_FREE_ACCESS （无需审批直接邀请进群）TencentCloudChat.TYPES.INVITE_OPTIONS_NEED_PERMISSION （需群主/群管理员验证）TencentCloudChat.TYPES.INVITE_OPTIONS_DISABLE_INVITE（禁止邀请）注意：TencentCloudChat.TYPES.GRP_AVCHATROOM 类型群组的该属性不允许修改，其他类型群组均支持修改。 |
| groupCustomField | Array | undefined | 群自定义字段。默认情况是没有的。开通群维度的自定义字段详情请参见 自定义字段 |
返回值
Promise
示例
let promise = chat.updateGroupProfile({ groupID: 'group1', name: 'new name', // 修改群名称 introduction: 'this is introduction.', // 修改群简介 // 群成员能收到群自定义字段变更的群提示消息，且能获取到相关的内容， // 详见 Message.payload.newGroupProfile.groupCustomField groupCustomField: [{ key: 'group_level', value: 'high'}] // 修改群组维度自定义字段});promise.then(function(imResponse) { console.log(imResponse.data.group) // 修改成功后的群组详细资料}).catch(function(imError) { console.warn('updateGroupProfile error:', imError); // 修改群组资料失败的相关信息});
// 全体禁言let promise = chat.updateGroupProfile({ groupID: 'group1', muteAllMembers: true, // true 表示全体禁言，false表示取消全体禁言});promise.then(function(imResponse) { console.log(imResponse.data.group) // 修改成功后的群组详细资料}).catch(function(imError) { console.warn('updateGroupProfile error:', imError); // 修改群组资料失败的相关信息});
// 修改邀请进群选项let promise = chat.updateGroupProfile({ groupID: 'group1', inviteOption: TencentCloudChat.TYPES.INVITE_OPTIONS_NEED_PERMISSION,});promise.then(function(imResponse) { console.log(imResponse.data.group) // 修改成功后的群组详细资料}).catch(function(imError) { console.warn('updateGroupProfile error:', imError); // 修改群组资料失败的相关信息});