功能说明
设置置顶会话。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/recentcontact/top?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名： 中国： console.tim.qq.com新加坡： adminapisgp.im.qcloud.com首尔： adminapikr.im.qcloud.com东京： adminapijpn.im.qcloud.com法兰克福： adminapiger.im.qcloud.com硅谷： adminapiusa.im.qcloud.com雅加达： adminapiidn.im.qcloud.com |
v4/recentcontact/top | 请求接口。 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID。 |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数，取值范围0 - 4294967295。 |
contenttype | 请求格式固定值为 json。 |
最高调用频率
200次/秒。
请求包示例
{"From_Account":"id1","OperationType":1,"RecentContactItem": [{"Type": 1,"To_Account": "id2"},{"Type": 2,"GroupId": "group1"}]}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
From_Account | String | 必填 | 请求设置该用户的会话。 |
OperationType | Integer | 必填 | 置顶类型： 1 表示置顶会话。 2 表示取消置顶。 |
RecentContactItem | Array | 必填 | 会话对象数组。 |
Type | Integer | 必填 | 会话类型： 1 表示 C2C 会话（单聊会话）。 2 表示 G2C 会话（群聊会话）。 |
To_Account | String | 必填 | C2C 会话才赋值，C2C 会话的 UserID。 |
GroupId | String | 选填 | G2C 会话才赋值，G2C 会话的群 ID。 |
应答包体示例
{"ActionStatus": "OK","ErrorCode": 0,"ErrorInfo": "","ErrorDisplay": ""}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求包的处理结果： OK 表示处理成功。 FAIL 表示失败。 |
ErrorCode | Integer | 错误码： 0表示成功。 非0表示失败，非0取值的详细描述请参见 错误码说明。 |
ErrorInfo | String | 详细错误信息。 |
ErrorDisplay | String | 详细的客户端展示信息。 |
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。实际的错误码、错误信息是通过应答包体中的 ErrorCode 以及 ErrorInfo 来表示的。
本 API 私有错误码如下：
错误码 | 描述 |
50001 | 请求的 UserID 没有导入即时通信 IM，请先将 UserID 导入即时通信 IM。 |
50002 | 请求参数错误，请根据错误描述检查请求参数。 |
50003 | 请求需要 App 管理员权限。 |
50004 | 服务端内部错误，请重试。 |
50005 | 网络超时，请稍后重试。 |
