从黑名单中移除用户

功能说明

• 从用户的黑名单中移除一个用户。
• 将好友从黑名单中移除后，恢复好友关系，可以正常收发消息。
• 将非好友从黑名单中移除后，恢复到未添加好友的状态。若好友关系检查开关关闭，这两个用户可以正常收发消息。
• 调用该接口会触发解除拉黑好友的发送后回调事件，详见 回调事件文档。

功能开通

若使用该 API，你需要在环信控制台免费开通黑名单功能。详见 环信控制台文档。

调用频率上限

100 次/秒/App Key

请求 URL

DELETE https://{host}/{org_name}/{app_name}/users/{owner_username}/blocks/users/{blocked_username}

参数	类型	是否必需	描述
owner_username	String	是	从哪个用户的黑名单中移除用户。
blocked_username	String	是	要移出黑名单的用户 ID。

关于请求 URL 中的其他参数说明，详见 请求 URL 参数介绍。

请求示例

curl -X DELETE 'https://XXXX/XXXX/XXXX/users/user1/blocks/users/user2'  \
-H 'Accept: application/json'   \
-H 'Authorization: Bearer <YourAppToken>' 

请求 header 字段

关于 Accept 和 Authorization 字段的说明，详见 请求 header 参数说明。

响应示例

{
  "action": "delete",
  "application": "8bXXXX402",
  "path": "/users/475XXXXba/blocks",
  "uri": "https://XXXX/XXXX/XXXX/users/475XXXXba/blocks",
  "entities": [
    {
      "uuid": "b2aXXXXf1",
      "type": "user",
      "created": 1542356523769,
      "modified": 1542597334500,
      "username": "user2",
      "activated": true,
      "nickname": "testuser"
    }
  ],
  "timestamp": 1542600712985,
  "duration": 20,
  "organization": "XXXX",
  "applicationName": "testapp"
}

响应 body 字段

如果返回的 HTTP 状态码为 200，表示请求成功，响应包体中 entities 字段的说明如下：

参数	类型	描述
entities	JSON Array	从黑名单中移除的用户的详细信息。
- uuid	String	用户在系统内的唯一标识。系统自动生成，开发者无需关心。
- type	String	对象类型，值为 user。
- created	Long	用户创建时间，Unix 时间戳，单位为毫秒。
- modified	Long	用户信息如密码或昵称等的最新修改时间，Unix 时间戳，单位为毫秒。
- username	String	被移出黑名单的用户 ID。
- activated	Bool	用户是否为正常状态： • true 该用户为正常状态。 • false 该用户为封禁状态。
- nickname	String	被移出黑名单的用户的昵称。

响应包中其他字段的说明如下：

参数	类型	描述
action	String	请求方法。
application	String	系统内为应用生成的唯一标识，开发者无需关心。
path	String	请求路径，属于请求 URL 的一部分，开发者无需关注。
uri	String	请求 URL。
timestamp	Long	HTTP 响应的 Unix 时间戳，单位为毫秒。
duration	Long	从发送 HTTP 请求到响应的时长, 单位为毫秒。
organization	String	环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 org_name 相同。
applicationName	String	你在环信控制台创建应用时填入的应用名称，与请求参数 app_name 相同。

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考 错误码 了解可能的原因。

错误码

HTTP 状态码	错误类型	错误提示	可能原因	处理建议
401	unauthorized	Unable to authenticate (OAuth)	token 不合法，可能过期或 token 错误。	使用新的 token 访问。
404	service_resource_not_found	Service resource not found	要移除或被移除的用户 ID 不存在。	检查要移除和被移除的用户 ID 是否存在。