tencent cloud

文档反馈

JavaScript

最后更新时间:2024-11-15 10:51:59

    获取群成员资料

    说明:
    1. TencentCloudChat.TYPES.GRP_AVCHATROOM 类型的群组(即直播群)不支持此操作,错误码 2687。
    2. 每次查询的用户数上限是50。如果传入的数组长度大于 50,则只取前 50 个用户进行查询,其余丢弃。
    接口
    chat.getGroupMemberProfile(options);
    参数
    参数 optionsObject 类型,包含的属性值如下:
    参数
    类型
    说明
    groupID
    String
    群组 ID。
    userIDList
    Array
    要查询的群成员用户 ID 列表。
    memberCustomFieldFilter
    Array | undefined
    群成员自定义字段筛选。可选,若不填,则默认查询所有群成员自定义字段。
    返回值
    Promise
    示例
    let 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);
    });

    设置群成员名片

    说明:
    1. TencentCloudChat.TYPES.GRP_AVCHATROOM 类型的群组(即直播群)不支持此操作。
    2. 操作权限说明:
    群主:可设置所有群成员的名片。
    管理员:可设置自身和其他普通群成员的群名片。
    普通群成员:只能设置自身群名片。
    接口
    chat.setGroupMemberNameCard(options);
    参数
    参数 optionsObject类型,包含的属性值如下:
    参数
    类型
    说明
    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); // 设置群成员名片失败的相关信息
    });

    设置群成员自定义字段

    说明:
    1. TencentCloudChat.TYPES.GRP_AVCHATROOM 类型的群组(即直播群)不支持此操作, 错误码 2687。
    2. 普通群成员只能设置自己的自定义字段。
    接口
    chat.setGroupMemberCustomField(options);
    参数
    参数 optionsObject 类型,包含的属性值如下:
    参数
    类型
    说明
    groupID
    String
    群组 ID 或 话题 ID。
    userID
    String | undefined
    可选,不填则修改自己的群成员自定义字段。
    memberCustomField
    Array
    群成员自定义字段。
    数组元素的结构如下:
    key --- String --- 自定义字段的 Key
    value --- String --- 自定义字段的 Value
    返回值
    Promise
    示例
    let 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); // 设置群成员自定义字段失败的相关信息
    });

    标记群成员

    说明:
    1. 仅支持直播群(AVChatRoom),且只有群主才有权限标记群组中其他成员。
    2. 使用该接口需要您购买进阶版套餐。
    接口
    chat.markGroupMemberList(options);
    参数
    参数 optionsObject类型,包含的属性值如下:
    参数
    类型
    说明
    groupID
    String
    群组 ID 或 话题 ID。
    userIDList
    Array
    群成员 userID 列表,单次请求最多 500 个群成员。
    markType
    Number
    标记类型。大于等于 1000,您可以自定义,一个直播群里最多允许定义 10 个标记。
    enableMark
    Boolean
    true 表示添加标记,false 表示移除标记。
    返回值
    Promise
    示例
    let 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);
    });
    
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持