获取用户会话列表
适用版本>=v7.0.2411b.20241128
接口说明:获取用户会话列表
请求说明
| 请求地址 | 配置域名+/openapi+/v7/audit/chats |
|---|---|
| 请求方法 | GET |
| 签名方式 | KSO-1(配置域名+/openapi不参与签名) |
| 权限要求 | 查询审计会话(应用授权) kso.chat_audit.read 读写审计会话(应用授权) kso.chat_audit.readwrite |
请求头(Header)
| 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} |
查询参数(Query)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| user_id | string | 是 | 用户Id |
| page_size | int64 | 是 | 分页大小 大于0 小于等于100 |
| page_token | string | 否 | 翻页token |
响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| code | integer | code |
| msg | string | msg |
| data | object | null |
| ∟ items | array[object] | |
| ∟ ∟ id | string | 会话ID |
| ∟ ∟ type | string | 会话类型 "p2p" "group" |
| ∟ ∟ name | string | 会话名称 |
| ∟ ∟ ctime | integer | 创建时间 |
| ∟ ∟ status | string | 参与者类型, user: 用户类型; group: 用户组,用户组数据需要通过日程参与者成员接口 展开 |
| ∟ ∟ ext_attrs | array[object] | 拓展属性 |
| ∟ ∟ ∟ name | string | 拓展属性名称 |
| ∟ ∟ ∟ value | string | 拓展属性值 |
| ∟ ∟ group_ext_attrs | string | 群聊会话属性 |
| ∟ ∟ ∟ 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 | 只允许群主和管理修改群属性 |
| ∟ next_page_token | string | 翻页token |
| more | object | 更多错误信息 |
响应体示例
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"
}
],
"next_page_token": "string"
},
"msg": "success"
}