淘宝开放平台 - 文档中心

请求地址：

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

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	更多限制	描述
require_order_id	Number	可选	1042423499		需求单ID不能为空
task_order_id	Number	可选	1042423423		履行单ID不能为空
personal_user_id	Number	可选	324234234324		个人账号ID不能为空
personal_session	String	可选	dsdf324234234324		个人账号sessionCode不能为空
execute_user_list	ExecuteUserDto []	可选		最大列表长度：20	账号list
└ execute_user_id Number 可选 0 参数executeUserId └ execute_user_type String 可选 foo 参数executeUserType
auth_way	String	可选	HAND_INPUT		ONLINE_SCAN在线扫码,OFFLINE_UPLOAD线下上传,STATION_SYNC驿站同步,HAND_INPUT手动输入,OCR_SCAN在线扫照片
cert_json	String	可选	{"address":"浙江省杭州市","name":"张三","number":"324234324234234"}		证件参数json不能为空
cert_type	Number	可选	0		0:身份证,1护照,2军官证,3士兵证,4回乡证,5临时身份证,6户口薄,7警官证,8台胞证
skip	Number	可选	1		0不能跳过,1可以跳过
app_context_param	AppContextParam	可选			客户端信息
└ app_battery String 可选 45 电池用电量 └ device_type String 可选 ios app是android还是ios └ loc_accuracy String 可选 23 小件员-定位时间 └ loc_auth String 可选 true gps-定位权限授予 └ loc_lat String 可选 123.22 小件员-所在的纬度 └ loc_lng String 可选 123.22 小件员-所在的经度 └ loc_open String 可选 true gps-定位是否打开,GPS定位开启 └ loc_succ String 可选 true gps-定位是否成功 └ loc_time Number 可选 123 小件员-定位时间 └ loc_type String 可选 gps 小件员-定位方式 └ pkg_id String 可选 fsdfId 对应包裹侠的包id └ pkg_name String 可选 fsdf.sdf 对应包裹侠的包名 └ sdk_version String 可选 6.0.1 sdk的版本号

名称	类型	示例值	描述
data	OperRealnameResDto		参数data
└ fulfil_task_id Number 1042423423 履行单ID不能为空 └ require_order_id Number 1042423499 需求单ID不能为空 └ sapphire_cert_id String foo 参数sapphireCertId └ trace_id String 0be4314615320739620257888e18e2 鹰眼ID
status_code	String	foo	参数statusCode
status_message	String	foo	参数statusMessage
is_success	Boolean	false	参数success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGuoguoFulfilOcrhandrealnameRequest req = new CainiaoGuoguoFulfilOcrhandrealnameRequest();
req.setRequireOrderId(1042423499L);
req.setTaskOrderId(1042423423L);
req.setPersonalUserId(324234234324L);
req.setPersonalSession("dsdf324234234324");
List<CainiaoGuoguoFulfilOcrhandrealnameRequest.ExecuteUserDto> list2 = new ArrayList<CainiaoGuoguoFulfilOcrhandrealnameRequest.ExecuteUserDto>();
CainiaoGuoguoFulfilOcrhandrealnameRequest.ExecuteUserDto obj3 = new CainiaoGuoguoFulfilOcrhandrealnameRequest.ExecuteUserDto();
list2.add(obj3);
obj3.setExecuteUserId(0L);
obj3.setExecuteUserType("foo");
req.setExecuteUserList(list2);
req.setAuthWay("HAND_INPUT");
req.setCertJson("{\"address\":\"浙江省杭州市\",\"name\":\"张三\",\"number\":\"324234324234234\"}");
req.setCertType(0L);
req.setSkip(1L);
CainiaoGuoguoFulfilOcrhandrealnameRequest.AppContextParam obj4 = new CainiaoGuoguoFulfilOcrhandrealnameRequest.AppContextParam();
obj4.setAppBattery("45");
obj4.setDeviceType("ios");
obj4.setLocAccuracy("23");
obj4.setLocAuth("true");
obj4.setLocLat("123.22");
obj4.setLocLng("123.22");
obj4.setLocOpen("true");
obj4.setLocSucc("true");
obj4.setLocTime(123L);
obj4.setLocType("gps");
obj4.setPkgId("fsdfId");
obj4.setPkgName("fsdf.sdf");
obj4.setSdkVersion("6.0.1");
req.setAppContextParam(obj4);
CainiaoGuoguoFulfilOcrhandrealnameResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoGuoguoFulfilOcrhandrealnameRequest req = new CainiaoGuoguoFulfilOcrhandrealnameRequest();
req.RequireOrderId = 1042423499L;
req.TaskOrderId = 1042423423L;
req.PersonalUserId = 324234234324L;
req.PersonalSession = "dsdf324234234324";
List<CainiaoGuoguoFulfilOcrhandrealnameRequest.ExecuteUserDtoDomain> list2 = new List<CainiaoGuoguoFulfilOcrhandrealnameRequest.ExecuteUserDtoDomain>();
CainiaoGuoguoFulfilOcrhandrealnameRequest.ExecuteUserDtoDomain obj3 = new CainiaoGuoguoFulfilOcrhandrealnameRequest.ExecuteUserDtoDomain();
list2.Add(obj3);
obj3.ExecuteUserId = 0L;
obj3.ExecuteUserType = "foo";
req.ExecuteUserList_ = list2;
req.AuthWay = "HAND_INPUT";
req.CertJson = "{\"address\":\"浙江省杭州市\",\"name\":\"张三\",\"number\":\"324234324234234\"}";
req.CertType = 0L;
req.Skip = 1L;
CainiaoGuoguoFulfilOcrhandrealnameRequest.AppContextParamDomain obj4 = new CainiaoGuoguoFulfilOcrhandrealnameRequest.AppContextParamDomain();
obj4.AppBattery = "45";
obj4.DeviceType = "ios";
obj4.LocAccuracy = "23";
obj4.LocAuth = "true";
obj4.LocLat = "123.22";
obj4.LocLng = "123.22";
obj4.LocOpen = "true";
obj4.LocSucc = "true";
obj4.LocTime = 123L;
obj4.LocType = "gps";
obj4.PkgId = "fsdfId";
obj4.PkgName = "fsdf.sdf";
obj4.SdkVersion = "6.0.1";
req.AppContextParam_ = obj4;
CainiaoGuoguoFulfilOcrhandrealnameResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoGuoguoFulfilOcrhandrealnameRequest;
$req->setRequireOrderId("1042423499");
$req->setTaskOrderId("1042423423");
$req->setPersonalUserId("324234234324");
$req->setPersonalSession("dsdf324234234324");
$execute_user_list = new ExecuteUserDto;
$execute_user_list->execute_user_id="0";
$execute_user_list->execute_user_type="foo";
$req->setExecuteUserList(json_encode($execute_user_list));
$req->setAuthWay("HAND_INPUT");
$req->setCertJson("{\"address\":\"浙江省杭州市\",\"name\":\"张三\",\"number\":\"324234324234234\"}");
$req->setCertType("0");
$req->setSkip("1");
$app_context_param = new AppContextParam;
$app_context_param->app_battery="45";
$app_context_param->device_type="ios";
$app_context_param->loc_accuracy="23";
$app_context_param->loc_auth="true";
$app_context_param->loc_lat="123.22";
$app_context_param->loc_lng="123.22";
$app_context_param->loc_open="true";
$app_context_param->loc_succ="true";
$app_context_param->loc_time="123";
$app_context_param->loc_type="gps";
$app_context_param->pkg_id="fsdfId";
$app_context_param->pkg_name="fsdf.sdf";
$app_context_param->sdk_version="6.0.1";
$req->setAppContextParam(json_encode($app_context_param));
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=cainiao.guoguo.fulfil.ocrhandrealname' \
-d 'partner_id=apidoc' \
-d 'sign=2FBE0DBD7BCA3F8DE0FDB3E92DB4AD2F' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+16%3A38%3A13' \
-d 'v=2.0' \
-d 'app_context_param=null' \
-d 'auth_way=HAND_INPUT' \
-d 'cert_json=%7B%5C%22address%5C%22%3A%5C%22%E6%B5%99%E6%B1%9F%E7%9C%81%E6%9D%AD%E5%B7%9E%E5%B8%82%5C%22%2C%5C%22name%5C%22%3A%5C%22%E5%BC%A0%E4%B8%89%5C%22%2C%5C%22number%5C%22%3A%5C%22324234324234234%5C%22%7D' \
-d 'cert_type=0' \
-d 'execute_user_list=null' \
-d 'personal_session=dsdf324234234324' \
-d 'personal_user_id=324234234324' \
-d 'require_order_id=1042423499' \
-d 'skip=1' \
-d 'task_order_id=1042423423'

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

req=top.api.CainiaoGuoguoFulfilOcrhandrealnameRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.require_order_id=1042423499
req.task_order_id=1042423423
req.personal_user_id=324234234324
req.personal_session="dsdf324234234324"
req.execute_user_list=""
req.auth_way="HAND_INPUT"
req.cert_json="{\"address\":\"浙江省杭州市\",\"name\":\"张三\",\"number\":\"324234324234234\"}"
req.cert_type=0
req.skip=1
req.app_context_param=""
try:
	resp= req.getResponse()
	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,"cainiao.guoguo.fulfil.ocrhandrealname");
add_param(pRequest,"require_order_id","1042423499");
add_param(pRequest,"task_order_id","1042423423");
add_param(pRequest,"personal_user_id","324234234324");
add_param(pRequest,"personal_session","dsdf324234234324");
add_param(pRequest,"execute_user_list","数据结构JSON示例");
add_param(pRequest,"auth_way","HAND_INPUT");
add_param(pRequest,"cert_json","{\"address\":\"浙江省杭州市\",\"name\":\"张三\",\"number\":\"324234324234234\"}");
add_param(pRequest,"cert_type","0");
add_param(pRequest,"skip","1");
add_param(pRequest,"app_context_param","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
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('cainiao.guoguo.fulfil.ocrhandrealname', {
	'require_order_id':'1042423499',
	'task_order_id':'1042423423',
	'personal_user_id':'324234234324',
	'personal_session':'dsdf324234234324',
	'execute_user_list':'数据结构JSON示例',
	'auth_way':'HAND_INPUT',
	'cert_json':'{\"address\":\"浙江省杭州市\",\"name\":\"张三\",\"number\":\"324234324234234\"}',
	'cert_type':'0',
	'skip':'1',
	'app_context_param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_guoguo_fulfil_ocrhandrealname_response>
    <data>
        <fulfil_task_id>1042423423</fulfil_task_id>
        <require_order_id>1042423499</require_order_id>
        <sapphire_cert_id>foo</sapphire_cert_id>
        <trace_id>0be4314615320739620257888e18e2</trace_id>
    </data>
    <status_code>foo</status_code>
    <status_message>foo</status_message>
    <is_success>false</is_success>
</cainiao_guoguo_fulfil_ocrhandrealname_response>

{
    "cainiao_guoguo_fulfil_ocrhandrealname_response":{
        "data":{
            "fulfil_task_id":1042423423,
            "require_order_id":1042423499,
            "sapphire_cert_id":"foo",
            "trace_id":"0be4314615320739620257888e18e2"
        },
        "status_code":"foo",
        "status_message":"foo",
        "is_success":false
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

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

错误码	错误描述	解决方案

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

开放平台

菜鸟无线API

cainiao.guoguo.fulfil.ocrhandrealname (快递员寄件实名接口ocrHandRealName)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ