chat.getGroupMemberList(options);
Name | Type | Description |
groupID | String | 群组 ID |
count | Number | 需要拉取的数量。默认值:15,最大值:100,避免回包过大导致请求失败。若传入超过 100,则只拉取前 100 个(旗舰版套餐直播群使用该接口时忽略 count 参数)。 |
offset | Number | 偏移量,默认从0开始拉取。 |
Promise
let promise = chat.getGroupMemberList({groupID: 'group1',count: 30,offset:0,}); // 从0开始拉取30个群成员promise.then(function(imResponse) {console.log(imResponse.data.memberList); // 群成员列表}).catch(function(imError) {console.warn('getGroupMemberList error:', imError);});
// 该接口支持拉取群成员禁言截止时间戳。let promise = tim.getGroupMemberList({groupID: 'group1',count: 30,offset:0,}); // 从 0 开始拉取30个群成员promise.then(function(imResponse) {console.log(imResponse.data.memberList); // 群成员列表for (let groupMember of imResponse.data.memberList) {if (groupMember.muteUntil * 1000 > Date.now()) {console.log(`${groupMember.userID} 禁言中`);} else {console.log(`${groupMember.userID} 未被禁言`);}}}).catch(function(imError) {console.warn('getGroupMemberProfile error:', imError);});
// 旗舰版套餐支持获取直播群在线成员列表let promise = chat.getGroupMemberList({groupID: 'group1',offset:0, // 默认从 0 开始拉取});promise.then(function(imResponse) {console.log(imResponse.data.memberList); // 群成员列表}).catch(function(imError) {console.warn('getGroupMemberList error:', imError);});
TencentCloudChat.TYPES.GRP_WORK
类型的群组(即好友工作群)不支持此操作。TencentCloudChat.TYPES.GRP_AVCHATROOM
类型的群组(即直播群)不支持此操作。chat.setGroupMemberMuteTime(options);
Name | Type | Description |
groupID | String | 群组 ID 或 话题 ID |
userID | String | 用户 ID |
muteTime | Number | 禁言时长,单位秒。如设为1000,则表示从现在起禁言该用户 1000 秒;设为0,则表示取消禁言。 |
Promise
let promise = chat.setGroupMemberMuteTime({groupID: 'group1',userID: 'user1',muteTime: 600 // 禁言10分钟;设为0,则表示取消禁言});promise.then(function(imResponse) {console.log(imResponse.data.group); // 修改后的群资料console.log(imResponse.data.member); // 修改后的群成员资料}).catch(function(imError) {console.warn('setGroupMemberMuteTime error:', imError); // 禁言失败的相关信息});
// 设置群成员在话题中的禁言时间let promise = chat.setGroupMemberMuteTime({groupID: 'topicID',userID: 'user1',muteTime: 600 // 禁言10分钟;设为0,则表示取消禁言});promise.then(function(imResponse) {console.log(imResponse.data.group); // 修改后的群资料console.log(imResponse.data.member); // 修改后的群成员资料}).catch(function(imError) {console.warn('setGroupMemberMuteTime 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); // 修改群组资料失败的相关信息});
chat.deleteGroupMember(options);
Name | Type | Description |
groupID | String | 群组 ID 或 话题 ID |
userIDList | Array | 待删除的群成员的 ID 列表 |
reason | String | undefined | 踢人的原因 |
duration | Number | 踢出时长,必须大于 0(仅直播群支持) |
Promise
// 非直播群踢出群成员let promise = chat.deleteGroupMember({groupID: 'group1',userIDList:['user1'],reason: '你违规了,我要踢你!',});promise.then(function(imResponse) {console.log(imResponse.data.group); // 删除后的群组信息console.log(imResponse.data.userIDList); // 被删除的群成员的 userID 列表}).catch(function(imError) {console.warn('deleteGroupMember error:', imError); // 错误信息});
// 直播群踢出群成员let promise = chat.deleteGroupMember({groupID: 'group1',userIDList:['user1'],reason: '你违规了,我要踢你!',duration: 60,});promise.then(function(imResponse) {console.log(imResponse.data.group); // 删除后的群组信息console.log(imResponse.data.userIDList); // 被删除的群成员的 userID 列表}).catch(function(imError) {console.warn('deleteGroupMember error:', imError); // 错误信息});
TencentCloudChat.TYPES.GRP_WORK
类型的群组(即好友工作群)不支持此操作。TencentCloudChat.TYPES.GRP_AVCHATROOM
类型的群组(即直播群)不支持此操作。chat.setGroupMemberRole(options);
Name | Type | Description |
groupID | String | 群组 ID 或 话题 ID |
userID | String | 用户 ID |
role | String | 可选值: TencentCloudChat.TYPES.GRP_MBR_ROLE_ADMIN (群管理员),TencentCloudChat.TYPES.GRP_MBR_ROLE_MEMBER (群普通成员),TencentCloudChat.TYPES.GRP_MBR_ROLE_CUSTOM (自定义群成员角色,仅社群支持) |
Promise
let promise = chat.setGroupMemberRole({groupID: 'group1',userID: 'user1',role: TencentCloudChat.TYPES.GRP_MBR_ROLE_ADMIN // 将群 ID: group1 中的用户:user1 设为管理员});promise.then(function(imResponse) {console.log(imResponse.data.group); // 修改后的群资料console.log(imResponse.data.member); // 修改后的群成员资料}).catch(function(imError) {console.warn('setGroupMemberRole error:', imError); // 错误信息});
chat.getGroupOnlineMemberCount(groupID);
Name | Type | Description |
groupID | String | 群组 ID |
Promise
// 查询直播群在线人数let promise = chat.getGroupOnlineMemberCount('group1');promise.then(function(imResponse) {console.log(imResponse.data.memberCount);}).catch(function(imError) {console.warn('getGroupOnlineMemberCount error:', imError); // 获取直播群在线人数失败的相关信息});
本页内容是否解决了您的问题?