跳到主要内容

会话置顶

设置会话是否置顶。

服务端会保存会话置顶状态。如果客户端 SDK 4.0.0 及之后版本，通过客户端设置的会话置顶状态会被同步到服务端，在切换设备时可自动同步。

您还可以使用服务端 API 接口进行设置会话是否置顶。设置生效后，最新的置顶状态信息会被自动同步到客户端 SDK。您可以使用最新状态数据更新 UI。

提示

如果客户端 SDK 版本早于 4.0.0 版本，您通过服务端 API 接口设置的会话置顶状态不会被同步到客户端。

请求方法​

POST： https://数据中心域名/conversation/top/set.json

频率限制： 每秒钟限 100 次

签名规则： 所有服务端 API 请求均需要进行规则校验，详见 API 请求签名。

正文参数​

HTTP 请求正文数据格式为 application/x-www-form-urlencoded，支持以下 HTTP 表单参数：

参数类型必传说明
userIdString是用户 ID，会话所属的用户
conversationTypeString是会话类型。支持的会话类型包括：1（二人会话）、3（群组会话）、6（系统会话）。
targetIdString是需要设置的目标 ID，根据会话类型不同为单聊用户 ID、群聊 ID、系统目标 ID
setTopString是true 表示置顶，false 表示取消置顶。

请求示例​

POST /conversation/top/set.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

userId=XivuFwkcl&targetId=RfqHbcjes&conversationType=1&setTop=true

返回结果​

HTTP 响应正文包含具有以下结构的 JSON 对象：

返回值返回类型说明
codeNumber返回码，200 为正常。

返回结果示例​

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}
最后于 更新