功能描述

该接口用于创建一个会话分组，并指定分组中的会话列表。

会话分组是将多个相关主题或目的的聊天会话组织在一起的一种方式。

• 不同的 IM 套餐包中，每个用户账号能创建的会话分组数量上限，以及每个会话分组中的会话数量上限都不同。具体可参考 各套餐详细对比信息 中的会话相关信息。
• 每个会话最多可属于 5 个会话分组。
• 对于不再使用的会话分组，请及时 删除会话分组，释放资源。

调用频率

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

请求

URL

POST https://open.yunxinapi.com/im/v2/conversation_groups

Header

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

请求体参数

参数名称	类型	是否必选	描述	示例
account_id	String	必选	云信账号 ID。	"123456"
name	String	必选	会话分组名称。	"name"
server_extension	String	可选	会话分组扩展字段。	"extension"
conversation_ids	Array of strings	可选	会话 ID 列表。该值是由多个经过 URL 编码后的会话 ID 组成，以逗号分隔。最多传入 100 个会话 ID，每个会话 ID 需要用户自行拼装，拼装规则： owner_id|conversation_type|other_id 或owner_id|conversation_type|team_id owner_id：操作者账号 ID conversation_type：会话类型，1：单聊会话；2：高级群会话；3：超大群会话 other_id：对方账号 ID（单聊对话） team_id：群组 ID（群组会话）	["Accid1|1|Accid2","Accid1|2|tid","Accid1|3|tid"]

请求体示例

json{
    "account_id": "123456",
    "name": "name",
    "server_extension": "extension",
    "conversation_ids": [
        "Accid1|1|Accid2",
        "Accid1|2|tid",
        "Accid1|3|tid"
    ]
}

响应

Header

响应 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": [
            "Accid1|1|Accid2",
            "Accid1|2|tid",
            "Accid1|3|tid"
        ],
        "failed_list": [
            {
                "conversation_id": "Accid1|1|Accid2",
                "error_code": 102404,
                "error_msg": "error"
            }
        ]
    }
}

错误码

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