create_group
Brief Description
- Create a group.
Request Method
post
Request URL
http://x.x.x.x:10002/group/create_group
Header
Header Name | Example Value | Optional | Type | Description |
---|---|---|---|---|
operationID | 1646445464564 | Required | string | operationID used for global link tracking |
token | eyJhbxxxx3Xs | Required | string | Admin token |
Request Parameter Example
{
"memberUserIDs": [
"1225441072"
],
"adminUserIDs": [
"2065939257"
],
"ownerUserID": "1054527962",
"groupInfo": {
"groupID": "xadxwr24",
"groupName": "your group name",
"notification": "notification",
"introduction": "introduction",
"faceURL": "faceURL url",
"ex": "ex",
"groupType": 2,
"needVerification": 0,
"lookMemberInfo": 0,
"applyMemberFriend": 0
}
}
Field Name | Optional | Type | Description |
---|---|---|---|
memberUserIDs | Required | array | Group member list |
adminUserIDs | Required | array | Group admin list |
ownerUserID | Required | string | Group owner |
groupInfo | Required | object | Group Information list |
groupInfo.groupID | Optional | string | |
groupInfo.groupName | Required | string | |
groupInfo.notification | Required | string | |
groupInfo.introduction | Required | string | |
groupInfo.faceURL | Required | string | |
groupInfo.ex | Required | string | |
groupInfo.groupType | Required | int | |
groupInfo.needVerification | Required | int | |
groupInfo.lookMemberInfo | Required | int | |
groupInfo.applyMemberFriend | Required | int |
Successful Response Example
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"groupInfo": {
"groupID": "xadxwr24",
"groupName": "your 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": ""
}
}
}
Successful Response Parameter Description
Parameter Name | Type | Description |
---|---|---|
errCode | int | Error code, 0 indicates success |
errMsg | string | Brief error message, empty when no error |
errDlt | errDlt | Detailed error message |
data | object | Generic data object, specific structure as below |
groupInfo | object | Group Information list |
Failed Response Example
{
"errCode": 1202,
"errMsg": "GroupIDExisted",
"errDlt": "group id existed xadxwr24: [1202]GroupIDExisted"
}
Failed Response Parameter Description
Parameter Name | Type | Description |
---|---|---|
errCode | int | Error code, refer to global error code documentation for specifics |
errMsg | string | Brief error message |
errDlt | errDlt | Detailed error message |