Create Group

Brief Description

• Creates a new group.

Request Method

• post

Request URL

• {API_ADDRESS}/group/create_group

Header

Header Name	Example Value	Optional	Type	Description
operationID	1646445464564	Required	string	Used for global trace tracking. It is recommended to use a timestamp, unique for each request
token	eyJhbxxxx3Xs	Required	string	Admin token

Request Parameters Example

{
  "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
  }
}

Field Name	Optional	Type	Description
memberUserIDs	Optional	array	List of group members' user IDs
adminUserIDs	Optional	array	List of group admin user IDs
ownerUserID	Required	string	Group owner ID
groupInfo	Required	object	Group information
groupInfo.groupID	Optional	string	Group ID
groupInfo.groupName	Required	string	Group name
groupInfo.notification	Optional	string	Group announcement
groupInfo.introduction	Optional	string	Group introduction
groupInfo.faceURL	Optional	string	Group avatar URL
groupInfo.ex	Optional	string	Group extension field
groupInfo.groupType	Required	int	Group type, fixed as 2
groupInfo.needVerification	Optional	int	Whether joining the group requires verification
groupInfo.lookMemberInfo	Optional	int	Whether group members can view other members' information
groupInfo.applyMemberFriend	Optional	int	Whether group members are allowed to add friends

Success Response Example

{
  "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": ""
    }
  }
}

Success Response Parameters Description

Parameter Name	Type	Description
errCode	int	Error code, 0 indicates success
errMsg	string	Brief error message, empty if none
errDlt	errDlt	Detailed error information, empty if none
data	object	General data object, see structure below
groupInfo	object	Group information

Failure Response Example

{
  "errCode": 1004,
  "errMsg": "RecordNotFoundError",
  "errDlt": ": [1004]RecordNotFoundError"
}

Failure Response Parameters Description

Parameter Name	Type	Description
errCode	int	Error code, refer to global error code documentation
errMsg	string	Brief error message
errDlt	errDlt	Detailed error information