OpenIMDocs

Type at least two characters to search titles and routes.

EN

Language

ENEnglishEnglish docs简中简体中文中文文档
Browse Platform API
Platform APIEnterprise

Delete received friend requests

Copy

Delete selected friend-request records received by a user. This endpoint is available only in OpenIM Enterprise.

HTTP request

POST {API_ADDRESS}/friend/delete_friend_requests_to_user

Request example

curl --request POST "${API_ADDRESS}/friend/delete_friend_requests_to_user" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" \
  --header "token: ${TOKEN}" \
  --data-raw '{"toUserID":"user_001","fromUserIDs":["user_002"]}'
Enterprise: This endpoint requires the corresponding OpenIM Enterprise services. Availability and permissions depend on the delivered version.

Request body

ParameterRequiredTypeDescription
toUserIDYesstringUser ID of the request recipient.
fromUserIDsYesstring[]User IDs of the request senders whose records are deleted.

Response

The API returns the common response envelope. errCode is 0 when the records were deleted successfully.

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

Errors

See Error codes for the common error structure.

Permissions and limits

  • Available only in OpenIM Enterprise.
  • The caller must validate its authority over the request recipient.
  • Request array limits follow the delivered server version.