创建群组
简要描述
- 创建群组。
请求方式
post
请求URL
{API_ADDRESS}/group/create_group
Header
header名 | 示例值 | 选填 | 类型 | 说明 |
---|---|---|---|---|
operationID | 1646445464564 | 必填 | string | 用于全局链路追踪,建议使用时间戳,在每个请求中独立 |
token | eyJhbxxxx3Xs | 必填 | string | 管理员 token |
请求参数示例
{
"memberUserIDs": [
"1225441072"
],
"adminUserIDs": [
"2065939257"
],
"ownerUserID": "1054527962",
"groupInfo": {
"groupID": "xadxwr24",
"groupName": "yourg group name",
"notification": "notification",
"introduction": "introduction",
"faceURL": "faceURL url",
"ex": "ex",
"groupType": 2,
"needVerification": 0,
"lookMemberInfo": 0,
"applyMemberFriend": 0
}
}
字段名 | 选填 | 类型 | 说明 |
---|---|---|---|
memberUserIDs | 选填 | array | 群成员列表 |
adminUserIDs | 选填 | array | 群管理员列表 |
ownerUserID | 必填 | string | 群主 |
groupInfo | 必填 | object | 群信息列表 |
groupInfo.groupID | 选填 | string | 群ID |
groupInfo.groupName | 必填 | string | 群名称 |
groupInfo.notification | 选填 | string | 群公告 |
groupInfo.introduction | 选填 | string | 群介绍 |
groupInfo.faceURL | 选填 | string | 群头像地址 |
groupInfo.ex | 选填 | string | 群扩展字段 |
groupInfo.groupType | 必填 | int | 群类型,固定为2。 |
groupInfo.needVerification | 选填 | int | 进群是否需要验证 |
groupInfo.lookMemberInfo | 选填 | int | 能否查看其他群成员信息 |
groupInfo.applyMemberFriend | 选填 | int | 群成员是否允许添加好友 |
成功返回示例
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"groupInfo": {
"groupID": "xadxwr24",
"groupName": "yourg group name",
"notification": "notification",
"introduction": "introduction",
"faceURL": "faceURL url",
"ownerUserID": "199975690",
"createTime": 1679656402377,
"memberCount": 4,
"ex": "ex",
"status": 0,
"creatorUserID": "",
"groupType": 2,
"needVerification": 0,
"lookMemberInfo": 0,
"applyMemberFriend": 0,
"notificationUpdateTime": 0,
"notificationUserID": ""
}
}
}
成功返回示例的参数说明
参数名 | 类型 | 说明 |
---|---|---|
errCode | int | 错误码,0表示成功 |
errMsg | string | 错误简要信息,为空 |
errDlt | errDlt | 错误详细信息,为空 |
data | object | 通用数据对象,具体结构见下方 |
groupInfo | object | 群信息列表 |
失败返回示例
{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}
失败返回示例的参数说明
参数名 | 类型 | 说明 |
---|---|---|
errCode | int | 错误码,具体查看全局错误码文档 |
errMsg | string | 错误简要信息 |
errDlt | errDlt | 错误详细信息 |