Skip to main content

import_friend

Brief Description

  • Establish a friendship between a specified user (ownerUserID) and multiple users (friendUserIDs).

Request Method

  • post

Request URL

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

Request Sample Parameters

{
"ownerUserID": "2778222451",
"friendUserIDs": ["4776986466"]
}
Field NameOptionalTypeDescription
ownerUserIDRequiredstringSpecified user ID
friendUserIDsRequiredarrayList of specified friend IDs

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": 1003,
"errMsg": "DuplicateKeyError",
"errDlt": ": [1003]DuplicateKeyError"
}

Failed Return Sample Explanation

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