该接口用于更新指定的会话分组。

功能描述

• 更新会话分组名称。
• 更新会话分组的扩展信息。
• 在分组中添加会话，每次最多添加 100 个会话。
• 在分组中删除会话，每次最多删除 100 个会话。

调用频率

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

请求信息

请求 URL

PATCH https://{endpoint}/im/v2/conversation_groups/{group_id}

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

请求头参数

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

路径参数

参数名称	类型	是否必选	描述
group_id	Long	是	会话分组 ID。

请求体参数

参数名称	类型	是否必选	描述
account_id	String	是	IM 账号 ID。
name	String	否	更新后的会话分组名称。
server_extension	String	否	更新后的会话分组扩展字段。
- conversations	Object	否	会话列表。
type	Integer	是	操作类型。1：在会话分组中添加会话；2：在会话分组中删除会话。
conversation_ids	Array of strings	是	会话 ID 列表。若传入的会话 ID 不存在会返回 414 错误码。

请求体示例

JSON{
    "account_id": "account_id1",
    "name": "name",
    "server_extension": "extension",
    "conversations": {
        "type": 1,
        "conversation_ids": [
            "account_id1|1|account_id2",
            "account_id1|2|team_id",
            "account_id1|3|team_id"
        ]
    }
}

响应信息

响应头参数

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

响应体参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
- conversation_group	Object	会话分组信息。	否
name	String	会话分组名称。	是
group_id	Long	会话分组 ID。	是
server_extension	String	会话分组扩展字段。	是
create_time	Long	会话分组创建时间（毫秒）。	是
update_time	Long	会话分组更新时间（毫秒）。	是
success_list	Array of strings	成功列入会话分组的会话 ID 列表。	否
- failed_list	Array of objects	列入会话分组失败的会话 ID 列表。	否
conversation_id	String	会话 ID。	是
error_code	Integer	操作失败的错误码。	是
error_msg	String	操作失败的提示信息。	是

响应体示例

JSON{
    "code": 200,
    "msg": "success",
    "data": {
        "conversation_group": {
            "name": "name",
            "group_id": 1,
            "server_extension": "extension",
            "create_time": 1,
            "update_time": 1
        },
        "success_list": [
            "account_id1|1|account_id2",
            "account_id1|2|team_id",
            "account_id1|3|team_id"
        ],
        "failed_list": [
            {
                "conversation_id": "account_id1|1|account_id2",
                "error_code": 102404,
                "error_msg": "error"
            }
        ]
    }
}

错误码

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

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