Skip to main content

Apply to Join Group

Brief Description

  • User apply to join group. When the group setting is allow anyone to join, the user will join the group directly, otherwise the group owner or admin need to agree to proceed.

Request Method

  • post

Request URL

  • {API_ADDRESS}/group/join_group
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringUsed for global link tracking, timestamp is recommended, independent in each request
tokeneyJhbxxxx3XsRequiredstringAdmin token

Request Parameter Example

{
"groupID": "xadxwr24",
"reqMessage": "req msg join group",
"joinSource": 0,
"inviterUserID": "4251711209"
}
Field NameOptionalTypeDescription
groupIDRequiredstringGroup ID
reqMessageOptionalstringApplying message
joinSourceRequiredintJoining source, 1: admin invite, 2: be invited, 3: search join, 4: scan code join
inviterUserIDRequiredstringApplier ID
exOptionalstringExtension field

Success Return Example

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

Parameter Description for Success Return Example

Parameter NameTypeDescription
errCodeintError code, 0 means successful
errMsgstringBrief error message, empty
errDlterrDltDetailed error message, empty
dataobjectGeneric data object, specific structure is below

Failure Return Example

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

Parameter Description for Failure Return Example

Parameter NameTypeDescription
errCodeintError code, specifically check the global error code document
errMsgstringBrief error message
errDlterrDltDetailed error message