Request to Join Group

Brief Description

• Allows a user to request to join a group. If the group is set to allow anyone to join, the user will be added directly; otherwise, the request must be approved by the group owner or an administrator.

Request Method

• post

Request URL

• {API_ADDRESS}/group/join_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

{
 "groupID": "xadxwr24",
 "reqMessage": "req msg join group",
 "joinSource": 0,
 "inviterUserID": "4251711209"
}

Field Name	Optional	Type	Description
groupID	Required	string	Group ID
reqMessage	Optional	string	Application message
joinSource	Required	int	Source of join request: 1 = Admin invitation, 2 = Invited, 3 = Search, 4 = QR code
inviterUserID	Required	string	Applicant's user ID
ex	Optional	string	Extension field

Success Response Example

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": ""
}

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

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