批量获取会话信息

适用版本>=v7.0.2412b.20241226 v7.0.2505a.20250515更新：新增【是否仅群主和管理员可添加群书签】和【新入群成员是否可查看历史消息】2个返回参数接口说明：批量获取会话信息

使用说明

单聊会话时，必须是该应用的单聊会话
群聊会话时，应用需在群内

请求说明

请求地址	配置域名+/openapi+`/v7/chats/batch_get`
请求方法	Post
签名方式	KSO-1（配置域名+/openapi不参与签名）
权限要求	查询会话（应用授权）`kso.chat.read` 查询和管理会话（应用授权）`kso.chat.readwrite` 读取会话(应用授权)`kso.chat.readwrite`

Header	参数类型	是否必填	说明
X-Kso-Date	string	是	RFC1123 格式的日期，例: `Wed, 23 Jan 2013 06:43:08 GMT`
X-Kso-Authorization	string	是	KSO-1 签名值，详见《签名方法》
Authorization	string	是	授权凭证，格式为：`Bearer {access_token}`
X-Kso-Id-Type	string	否	ID 类型，可选值为 `internal` 或 `external`，不传默认为`internal`。当值为 `external` 时，开启三方 ID 模式，此时接口请求和响应中的 user_id 和 dept_id 应为三方ID，即 ex_user_id 和 ex_dept_id

请求体（Body）

名称	参数类型	是否必填	说明
chat_id_list	string[]	否	会话id列表，与dept_id_list二者必传一个，同时传以chat_id_list为准
dept_id_list	string[]	否	部门群场景下，可通过部门id查询群信息。部门id列表，与chat_id_list二者必传一个，同时传以chat_id_list为准
with_group_ext_attrs	bool	否	是否返回 group_ext_attrs, 默认 false 不返回

请求体示例

json

{
  "chat_id_list": [
    "string"
  ],
  "dept_id_list": [
    "string"
  ],
  "with_group_ext_attrs": false
}

响应体（Response）

名称	类型	说明
code	integer	code
msg	string	msg
data	object	data
∟ items	array[object]	会话列表
∟ ∟ id	string	会话ID
∟ ∟ type	string	会话类型 "p2p" "group"
∟ ∟ name	string	会话名称
∟ ∟ ctime	integer	创建时间
∟ ∟ status	string	active:活跃 dismissed：解散
∟ ∟ group_ext_attrs	object	群聊会话属性
∟ ∟ ∟ avatar	object	群聊会话头像
∟ ∟ ∟ ∟ avatars	array[string]	群聊会话链接列表
∟ ∟ ∟ ∟ type	string	群聊会话头像类型默认："default" 自定义："custom"
∟ ∟ ∟ owner_id	string	群主
∟ ∟ ∟ dept_id	string	部门ID
∟ ∟ ∟ settings	object	会话设置属性
∟ ∟ ∟ is_disable_all_send	bool	全员禁言
∟ ∟ ∟ is_disable_part_send	bool	部分成员禁言
∟ ∟ ∟ is_enable_nickname	bool	开启昵称
∟ ∟ ∟ is_external_join_approve	bool	非群主所属企业的人员进群是否需审核
∟ ∟ ∟ is_join_approve	bool	群主所属企业的人员进群是否需审核
∟ ∟ ∟ is_owner_admin_at_all	bool	只允许群主或管理员@所有人
∟ ∟ ∟ is_owner_admin_modify	bool	只允许群主和管理修改群属性
∟ ∟ ∟ is_owner_admin_add_bookmark	bool	是否仅群主和管理员可添加群书签
∟ ∟ ∟ is_enable_history_messages	bool	新入群成员是否可查看历史消息

响应体示例

json

{
  "code": 0,
  "data": {
    "items": [
          {
          "ctime": 0,
          "group_ext_attrs": {
            "avatar": {
              "avatars": ["string"],
              "type": "default"
            },
            "dept_id": "string",
            "owner_id": "string",
            "settings": {
              "is_disable_all_send": false,
              "is_disable_part_send": false,
              "is_enable_nickname": true,
              "is_external_join_approve": true,
              "is_join_approve": false,
              "is_owner_admin_at_all": false,
              "is_owner_admin_modify": false,
              "is_owner_admin_add_bookmark": false,
              "is_enable_history_messages": false
            }
          },
          "id": "string",
          "name": "string",
          "status": "active",
          "type": "group"
      }
    ]
  },
  "msg": "success"
}