Skip to main content

add_friend


Description

  • fromUserID initiates a friend request to toUserID.

Request Method

  • POST

Request URL

  • {API_ADDRESS}/friend/add_friend
Header NameExample ValueRequiredTypeDescription
operationID1646445464564RequiredstringUsed for global traceability, suggested as a unique timestamp per request
tokeneyJhbxxxx3XsRequiredstringAdmin token

Request Parameters Example

{
"fromUserID": "11111111",
"toUserID": "11111113",
"reqMsg": "hello!",
"ex": ""
}
Field NameRequiredTypeDescription
fromUserIDRequiredstringID of the user initiating the request
toUserIDRequiredstringID of the user receiving the request
reqMsgOptionalstringRequest message
exOptionalstringExtended field

Success Response Example

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

Success Response Parameter Description

ParameterTypeDescription
errCodeintError code, 0 indicates success
errMsgstringBrief error message, empty if successful
errDltstringDetailed error information, empty if successful

Failure Response Example

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

Failure Response Parameter Description

ParameterTypeDescription
errCodeintError code; refer to global error code documentation
errMsgstringBrief error message
errDltstringDetailed error information