tencent cloud

即时通信 IM

动态与公告
产品动态
公告
产品简介
产品概述
基本概念
应用场景
功能介绍
账号系统
用户资料与关系链
消息管理
群组相关
公众号系统
音视频通话 Call
使用限制
购买指南
计费概述
价格说明
购买指引
续费指引
停服说明
退费说明
开发指引
Demo 专区
开通服务
体验 Demo
快速跑通
下载中心
SDK & Demo 源码
更新日志
聊天互动(含 UI)
TUIKit 组件介绍
快速开始
全功能接入
单功能接入
AI 集成
构建基础界面
更多特性
定义外观
国际化界面语言
推送服务(Push)
服务概述
名词解释
开通服务
快速跑通
厂商通道
数据统计
排查工具
客户端 API
服务端 API
推送回调
高级功能
更新日志
错误码
常见问题
智能客服
功能概述
快速入门
集成指引
管理员操作手册
客服操作手册
更多实践
直播间搭建
AI 聊天机器人方案
超大娱乐协作社群
Discord 实现指南
游戏内集成 Chat 指南
类 WhatsApp Channel 搭建方案
发送红包
Chat 应对防火墙限制相关
无 UI 集成
快速开始
集成 SDK
初始化
登录登出
消息相关
会话相关
群组相关
社群话题
用户管理
离线推送
云端搜索
本地搜索
公众号
客户端 API
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C 接口
C++
服务端 API
生成 UserSig
REST API
第三方回调
控制台指南
新版控制台介绍
创建并升级应用
基本配置
功能配置
账号管理
群组管理
公众号管理
回调配置
用量统计
资源包查看指南
实时监控
开发辅助工具
访问管理
高级功能
常见问题
uni-app 常见问题
购买相关问题
SDK 相关问题
账号鉴权相关问题
用户资料与关系链相关问题
消息相关问题
群组相关问题
直播群相关问题
昵称头像相关问题
协议与认证
服务等级协议
安全合规认证
IM 政策
隐私政策
数据隐私和安全协议
平滑迁移方案
平滑迁移完整版
平滑迁移简化版
错误码
联系我们

JavaScript

PDF
聚焦模式
字号
最后更新时间: 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); // 修改群组资料失败的相关信息
});


帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈