加入黑名单

使用 加入黑名单 将目标用户加入指定用户的黑名单。黑名单属于好友关系模块的数据能力。

HTTP 请求

POST {API_ADDRESS}/friend/add_black

请求示例

curl --request POST "${API_ADDRESS}/friend/add_black" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: 1646445464564" \
  --header "token: ${ADMIN_TOKEN}" \
  --data-raw '{
  "ownerUserID": "user_001",
  "blackUserID": "user_002",
  "ex": ""
}'

安全提示：管理员 Token 只能保存在可信后端服务中，不能下发到客户端或写入前端代码。好友关系接口通常应由业务后端在完成用户权限校验后调用。

参数

此接口通过请求头传入链路追踪信息和鉴权凭证，通过 JSON 请求体传递业务参数。

请求头

请求体参数

{
  "ownerUserID": "user_001",
  "blackUserID": "user_002",
  "ex": ""
}

响应

请求被 OpenIM 正常处理时通常返回 200 OK。业务是否成功以响应体中的 errCode 为准；errCode === 0 表示成功，非 0 表示业务错误。

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

响应属性列表

错误

如果请求失败，OpenIM 返回错误对象。更多错误码说明见错误码。

{
  "errCode": 1001,
  "errMsg": "ArgsError",
  "errDlt": "invalid request parameters"
}

常见错误场景