接口调用说明
调用本接口,上传媒体文件后,可获取媒体资源标识media_id。关于media_id:- 使用multipart/form-data POST上传文件, 文件标识名为media。
- media_id是可复用的,同一个media_id多次使用。
- media_id对应的资源文件,仅能在钉钉客户端内使用。
- 媒体文件使用的空间是钉钉提供给组织的特定存储空间,调用本功能接口上传文件,不占用钉钉组织的钉盘空间。
请求
| 基本信息 | |
|---|---|
| HTTP URL | https://oapi.dingtalk.io/media/upload |
| HTTP Method | POST |
| 支持的应用类型 | appType-企业内部应用appType-第三方企业应用 |
| 权限要求 | permission-qyapi_base-调用企业API时需要具备的基本权限 |
查询参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| access_token | String | 是 | bE74xxxx | 调用该API的应用凭证。 - 企业内部应用,通过获取企业内部应用的access_token接口获取。 - 第三方企业应用,通过获取第三方企业的access_token接口获取。 |
请求体
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| type | String | 是 | image | 媒体文件类型: - image:图片,图片最大20MB。支持上传jpg、gif、png、bmp格式。 - voice:语音,语音文件最大2MB。支持上传amr、mp3、wav格式。 - video:视频,视频最大20MB。支持上传mp4格式。 - file:普通文件,最大20MB。支持上传doc、docx、xls、xlsx、ppt、pptx、zip、pdf、rar格式。 重要 如果使用C#调用该接口出现40004(不合法的媒体文件类型)错误,需将参数type加在请求的URL后面。 |
| media | FileItem | 是 | C:/Users/Desktop/222.png | 要上传的媒体文件。 form-data中媒体文件标识,有filename、filelength、content-type等信息。 |
请求示例
响应
响应体
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| errcode | Number | 0 | 返回码。 |
| errmsg | String | ok | 返回码描述。 |
| type | String | file | 媒体文件类型: - image:图片 - voice:语音 - file:普通文件 - video:视频 |
| media_id | String | @#lAzPDgCwPn1mJiDOQoLpxxxx | 媒体文件上传后获取的唯一标识。 |
| created_at | Number | 1599556098964 | 媒体文件上传时间戳。 |