Skip to main content

create_group

Brief Description

  • Create a group.

Request Method

  • post

Request URL

  • http://x.x.x.x:10002/group/create_group
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringoperationID used for global link tracking
tokeneyJhbxxxx3XsRequiredstringAdmin 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 NameOptionalTypeDescription
memberUserIDsRequiredarrayGroup member list
adminUserIDsRequiredarrayGroup admin list
ownerUserIDRequiredstringGroup owner
groupInfoRequiredobjectGroup Information list
groupInfo.groupIDOptionalstring
groupInfo.groupNameRequiredstring
groupInfo.notificationRequiredstring
groupInfo.introductionRequiredstring
groupInfo.faceURLRequiredstring
groupInfo.exRequiredstring
groupInfo.groupTypeRequiredint
groupInfo.needVerificationRequiredint
groupInfo.lookMemberInfoRequiredint
groupInfo.applyMemberFriendRequiredint

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 NameTypeDescription
errCodeintError code, 0 indicates success
errMsgstringBrief error message, empty when no error
errDlterrDltDetailed error message
dataobjectGeneric data object, specific structure as below
groupInfoobjectGroup Information list

Failed Response Example

{
"errCode": 1202,
"errMsg": "GroupIDExisted",
"errDlt": "group id existed xadxwr24: [1202]GroupIDExisted"
}

Failed Response Parameter Description

Parameter NameTypeDescription
errCodeintError code, refer to global error code documentation for specifics
errMsgstringBrief error message
errDlterrDltDetailed error message