Skip to main content

add_friend


Brief Description

  • fromUserID sends a friend request to toUserID.

Request Method

  • post

Request URL

  • {API_ADDRESS}/friend/add_friend
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringoperationID is used for global link tracking
tokeneyJhbxxxx3XsRequiredstringAdministrator token

Request Sample Parameters

{
"fromUserID": "11111111",
"toUserID": "11111113",
"reqMsg": "hello!",
"ex": ""
}
Field NameOptionalTypeDescription
fromUserIDRequiredstringThe user initiating the friend request
toUserIDRequiredstringThe user receiving the friend request
reqMsgOptionalstringRequest message
exOptionalstringExtension field

Successful Return Sample

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

Successful Return Sample Explanation

Parameter NameTypeDescription
errCodeintError code, 0 indicates success
errMsgstringBrief error message, empty when no error
errDlterrDltDetailed error message, empty when no error
dataobjectGeneral data object, the specific structure is shown below (Note: No data object is provided)

Failed Return Sample

{
"errCode": 1301,
"errMsg": "CanNotAddYourselfError",
"errDlt": "[1301]CanNotAddYourselfError"
}

Failed Return Sample Explanation

Parameter NameTypeDescription
errCodeintError code, refer to the global error code document
errMsgstringBrief error message
errDlterrDltDetailed error message