文档中心 > API类目 > 钉钉API

dingtalk.oapi.file.upload.single (单步文件上传)

单步文件上传

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	描述
agent_id	String	可选	123	微应用的agentId
file_size	Number	可选	111	文件大小
file	byte[]	可选	111	文件内容支持的文件类型：

响应参数

名称	类型	示例值	描述
media_id	String	@123	media_id
errmsg	String	ok	errmsg
errcode	Number	0	errcode

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/file/upload/single");
OapiFileUploadSingleRequest req = new OapiFileUploadSingleRequest();
req.setAgentId("123");
req.setFileSize(111L);
req.setFile(new FileItem("/tmp/file.txt"));
OapiFileUploadSingleResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/file/upload/single");
OapiFileUploadSingleRequest req = new OapiFileUploadSingleRequest();
req.AgentId = "123";
req.FileSize = 111L;
req.File = new FileItem("/tmp/file.txt");
OapiFileUploadSingleResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiFileUploadSingleRequest;
$req->setAgentId("123");
$req->setFileSize("111");
//附件上传的机制参见PHP CURL文档，在文件路径前加@符号即可
$req->setFile(@fileLocation);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/file/upload/single");

curl -X POST "https://oapi.dingtalk.com/file/upload/single" \
-H 'Content-Type:multipart/form-data;charset=utf-8' \
-F 'access_token=0ad0f7e0-544d-45fe-81b4-47fff68957cd' \
-F 'agent_id=123' \
-F 'file_size=111' \
-F 'file=@/tmp/file.txt'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.OapiFileUploadSingleRequest("https://oapi.dingtalk.com/file/upload/single")

req.agent_id="123"
req.file_size=111
req.file=dingtalk.api.FileItem('abc.jpg',open('abc.jpg','rb'))
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.file.upload.single");
add_param(pRequest,"agent_id","123");
add_param(pRequest,"file_size","111");
add_file_param(pRequest,"file","文件内容");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.file.upload.single', {
	'agent_id':'123',
	'file_size':'111',
	'file':'文件内容'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "media_id":"@123",
    "errmsg":"ok",
    "errcode":0
}

异常示例

JSON示例

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.file.upload.single (单步文件上传)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ