钉盘接口¶
-
class
dingtalk.client.api.
Cspace
(client=None)[源代码]¶ -
add
(code, media_id, space_id, folder_id, name, agent_id=None, overwrite=False)[源代码]¶ 新增文件到用户钉盘
参数: - code – 如果是微应用,code值为微应用免登授权码,如果是服务窗应用,code值为服务窗免登授权码 code为临时授权码,只能消费一次,下次请求需要重新获取新的code。
- media_id – 调用钉盘上传文件接口得到的mediaid
- space_id – 调用云盘选择控件后获取的用户钉盘空间ID
- folder_id – 调用云盘选择控件后获取的用户钉盘文件夹ID
- name – 上传文件的名称,不能包含非法字符
- agent_id – 微应用的agentId
- overwrite – 到同名文件是否覆盖,若不覆盖,则会自动重命名本次新增的文件
返回:
-
add_to_single_chat
(agent_id, userid, media_id, file_name)[源代码]¶ 发送文件给指定用户
参数: - agent_id – 文件发送者微应用的agentId
- userid – 文件接收人的userid
- media_id – 调用钉盘上传文件接口得到的mediaid
- file_name – 文件名(需包含含扩展名)
返回:
-
file_upload_chunk
(agent_id, upload_id, chunk_sequence, file_chunk)[源代码]¶ 上传文件块
参数: - agent_id – 微应用的agentId
- upload_id – 上传事务id
- chunk_sequence – 文件块号,从1开始计数
- file_chunk – 要上传的文件块,一个 File-object
返回:
-
file_upload_single
(agent_id, file_size, media_file)[源代码]¶ 单步文件上传
参数: - agent_id – 微应用的agentId
- file_size – 文件大小
- media_file – 要上传的文件,一个 File-object
返回:
-
file_upload_transaction
(agent_id, file_size, chunk_numbers, upload_id=None)[源代码]¶ 开启/提交 文件上传事务
参数: - agent_id – 微应用的agentId
- file_size – 文件大小
- chunk_numbers – 文件总块数
- upload_id – 上传事务id 不传该值为开启事务,传该值为提交事务
返回: 开启事务:上传事务id; 提交事务:文件存储id
-
get_custom_space
(domain=None, agent_id=None)[源代码]¶ 获取企业下的自定义空间
参数: - domain – 企业调用时传入,需要为10个字节以内的字符串,仅可包含字母和数字,大小写不敏感
- agent_id – ISV调用时传入,微应用agentId
返回: 申请到的空间id
-
grant_custom_space
(isdownload, userid, agent_id=None, domain=None, duration=30, path=None, fileids=())[源代码]¶ 授权用户访问企业下的自定义空间
参数: - isdownload – 权限类型,true为下载,false为上传
- userid – 企业用户userid
- agent_id – ISV调用时传入,授权访问指定微应用的自定义空间
- domain – 企业调用时传入,授权访问该domain的自定义空间
- duration – 权限有效时间,有效范围为0~3600秒,超出此范围或不传默认为30秒
- path – 授权访问的路径
- fileids – 授权访问的文件id列表
返回:
-