API 参考
在线调试

创建会话分组

更新时间: 2024/07/17 16:57:14

功能描述

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

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

  • 每个账号最多创建 10 个会话分组,每个分组中最多包含 100 个会话。
  • 每个会话最多可属于 5 个会话分组。
  • 对于不再使用的会话分组,请及时删除会话分组,释放资源。

调用频率

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

请求

URL

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

请求 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_idowner_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 数据对象,请求失败则返回空对象。

响应体示例

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
此文档是否对你有帮助?
有帮助
去反馈
  • 功能描述
  • 调用频率
  • 请求
  • URL
  • Header
  • 请求体参数
  • 请求体示例
  • 响应
  • Header
  • 响应体参数
  • 响应体示例
  • 错误码