该接口用于将指定的会话置顶或取消置顶。

调用频率

单个应用默认最高调用频率请参考 频控说明。

请求信息

请求 URL

PATCH https://{endpoint}/im/v2/conversations/{conversation_id}/actions/stick_top_conversation

请求 URL 中的 {endpoint} 代表服务地址域名，您可以根据用户服务区域选择中国大陆和海外服务地址，并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。

请求头参数

请求 Header 的参数说明请参考 请求 Header。

路径参数

参数名称	类型	是否必选	说明	示例
conversation_id	String	是	会话 ID，若传入的会话 ID 不存在会返回 414 错误码。	单聊会话：account_id1|1|account_id2 高级群会话：account_id1|2|team_id 超大群会话：account_id1|3|team_id

请求体参数

参数名称	类型	是否必选	描述
top_type	Integer	是	是否置顶指定的会话。1：置顶；0：取消置顶。

请求体示例

JSON{
  "top_type": 1
}

响应信息

响应头参数

响应 Header 的参数说明请参考 响应 Header。

响应体参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	空对象。	是
type	Integer	会话类型，1：单聊会话；2：高级群会话；3：超大群会话。	是
conversation_id	String	会话 ID。	是
sender_id	String	会话我方的账号 ID。	是
receiver_id	String	会话对方的账号 ID 或群组 ID。	是
stick_top	Boolean	是否为置顶会话。	是
sort_order	Long	会话排序字段，默认将置顶会话排首位，如有多条置顶会话，则按其创建时间进行排序。	是
update_time	Long	会话更新时间（毫秒）。	是

响应体示例

JSON{
  "code": 200,
  "msg": "success",
  "data": {
    "type": 1,
    "conversation_id": "qaz|1|qaz1",
    "sender_id": "qaz",
    "receiver_id": "qaz1",
    "stick_top": false,
    "sort_order": 1753350855657,
    "update_time": 1753350855657
  }
}

错误码

本文仅列举部分业务接口错误码，完整列表请参考客户端 API 错误码。

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
102404	用户不存在	account not exist
500	服务器内部错误	internal server error