Skip to content

API列表

API列表中可查看全部的服务端API接口文档,如何调用服务端API,可查看文档:调用流程

API名称用户授权应用授权
通讯录
触发全量同步
POST 配置域名+/openapi+/v7/ecisaccountsync/full/sync
×
触发增量同步
POST 配置域名+/openapi+/v7/ecisaccountsync/increment/sync
×
获取通讯录权限范围
GET 配置域名+/openapi+/v7/contacts/permissions_scope
×
获取关联组织下的部门列表
GET 配置域名+/openapi+/v7/partners/{partner_id}/depts/{dept_id}/children
×
获取关联组织的指定部门的用户列表
GET 配置域名+/openapi+/v7/partners/{partner_id}/depts/{dept_id}/members
×
新增自定义用户属性
POST 配置域名+/openapi+/v7/companies/user_custom_attrs/batch_create
×
删除自定义用户属性
POST 配置域名+/openapi+/v7/companies/user_custom_attrs/batch_delete
×
获取自定义用户属性
GET 配置域名+/openapi+/v7/companies/user_custom_attrs/batch_read
×
修改自定义用户属性
POST 配置域名+/openapi+/v7/companies/user_custom_attrs/batch_update
×
将用户加入到部门
POST 配置域名+/openapi+/v7/depts/{dept_id}/members/{user_id}/create
×
批量删除部门
POST 配置域名+/openapi+/v7/depts/batch_delete
×
删除部门
POST 配置域名+/openapi+/v7/depts/{dept_id}/delete
×
获取用户所在部门列表
GET 配置域名+/openapi+/v7/users/{user_id}/depts
×
将用户移除部门
POST 配置域名+/openapi+/v7/depts/{dept_id}/members/{user_id}/delete
×
搜索部门
GET 配置域名+/openapi+/v7/depts/search
×
批量删除用户
POST 配置域名+/openapi+/v7/users/batch_delete
×
批量禁用用户
POST 配置域名+/openapi+/v7/users/batch_disable
×
批量启用用户
POST 配置域名+/openapi+/v7/users/batch_enable
×
批量获取用户的自定义属性值
POST 配置域名+/openapi+/v7/users/custom_attrs/batch_read
×
批量更新用户的自定义属性值
POST 配置域名+/openapi+/v7/users/custom_attrs/batch_update
×
批量修改用户在部门中排序值
POST 配置域名+/openapi+/v7/users/batch_update_order
×
企业用户搜索
GET 配置域名+/openapi+/v7/users/search
×
获取管理员数据域
GET 配置域名+/openapi+/v7/access/admin/scope
×
获取当前用户信息
GET 配置域名+/openapi+/v7/users/current
×
根据三方token进行登录
POST 配置域名+/openapi+/v7/accounts/login_by_third_token
×
批量添加用户组成员
POST 配置域名+/openapi+/v7/groups/{group_id}/members/batch_create
获取用户组成员列表
GET 配置域名+/openapi+/v7/groups/{group_id}/members
检查成员是否在组内
GET 配置域名+/openapi+/v7/groups/{group_id}/check_in_group
×
创建用户组
POST 配置域名+/openapi+/v7/groups/create
×
删除用户组
POST 配置域名+/openapi+/v7/groups/{group_id}/delete
×
获取用户组
GET 配置域名+/openapi+/v7/groups/{group_id}
更新用户组成员角色
POST 配置域名+/openapi+/v7/groups/{group_id}/members/update_role
更新用户组
POST 配置域名+/openapi+/v7/groups/{group_id}/update
×
Agent通用接口
WPS365Agent通用接口
POST 配置域名+/openapi+/v7/sse/wps365agent/chat_stream
×
智能文档库
获取团队列表
GET 配置域名+/openapi+/v7/aidocs/doclib_list
×
团队问答
POST 配置域名+/openapi+/v7/sse/aidocs/search/gpt
×
应用文档
获取文件编辑信息(包含水印、权限等)
GET 回调地址 + uri(默认为:/v1/3rd/edit/info
××
文件重命名
PUT 回调地址 + uri(默认为:/v1/3rd/file/rename
××
文件新版本通知
POST 回调地址 + uri(默认为:/v1/3rd/file/notify
××
回调通知
POST 回调地址 + uri(默认为:/v1/3rd/onnotify
××
获取用户信息
POST 回调地址 + uri(默认为:/v1/3rd/user/info
××
获取文件编辑信息(包含水印、权限等)
GET 回调地址 + uri(默认为:/v1/3rd/edit/info
××
回调通知
POST 回调地址 + uri(默认为:/v1/3rd/onnotify
××
获取用户信息
POST 回调地址 + uri(默认为:/v1/3rd/user/info
××
批量修改文件元信息
POST 配置域名+/openapi+/v7/appfiles/drives/{drive_id}/files/batch_update
×
复制文件
POST 配置域名+/openapi+/v7/appfiles/drives/{drive_id}/files/{file_id}/copy
×
新建文件
POST 配置域名+/openapi+/v7/appfiles/drives/{drive_id}/files/{parent_id}/create
×
文件内容操作
POST 配置域名+/openapi+/v7/appfiles/drives/{drive_id}/files/{file_id}/content/operate
×
格式转换[文件另存为]
POST 配置域名+/openapi+/v7/appfiles/drives/{drive_id}/files/{file_id}/convert
×
结构化内容插入[文件执行指令]
POST 配置域名+/openapi+/v7/appfiles/drives/{drive_id}/files/{file_id}/exec_script
×
导入文件
POST 配置域名+/openapi+/v7/appfiles/drives/{drive_id}/files/{parent_id}/import
×
上传实体文件
上一步接口返回的store_request中的method 上一步接口返回的store_request中的url
××
提交分块上传
POST 配置域名+/openapi+/v7/appfiles/multipart_upload_tasks/{upload_id}/commit
×
整文件上传
POST 配置域名+/openapi+/v7/appfiles/drives/{drive_id}/files/{parent_id}/upload
×
文件转存
POST 配置域名+/openapi+/v7/appfiles/drives/{drive_id}/files/{parent_id}/upload_from
×
PDF转换任务查询
GET 配置域名+/openapi+/v7/appfiles/pdf/convert/tasks/{task_id}/meta
×
获取文件编辑信息(包含水印、权限等)
GET 回调地址 + uri(默认为:/v1/3rd/edit/info
××
新建驱动盘
POST 配置域名+/openapi+/v7/drives/create
×
获取盘列表
GET 配置域名+/openapi+/v7/drives
×
获取盘信息
GET 配置域名+/openapi+/v7/drives/{drive_id}/meta
×
更新驱动盘
POST 配置域名+/openapi+/v7/drives/{drive_id}/update
×
删除文件
POST 配置域名+/openapi+/v7/drives/{drive_id}/files/{file_id}/delete
×
获取文件下载信息
GET 配置域名+/openapi+/v7/drives/{drive_id}/files/{file_id}/download
×
获取文件信息
GET 配置域名+/openapi+/v7/drives/{drive_id}/files/{file_id}/meta
×
【分块上传】取消
POST 配置域名+/openapi+/v7/multipart_upload_tasks/{upload_id}/abort
×
【分块上传】提交完成
POST 配置域名+/openapi+/v7/multipart_upload_tasks/{upload_id}/commit
×
【分块上传】初始化
POST 配置域名+/openapi+/v7/drives/{drive_id}/files/{parent_id}/create_multipart_upload_task
×
文件转存(文件从其他存储转存到本空间)
POST 配置域名+/openapi+/v7/drives/{drive_id}/files/{parent_id}/upload_from
×
格式转换(文件另存为)
POST 配置域名+/openapi+/v7/drives/{drive_id}/files/{file_id}/convert
×
PDF转换任务查询
GET 配置域名+/openapi+/v7/kdocs/pdf/convert/tasks/{task_id}/meta
×
PDF转换
POST 配置域名+/openapi+/v7/kdocs/pdf/convert
×
【分块上传】签发分块上传地址
POST 配置域名+/openapi+/v7/multipart_upload_tasks/{upload_id}/sign
×
单步上传整文件
POST 配置域名+/openapi+/v7/drives/{drive_id}/files/{parent_id}/upload
×
获取预览链接
GET 配置域名+/openapi+/v7/drives/{drive_id}/files/{file_id}/preview_url
×
应用信息
查询应用会话配置
GET 配置域名+/openapi+/v7/apps/{app_id}/configs/chat
×
更新应用会话配置
POST 配置域名+/openapi+/v7/apps/{app_id}/configs/chat/update
×
应用管理
获取当前应用的服务主体信息
GET 配置域名 +/openapi+/v7/service_principals/current
××
认证与授权
获取自建应用的租户access_token
POST {配置域名}/openapi/oauth2/token
××
获取自建应用的租户access_token
POST {配置域名}/openapi/oauth2/token
××
获取用户access_token
POST {配置域名}/openapi/oauth2/token
××
获取用户access_token
POST {配置域名}/openapi/oauth2/token
××
刷新用户access_token
POST {配置域名}/openapi/oauth2/token
××
刷新用户access_token
POST {配置域名}/openapi/oauth2/token
××
消息与会话
批量获取会话消息
POST 配置域名+/openapi+/v7/audit/chats/{chat_id}/messages/batch_get
×
批量获取用户会话列表
POST 配置域名+/openapi+/v7/audit/chats/batch_get
×
删除消息
POST 配置域名+/openapi+/v7/audit/chats/{chat_id}/messages/{message_id}/delete
×
解散会话
POST 配置域名+/openapi+/v7/audit/chats/{chat_id}/delete
×
获取会话成员列表
GET 配置域名+/openapi+/v7/audit/chats/{chat_id}/members
×
获取会话消息列表
GET 配置域名+/openapi+/v7/audit/chats/{chat_id}/messages
×
获取用户会话列表
GET 配置域名+/openapi+/v7/audit/chats
×
创建会话
POST 配置域名+/openapi+/v7/chats/create
×
批量添加群成员
POST 配置域名+/openapi+v7/chats/{chat_id}/members/batch_create
×
批量删除群成员
POST 配置域名+/openapi+v7/chats/{chat_id}/members/batch_delete
×
解散群
POST 配置域名+/openapi+/v7/chats/{chat_id}/delete
×
获取会话信息
GET 配置域名+/openapi+/v7/chats/{chat_id}
×
根据userid获取会话信息
GET 配置域名+/openapi+/v7/chats/get_p2p_chat
×
批量获取会话信息
Post 配置域名+/openapi+/v7/chats/batch_get
×
获取会话列表
GET 配置域名+/openapi+/v7/chats
×
获取群聊成员列表
GET 配置域名+/openapi+v7/chats/{chat_id}/members
×
更新群信息
POST 配置域名+/openapi+/v7/chats/{chat_id}/update
×
创建部门群
POST 配置域名+/openapi+/v7/chats/create_dept_chat
×
部门群转普通群
POST 配置域名+/openapi+/v7/chats/normalize_dept_chat
×
指定部门群群主
POST 配置域名+/openapi+/v7/chats/update_dept_chat
×
批量发送消息
POST 配置域名+/openapi+/v7/messages/batch_create
×
获取会话文件下载地址
GET 配置域名+/openapi+/v7/chats/{chat_id}/messages/{message_id}/resources/{storage_key}/download
×
获取会话历史消息
GET 配置域名+/openapi+/v7/chats/{chat_id}/messages
×
撤回消息
POST 配置域名+/openapi+/v7/messages/{message_id}/recall
×
发送消息
POST 配置域名+/openapi+/v7/messages/create
×
更新消息
POST 配置域名+/openapi+/v7/messages/{message_id}/update
×
获取会话文件上传地址
POST 配置域名+/openapi+/v7/chats/resources/upload
×
同步会话消息
POST 配置域名+/openapi+/v7/sync/chats/{chat_id}/messages/batch_create
×
会话消息同步结束
POST 配置域名+/openapi+/v7/sync/chats/{chat_id}/finish
×
同步会话成员
POST 配置域名+/openapi+/v7/sync/chats/{chat_id}/members
×
同步会话
POST 配置域名+/openapi+/v7/sync/chats
×
多维表格
获取异步任务结果
GET 配置域名+/openapi+/v7/coop/dbsheet/{file_id}/content_permissions/async_tasks/{task_id}/query
创建订阅
POST 配置域名+/openapi+/v7/coop/dbsheet/{file_id}/hooks/create
×
取消 Hook 订阅
POST 配置域名+/openapi+/v7/coop/dbsheet/{file_id}/hooks/{hook_id}/delete
×
查询全部 Hook 订阅
GET 配置域名+/openapi+/v7/coop/dbsheet/{file_id}/hooks
×
管理后台
上报审计日志
POST 配置域名+/openapi+/v7/audit_logs
×
新增审计日志操作类型
POST 配置域名+/openapi+/v7/audit_categories/create
×
查询日志(团队、登录、文档、后台)
GET 配置域名+/openapi+/v7/audit_logs
×
获取登录的设备列表
GET 配置域名+/openapi+/v7/devices
下线所有设备会话
POST 配置域名+/openapi+/v7/sessions/delete
×
下线某设备登录的会话
POST 配置域名+/openapi+/v7/devices/{device_id}/delete
权益
获取权益信息
GET 配置域名+/openapi+/v7/privileges
×
待办
创建待办分类
POST 配置域名+/openapi+/v7/todo/categories/create
×
删除待办分类
POST 配置域名+/openapi+/v7/todo/categories/{category_id}/delete
×
查询待办分类
GET 配置域名+/openapi+/v7/todo/categories
×
更新待办分类
POST 配置域名+/openapi+/v7/todo/categories/{category_id}/update
×
批量删除待办任务
POST 配置域名+/openapi+/v7/todo/tasks/batch_delete
×
批量获取应用下待办任务列表
`` 配置域名+/openapi+/v7/todo/tasks/batch_get
××
创建待办任务
`` 配置域名+/openapi+/v7/todo/tasks
××
获取待办任务
`` 配置域名+/openapi+/v7/todo/tasks/{task_id}
××
推送待办提醒消息
POST 配置域名+/openapi+/v7/todo/tasks/{task_id}/remind
×
更新待办任务
POST 配置域名+/openapi+/v7/todo/tasks/{task_id}/update
×
工作台
获取用户可用应用
GET 配置域名+/openapi+/v7/applications
×
添加常用应用
POST 配置域名+/openapi+/v7/create_workbench_favorite_app
×
获取用户常用应用
GET 配置域名+/openapi+/v7/get_workbench_favorite_apps
×
取消常用应用
POST 配置域名+/openapi+/v7/remove_workbench_favorite_app
×
云文档
获取部门当前统计数据
GET 配置域名+/openapi+/v7/stats/dept/current_data
×
获取部门历史统计数据
GET 配置域名+/openapi+/v7/stats/dept/history_data
×
文件搜索
GET 配置域名+/openapi+/v7/files/search
获取异步任务信息
GET 配置域名+/openapi+/v7/drive_tasks/{task_id}/meta
×
获取文件下载信息
GET 配置域名+/openapi+/v7/drives/{drive_id}/files/{file_id}/download
获取文件路径
GET 配置域名+/openapi+/v7/drives/{drive_id}/files/{file_id}/path
×
删除文件
POST 配置域名+/openapi+/v7/filetransfer/file/batch_delete
×
批量更新传输状态
POST 配置域名+/openapi+/v7/filetransfer/task/status/batch_update
×
分块上传提交完成
POST 配置域名+/openapi+/v7/filetransfer/file/upload/commit
×
发起传输审批
POST 配置域名+/openapi+/v7/filetransfer/task/approval/create
×
新建传输任务
POST 配置域名+/openapi+/v7/filetransfer/task/create
×
分块上传初始化
POST 配置域名+/openapi+/v7/filetransfer/file/upload/init
×
自定义fail_type多语言
POST 配置域名+/openapi+v7/filetransfer/fail_type/add
×
下载文件
POST 配置域名+/openapi+/v7/filetransfer/file/download
×
文件预览
POST 配置域名+/openapi+/v7/filetransfer/file/preview
×
获取非对称加密公钥pk
POST 配置域名+/openapi+/v7/filetransfer/file/encrypt/jwks
×
查询用户传输记录
GET 配置域名+/openapi+/v7/filetransfer/user/transfers
×
查询传输进度
POST 配置域名+/openapi+/v7/filetransfer/transfer/percent
×
单步上传
POST 配置域名+/openapi+/v7/filetransfer/file/upload
×
提交传输任务
POST 配置域名+/openapi+/v7/filetransfer/task/commit
×
更新文件传输状态
POST 配置域名+/openapi+/v7/filetransfer/file/status/update
×
分块上传
POST 配置域名+/openapi+/v7/filetransfer/file/upload/sign
×
云文档转存发件箱
POST 配置域名+/openapi+/v7/filetransfer/file/upload/from/cloud
×
更新驱动盘
POST 配置域名+/openapi+/v7/filetransfer/drives/update
×
批量新建文件权限项
POST 配置域名+/openapi+/v7/drives/{drive_id}/files/{file_id}/permissions/batch_create
批量删除文件权限项
POST 配置域名+/openapi+/v7/drives/{drive_id}/files/{file_id}/permissions/batch_delete
新建文件权限项
POST 配置域名+/openapi+/v7/drives/{drive_id}/files/{file_id}/permissions/create
×
删除文件权限项
POST 配置域名+/openapi+/v7/drives/{drive_id}/files/{file_id}/permissions/{permission_id}/delete
×
获取文件操作权限
GET 配置域名+/openapi+/v7/drives/{drive_id}/files/{file_id}/permissions/acl
×
列举文件权限列表
GET 配置域名+/openapi+/v7/drives/{drive_id}/files/{file_id}/permissions
×
列举我的文档权限列表
GET 配置域名+/openapi+/v7/drives/{drive_id}/files/{file_id}/permissions/mine
取消文件分享
POST 配置域名+/openapi+/v7/drives/{drive_id}/files/{file_id}/close_link
获取当前文件的分享继承信息
GET 配置域名+/openapi+/v7/doclib/files/{file_id}/inherit
获取分享链接信息
GET 配置域名+/openapi+/v7/links/{link_id}/meta
开启文件分享
POST 配置域名+/openapi+/v7/drives/{drive_id}/files/{file_id}/open_link
基于模板新建文件
POST 配置域名+/openapi+/v7/kdocs/templates/{template_id}/new_file
×
新建模板
POST 配置域名+/openapi+/v7/kdocs/templates/add
×
文件转存(文件从其他存储转存到本空间)
POST 配置域名+/openapi+/v7/drives/{drive_id}/files/{parent_id}/upload_from
×
请求文件上传信息
POST 配置域名+/openapi+/v7/drives/{drive_id}/files/{parent_id}/request_upload
提交文件上传完成
POST 配置域名+/openapi+/v7/drives/{drive_id}/files/{parent_id}/commit_upload
上传实体文件
上一步接口返回的store_request中的method 上一步接口返回的store_request中的url
××
获取常用文件列表
GET 配置域名+/openapi+/v7/drive_freq/items
×
获取最近列表
GET 配置域名+/openapi+/v7/drive_latest/items
×
获取“我收到的”分享列表
GET 配置域名+/openapi+/v7/links/recv
×
获取“我发出的”分享列表
GET 配置域名+/openapi+/v7/links/send
×
获取星标列表
GET 配置域名+/openapi+/v7/drive_star/items
×
创建文档库
POST 配置域名+/openapi+/v7/doclib/create
获取文档库信息
GET 配置域名+/openapi+/v7/doclib/meta
获取团队文档库列表
GET 配置域名+/openapi+/v7/doclibs
获取文档库配置
GET 配置域名+/openapi+/v7/doclib/settings
获取配额列表
GET 配置域名+/openapi+/v7/space/quota/list
×
获取空间使用量
GET 配置域名+/openapi+/v7/space/statistics
×