获取用户文档列表

最近更新时间:2024-07-08 11:48:52

我的收藏

接口描述

描述:根据用户 ID 获取用户创建会议下的文档列表,仅可查询本人的文档列表,支持 OAuth2.0 鉴权访问。
请求方式:GET
接口请求域名
https://api.meeting.qq.com/v1/docs?userid=tester&page=1&page_size=10&start_time=1616254740&end_time=1616256600


输入参数

以下请求参数列表仅列出了接口请求参数,HTTP 请求头公共参数请参见签名验证章节的 公共参数说明
参数名称
必选
参数类型
参数描述
userid
String
用户的 ID(企业内部请使用企业唯一用户标识,OAuth2.0 鉴权用户请使用 openId)。
page
Integer
当前页,从1开始。
page_size
Integer
当前页大小,最小值为1,最大值为20。
start_time
Integer
查询起始时间,UNIX 时间戳(单位秒)。
end_time
Integer
查询结束时间,UNIX 时间戳(单位秒)。
说明:
start_time 和 end_time 组成一个时间区间,不提供则表示最近一个月;只提供 start_time 则向后推31天,只提供 end_time 则向前推31天;当提供时间跨度时,时间跨度不能大于90天。

输出参数

参数名称
参数类型
参数描述
current_page
Integer
当前页。
current_size
Integer
当前页实际大小。
total_count
Integer
数据总条数。
total_page
Integer
数据总页数。
meeting_info_list
MeetingInfo 对象数组
会议对象。

MeetingInfo 对象

参数名称
参数类型
参数描述
meeting_id
String
会议 ID。
meeting_code
String
会议 code。
subject
String
会议主题。
doc_num
Integer
会议下文档数量。
start_time
Integer
会议开始时间,UNIX 时间戳(单位秒)。
end_time
Integer
会议结束时间,UNIX 时间戳(单位秒)。
doc_info_list
DocInfo 对象数组
文档对象。

DocInfo 对象

参数名称
参数类型
参数描述
doc_id
String
文档 ID。
doc_title
String
文档标题。
doc_creator_userid
String
文档创建者 userid,个人用户无此字段返回,企业用户仅当文档创建者与会议创建者同企业时返回此字段。
doc_creator_user_name
String
文档创建者名称。
doc_edit_time
Integer
文档最后被修改时间。
doc_editor_userid
String
文档修改者 userid,个人用户无此字段返回,企业用户仅当文档创建者与会议创建者同企业时返回此字段。
doc_editor_user_name
String
文档修改者名称。
doc_modify_permission
Integer
文档编辑权限:
1:成员仅查看
2:成员可编辑

错误码列表

状态码
错误码
错误描述
500
190001
存在未注册的用户。
400
190004
参数非法,请对照接口文档检查您的参数。

示例

输入示例

GET https://api.meeting.qq.com/v1/docs?userid=tester&page=1&page_size=10&start_time=1616254740&end_time=1616256600


输出示例

{
"total_count": 2,
"total_page": 1,
"current_page": 1,
"current_size": 2,
"meeting_info_list": [{
"meeting_id": "15871005788848420673",
"meeting_code": "621873301",
"subject": "测试创建文档",
"doc_num": 2,
"doc_info_list": [{
"doc_id": "300000000$DHuhhTbpEIYG",
"doc_title": "6IW+6K6v5Lya6K6u5paH5qGj",
"doc_creator_userid": "tester",
"doc_creator_user_name": "xxx",
"doc_edit_time": 1616254763,
"doc_editor_userid": "tester",
"doc_editor_user_name": "xxx",
"doc_modify_permission": 1
}, {
"doc_id": "300000000$DeWdsWJJmhVI",
"doc_title": "6IW+6K6v5Lya6K6u5paH5qGj",
"doc_creator_userid": "tester1",
"doc_creator_user_name": "xxx",
"doc_edit_time": 1616254746,
"doc_editor_userid": "tester1",
"doc_editor_user_name": "xxx",
"doc_modify_permission": 1
}],
"start_time": 1616254844,
"end_time": 1616258444
}, {
"meeting_id": "16999658821518256932",
"meeting_code": "502779488",
"subject": "123",
"doc_num": 1,
"doc_info_list": [{
"doc_id": "300000000$DHuhhTbpEIYG",
"doc_title": "6IW+6K6v5Lya6K6u5paH5qGj",
"doc_creator_userid": "tester3",
"doc_creator_user_name": "xxx",
"doc_edit_time": 1616254763,
"doc_editor_userid": "tester3",
"doc_editor_user_name": "xxx",
"doc_modify_permission": 1
}],
"start_time": 1616254844,
"end_time": 1616258444
}]
}