Skip to content

批量获取用户会话列表

适用版本>=v7.0.2411b.20241128

接口说明:批量获取用户会话列表

请求说明

请求地址配置域名+/openapi+/v7/audit/chats/batch_get
请求方法POST
签名方式KSO-1(配置域名+/openapi不参与签名)
权限要求查询审计会话(应用授权) kso.chat_audit.read
读写审计会话(应用授权) kso.chat_audit.readwrite

请求头(Header)

Header参数类型是否必填说明
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

请求体(Body)

名称类型是否必填说明
chat_id_listarray[string]会话Id列表, 大于0 小于等于100

响应体(Response)

名称类型说明
codeintegercode
msgstringmsg
dataobjectnull
itemsarray[object]
idstring会话ID
typestring会话类型 "p2p" "group"
namestring会话名称
ctimeinteger创建时间
statusstring参与者类型, user: 用户类型; group: 用户组,用户组数据需要通过日程参与者成员接口 展开
ext_attrsarray[object]拓展属性
namestring拓展属性名称
valuestring拓展属性值
group_ext_attrsobject群聊会话属性
avatarobject群聊会话头像
avatarsarray[string]群聊会话链接列表
typestring群聊会话头像类型 默认:"default" 自定义:"custom"
owner_idstring群主
dept_idstring部门ID
settingsobject会话设置属性
is_disable_all_sendbool全员禁言
is_disable_part_sendbool部分成员禁言
is_enable_nicknamebool开启昵称
is_external_join_approvebool外部企业进群审核
is_join_approvebool进群审核
is_owner_admin_at_allbool只允许群主或管理员@所有人
is_owner_admin_modifybool只允许群主和管理修改群属性
moreobject更多的错误信息

响应体示例

json
{
  "code": 0,
  "data": {
    "items": [
      {
        "ctime": 0,
        "ext_attrs": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "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
          }
        },
        "id": "string",
        "name": "string",
        "status": "active",
        "type": "group"
      }
    ]
  },
  "msg": "success"
}