Docs Overview/
Chat/
服务端 API/
RESTful 接口/
会话相关/
删除会话/
删除会话/

删除会话

功能说明

删除指定会话，支持同步清理漫游消息。

接口调用说明

请求 URL 示例

https://xxxxxx/v4/recentcontact/delete?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参见 REST API 简介。
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名：
中国：console.tim.qq.com
新加坡：adminapisgp.im.qcloud.com
首尔： adminapikr.im.qcloud.com
法兰克福：adminapiger.im.qcloud.com
硅谷：adminapiusa.im.qcloud.com
雅加达：adminapiidn.im.qcloud.com
v4/recentcontact/delete
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

删除 C2C 会话

{
    "From_Account":"id1",
    "Type":1,
    "To_Account":"id2",
    "ClearRamble":1
}

删除 G2C 会话

{
    "From_Account":"id1",
    "Type":2,
    "ToGroupid":"id2",
    "ClearRamble":1
}

请求包字段说明

字段
类型
属性
说明
From_Account
String
必填
请求删除该 UserID 的会话
Type
Integer
必填
会话类型：1 表示 C2C 会话；2 表示 G2C 会话
To_Account
String
选填
C2C 会话才赋值，C2C 会话方的 UserID
ToGroupid
string
选填
G2C 会话才赋值，G2C 会话的群 ID
ClearRamble
Integer
选填
是否清理漫游消息：1 表示清理漫游消息；0 表示不清理漫游消息

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "ErrorDisplay": ""
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求包的处理结果，OK 表示处理成功，FAIL 表示失败
ErrorCode
Integer
错误码，0表示成功，非0表示失败，非0取值的详细描述请参见 错误码说明
ErrorInfo
String
详细错误信息
ErrorDisplay
String
详细的客户端展示信息

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。实际的错误码、错误信息是通过应答包体中的 ResultCode、ResultInfo、ErrorCode 以及 ErrorInfo 来表示的。
公共错误码（60000到79999）请参见 错误码。
本 API 私有错误码如下：
错误码
描述
50001
请求的 UserID 没有导入腾讯云移动通信后台，请先将 UserID 导入腾讯云移动通信后台
50002
请求参数错误，请根据错误描述检查请求参数
50003
请求需要 App 管理员权限
50004
服务端内部错误，请重试
50005
网络超时，请稍后重试

接口调试工具

通过 REST API 在线调试工具 调试本接口。