产品动态
公告
TencentCloudChat.TYPES.GRP_AVCHATROOM 类型的群组（即直播群）不支持此操作，错误码 2687。chat.getGroupMemberProfile(options);
options 为 Object 类型，包含的属性值如下：参数 | 类型 | 说明 |
groupID | String | 群组 ID。 |
userIDList | Array | 要查询的群成员用户 ID 列表。 |
memberCustomFieldFilter | Array | undefined | 群成员自定义字段筛选。可选，若不填，则默认查询所有群成员自定义字段。 |
Promiselet promise = chat.getGroupMemberProfile({groupID: 'group1',userIDList: ['user1', 'user2'], // 注意：即使只获取一个群成员的资料，也要用数组类型，例如：userIDList: ['user1']memberCustomFieldFilter: ['group_member_custom'], // 筛选群成员自定义字段：group_member_custom});promise.then(function(imResponse) {console.log(imResponse.data.memberList); // 群成员列表}).catch(function(imError) {console.warn('getGroupMemberProfile error:', imError);});
TencentCloudChat.TYPES.GRP_AVCHATROOM 类型的群组（即直播群）不支持此操作。chat.setGroupMemberNameCard(options);
options 为 Object类型，包含的属性值如下：参数 | 类型 | 说明 |
groupID | String | 群组 ID 或话题 ID。 |
userID | String | undefined | 可选，默认修改自身的群名片。 |
nameCard | String | 群成员名片。 |
Promise let promise = chat.setGroupMemberNameCard({groupID: 'group1',userID: 'user1',nameCard: '用户名片',});promise.then(function(imResponse) {console.log(imResponse.data.group); // 设置后的群资料console.log(imResponse.data.member); // 修改后的群成员资料}).catch(function(imError) {console.warn('setGroupMemberNameCard error:', imError); // 设置群成员名片失败的相关信息});
TencentCloudChat.TYPES.GRP_AVCHATROOM 类型的群组（即直播群）不支持此操作， 错误码 2687。chat.setGroupMemberCustomField(options);
options为 Object 类型，包含的属性值如下：参数 | 类型 | 说明 |
groupID | String | 群组 ID 或 话题 ID。 |
userID | String | undefined | 可选，不填则修改自己的群成员自定义字段。 |
memberCustomField | Array | 群成员自定义字段。 数组元素的结构如下： key --- String --- 自定义字段的 Key value --- String --- 自定义字段的 Value |
Promiselet promise = chat.setGroupMemberCustomField({groupID: 'group1',memberCustomField: [{key: 'group_member_test', value: 'test'}],});promise.then(function(imResponse) {console.log(imResponse.data.group); // 修改后的群资料console.log(imResponse.data.member); // 修改后的群成员资料}).catch(function(imError) {console.warn('setGroupMemberCustomField error:', imError); // 设置群成员自定义字段失败的相关信息});
chat.markGroupMemberList(options);
options为 Object类型，包含的属性值如下：参数 | 类型 | 说明 |
groupID | String | 群组 ID 或 话题 ID。 |
userIDList | Array | 群成员 userID 列表，单次请求最多 500 个群成员。 |
markType | Number | 标记类型。大于等于 1000，您可以自定义，一个直播群里最多允许定义 10 个标记。 |
enableMark | Boolean | true 表示添加标记，false 表示移除标记。 |
Promiselet promise = chat.markGroupMemberList({groupID: 'group1',userIDList: ['user1', 'user2'],markType: 1000,enableMark: true,});promise.then(function(imResponse) {// 标记成功const { successUserIDList, failureUserIDList } = imResponse.data;// successUserIDList - 标记成功的 userID 列表// failureUserIDList - 标记失败的 userID 列表}).catch(function(imError) {console.warn('markGroupMemberList error:', imError); // 标记群成员失败的相关信息});
// 获取直播群指定标记的在线成员列表// 从 0 开始拉取，默认一次最多返回 500 个群成员let promise = chat.getGroupMemberList({ groupID: 'group1', filter: 1000, offset: 0 });promise.then(function(imResponse) {console.log(imResponse.data.memberList); // 群成员列表}).catch(function(imError) {console.warn('getGroupMemberList error:', imError);});
文档反馈