Invite to Group

Brief Description

• Invites users to join a group.

Request Method

• post

Request URL

• {API_ADDRESS}/group/invite_user_to_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": "2759960147",
  "invitedUserIDs": [
    "1225441072",
    "9906953281"
  ],
  "reason": "your reason"
}

Field Name	Optional	Type	Description
groupID	Required	string	Group ID
invitedUserIDs	Required	array	List of user IDs to be invited
reason	Optional	string	Reason for the invitation

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