Skip to main content

add_friend_response

Brief Description

  • Approve or reject the friend request initiated by fromUserID to toUserID.

Request Method

  • post

Request URL

  • http://x.x.x.x:10002/friend/add_friend_response
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringoperationID is used for global link tracking
tokeneyJhbxxxx3XsRequiredstringAdministrator token

Request Sample Parameters

{
"fromUserID": "11111111",
"toUserID": "11111112",
"handleResult": 1,
"handleMsg": "agree"
}
Field NameOptionalTypeDescription
fromUserIDRequiredstringRequest initiator
toUserIDRequiredstringRequest receiver
handleResultRequiredintHandling result, 1: Agree; -1: Reject
handleMsgRequiredstringHandling message

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": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": "==> github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/relation.(*FriendRequestGorm).Take()@52: : record not found"
}

Failed Return Sample Explanation

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