外观
创建群聊
约 498 字大约 2 分钟
2025-03-25
1. 描述
createGroup() 创建群聊,该方法为异步函数,调用后会返回一个 Promise 对象,通过该对象可以获取到创建的群聊的相关信息。
2. 参数
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| userIds | 是 | String[] | 成员ID列表,至少 2 人,不能包含自己,接口会自动添加自己到群聊 |
| name | 否 | String | 群聊名称,不传递则默认使用当前成员的昵称拼接为群名 |
| groupId | 否 | String | 群聊ID,支持传入自定义群聊ID(保证唯一性),不传则由系统自动生成 |
3. 返回值
返回一个 Promise 对象,成功时回调函数的参数为 Group 对象,失败时回调函数的参数为错误信息。
| 字段 | 类型 | 说明 |
|---|---|---|
| groupId | String | 群聊ID |
| users | Number | 群成员数量 |
| name | String | 群聊名称,默认为群成员昵称拼接 |
| profile | String | 群资料对象字符串,详细格式见下 |
| lastMessage | String | 最后一条消息对象字符串,详细格式见下 |
| conversationType | String | 会话类型,群聊固定为 group |
3.1 profile
群资料对象字符串,格式如下:
| 字段 | 类型 | 说明 |
|---|---|---|
| groupId | String | 群聊ID |
| users | Number | 群成员数量 |
| userId | String | 群主ID |
| name | String | 群聊名称,默认为群成员昵称拼接 |
3.2 lastMessage
最后一条消息对象字符串,格式如下:
| 字段 | 类型 | 说明 |
|---|---|---|
| type | String | 消息类型,详见 消息类型 |
| content | Object | 消息体,格式详见如下 |
| createTime | String | 发送时间 |
- 消息体格式
| 字段 | 类型 | 说明 |
|---|---|---|
| data | String/Object | 消息对象,消息类型不同,内容格式不同,可以参考文档手册中的消息模块 |
| at | Array | @数据对象,主要为群聊成员对象数组 |
| quit | Object | 引用消息时原消息对象 |
4. 示例代码
XBCIM.createGroup({
name: '测试群聊',
userIds: ['user1', 'user2', 'user3']
}).then((group) => {
console.log('创建群聊成功', group);
}).catch((error) => {
console.log('创建群聊失败', error);
});