tencent cloud

文档反馈

JavaScript

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

    功能描述

    群资料指的是与群组相关的一些信息,相关属性在核心类 Group 中。

    获取群资料

    接口
    chat.getGroupProfile(options);
    参数
    参数 optionsObject类型,包含的属性值如下:
    Name
    Type
    Description
    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); // 获取群详细资料失败的相关信息
    });

    修改群资料

    说明:
    1. 此接口不支持修改最大群成员数量,如需修改请使用 REST API
    2. 该接口可以修改群组的邀请选项 inviteOption
    3. 群资料变更通知,不同类型的群通知方式不一样,详情请参见 群组-消息差异
    4. 直播群不支持设置 inviteOption
    接口
    chat.updateGroupProfile(options);
    参数
    参数 optionsObject类型,包含的属性值如下:
    Name
    Type
    Description
    groupID
    String
    群组 ID
    name
    String | undefined
    群名称,最长100字节,使用 UTF-8 编码,1个汉字占3个字节,不可调整
    avatar
    String | undefined
    群头像URL,最长500字节
    introduction
    String | undefined
    群简介,最长400字节,使用 UTF-8 编码,1个汉字占3个字节,不可调整
    notification
    String | undefined
    群公告,最长400字节,使用 UTF-8 编码,1个汉字占3个字节,不可调整
    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); // 修改群组资料失败的相关信息
    });
    
    联系我们

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

    技术支持

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

    7x24 电话支持