单向删除会话
# 单向删除会话你可以从服务器中单向删除会话，并且设置是否删除该会话在服务端的漫游消息。删除会话后，该用户将从服务器获取不到该会话。该会话的其他参与聊天用户仍然可以从服务器获取会话内容。
# 前提条件要调用即时通讯 RESTful API，请确保满足以下要求：
已在声网控制台open in new window开通配置即时通讯 IM 服务。已从服务端获取 app token，详见 使用 Token 鉴权。了解即时通讯 IM API 的调用频率限制，详见 接口频率限制。# 认证方式即时通讯 IM RESTful API 要求 Bearer HTTP 认证。每次发送 HTTP 请求时，都必须在请求头部填入如下 Authorization 字段：
Authorization: Bearer YourAppToken
为提高项目的安全性，声网使用 Token（动态密钥）对即将登录即时通讯系统的用户进行鉴权。即时通讯 IM RESTful API 推荐使用 app token 的 鉴权方式，详见 使用 Token 鉴权。
# HTTP 请求DELETE https://{host}/app-id/{app_id}/users/{username}/user_channel
# 路径参数参数类型是否必需描述hostString是即时通讯 IM 分配的用于访问 RESTful API 的域名。app_idString是声网为每个项目自动分配的 App ID，作为项目唯一标识。usernameString是要删除会话的用户的唯一标识符，即用户 ID。# 请求 header参数类型是否必需描述AuthorizationString是App 管理员的鉴权 token，格式为 Bearer YourAppToken，其中 Bearer 为固定字符，后面为英文空格和获取到的 app token。# 请求 body参数类型是否必需描述channelString是要删除的会话 ID。该参数的值取决于会话类型 type 的值: - type 为 chat，即单聊时，会话 ID 为对端用户 ID； - type 为 groupchat，即群聊时，会话 ID 为群组 ID。typeString是会话类型。 - chat：单聊会话； -groupchat：群聊会话。delete_roamBool是是否删除该会话在服务端的漫游消息。 - true：是。若删除了该会话的服务端消息，则用户无法从服务器拉取该会话的漫游消息。 - false：否。用户仍可以从服务器拉取该会话的漫游消息。# HTTP 响应# 响应 body如果返回的 HTTP 状态码为 200，表示请求成功，响应包体中包含以下字段：
参数类型描述pathString请求路径，属于请求 URL 的一部分，开发者无需关注。uriString请求 URL。timestampLongHTTP 响应的 Unix 时间戳，单位为毫秒。entitiesJSON响应实体。actionString请求方法。dataJSON删除结果详情。data.resultString删除结果，ok 表示成功，失败则直接返回错误码和原因。durationInt从发送 HTTP 请求到响应的时长，单位为毫秒。如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考 响应状态码 了解可能的原因。# 示例# 请求示例# 将
curl -L -X DELETE 'https://XXXX/app-id/XXXX/users/u1/user_channel' \
-H 'Authorization: Bearer
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"channel": "u2",
"type": "chat",
"delete_roam": true
}'
# 响应示例{
"path": "/users/user_channel",
"uri": "https://XXXX/XXXX/XXXX/users/u1/user_channel",
"timestamp": 1638440544078,
"entities": [],
"action": "delete",
"data": {
"result": "ok"
},
"duration": 3
}
# 错误码如果返回的 HTTP 状态码非 200，表示请求失败，可能提示以下错误码：
HTTP 状态码错误类型错误提示可能原因处理建议400invalid_request_bodyRequest body is invalid. Please check body is correct.请求体格式不正确。检查请求体内容是否合法(字段类型是否正确) 。400illegal_argumentfield channel cannot be null or empty请求参数 channel 是空字符串输入正确的请求参数 channel。400illegal_argumentfield type cannot be null or empty请求参数 type 是空字符串。输入正确的请求参数 type。400illegal_argumentfield delete_roam cannot be null请求参数 delete_roam 是空。输入正确的请求参数delete_roam。关于其他错误，你可以参考 响应状态码 了解可能的原因。