该接口用于更新指定会话的扩展信息。

调用频率

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

请求

URL

PATCH https://open.yunxinapi.com/im/v2/conversations/:{conversation_id}

Header

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

路径参数

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

请求体参数

参数名称	类型	是否必选	描述
server_extension	String	可选	需要更新的会话扩展字段，长度上限为 1024 位字符。

请求体示例

json{
    "server_extension":"extension"
}

响应

Header

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

响应体参数

参数名称	类型	描述	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
+ data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
conversation_id	String	会话 ID。	是
sender_id	String	会话消息发送者的账号 ID。	否
receiver_id	String	接收会话消息的账号 ID 或群组 ID。	否
type	Integer	会话类型，1：单聊会话；2：高级群会话；3：超大群会话。	是
stick_top	Boolean	是否为置顶会话。	是
group_ids	Array of longs	会话所属分组列表。	是
server_extension	String	服务端扩展字段。	是
message_state	Integer	0：表示普通消息；1：表示撤回消息。	是
last_message	Object	会话中的最后一条消息。如果是撤回消息，该字段为空，具体内容参见 revoke_message。	否
+ revoke_message	Object	消息撤回通知。message_state 为 1 时返回。	否
server_id	Long	被撤回的消息 ID。	否
attach	String	被撤回的消息的附件信息。	否
revoke_id	String	消息撤回者的账号 ID。	否
custom_info	String	服务端撤回填入的自定义信息。	否
revoke_type	Integer	消息撤回类型。0：未定义；1：单聊双向撤回；2：群聊双向撤回；3：单聊单向撤回；4：群聊单向撤回。	否
unread_count	Integer	会话消息未读数。	是
sort_order	Long	会话排序字段，默认将置顶会话排首位，如有多条置顶会话，则按其创建时间进行排序。	是
create_time	Long	会话创建时间（毫秒）。	是
update_time	Long	会话更新时间（毫秒）。	是

响应体示例

json{
    "code":200,
    "msg":"success",
    "data":{
            "conversation_id": "Accid1|1|Accid2",
            "type": 1,   
            "stick_top": true,  
            "group_ids": [1,2,3],
            "server_extension":"extension",  
            "unread_count":0,  
            "sort_oder":1,
            "create_time":1,     
            "update_time":1
    }
}

错误码

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