淘宝开放平台 - 文档中心

请求地址：

环境	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。

名称	类型	是否必须	示例值	更多限制	描述
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的版本号
execute_user_list	ExecuteUserDto []	必须		最大列表长度：20	账号list
└ execute_user_id Number 必须 0 参数executeUserId └ execute_user_type String 必须 foo 参数executeUserType
identity_code_type	Number	可选	1		身份码来源 1-支付宝 2-手淘，必传
identity_code_value	String	必须	www.baidfafew.dsaf		身份码信息值，必传
personal_session	String	必须	dsdf324234234324		个人账号sessionCode不能为空
personal_user_id	Number	必须	324234234324		个人账号ID不能为空
task_order_id	Number	必须	1042423423		履行任务单ID不能为空

名称	类型	示例值	描述
data	GetRealNameInfoByIdentityCodeResponse		参数data
real_name_info RealNameInfo 参数realNameInfo └ cert_no String foo 参数certNo └ cert_type Number 0 参数certType └ extend_json String foo 参数extendJson picture_list RealNamePictureInfo [] 参数pictureList └ type String foo 参数type └ url String foo 参数url └ real_name String foo 参数realName └ sex Number 0 参数sex
status_code	String	PARAMS_CANNOT_BE_NULL	错误码
status_message	String	参数不能为空	错误描述
is_success	Boolean	true	是否成功
trace_id	String	0be4314615320739620257888e18e2	鹰眼ID

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGuoguoFulfilGetrealnameinfoIdentitycodeRequest req = new CainiaoGuoguoFulfilGetrealnameinfoIdentitycodeRequest();
CainiaoGuoguoFulfilGetrealnameinfoIdentitycodeRequest.AppContextParam obj1 = new CainiaoGuoguoFulfilGetrealnameinfoIdentitycodeRequest.AppContextParam();
obj1.setAppBattery("45");
obj1.setDeviceType("ios");
obj1.setLocAccuracy("23");
obj1.setLocAuth("true");
obj1.setLocLat("123.22");
obj1.setLocLng("123.22");
obj1.setLocOpen("true");
obj1.setLocSucc("true");
obj1.setLocTime(123L);
obj1.setLocType("gps");
obj1.setPkgId("fsdfId");
obj1.setPkgName("fsdf.sdf");
obj1.setSdkVersion("6.0.1");
req.setAppContextParam(obj1);
List<CainiaoGuoguoFulfilGetrealnameinfoIdentitycodeRequest.ExecuteUserDto> list3 = new ArrayList<CainiaoGuoguoFulfilGetrealnameinfoIdentitycodeRequest.ExecuteUserDto>();
CainiaoGuoguoFulfilGetrealnameinfoIdentitycodeRequest.ExecuteUserDto obj4 = new CainiaoGuoguoFulfilGetrealnameinfoIdentitycodeRequest.ExecuteUserDto();
list3.add(obj4);
obj4.setExecuteUserId(0L);
obj4.setExecuteUserType("foo");
req.setExecuteUserList(list3);
req.setIdentityCodeType(1L);
req.setIdentityCodeValue("www.baidfafew.dsaf");
req.setPersonalSession("dsdf324234234324");
req.setPersonalUserId(324234234324L);
req.setTaskOrderId(1042423423L);
CainiaoGuoguoFulfilGetrealnameinfoIdentitycodeResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoGuoguoFulfilGetrealnameinfoIdentitycodeRequest req = new CainiaoGuoguoFulfilGetrealnameinfoIdentitycodeRequest();
CainiaoGuoguoFulfilGetrealnameinfoIdentitycodeRequest.AppContextParamDomain obj1 = new CainiaoGuoguoFulfilGetrealnameinfoIdentitycodeRequest.AppContextParamDomain();
obj1.AppBattery = "45";
obj1.DeviceType = "ios";
obj1.LocAccuracy = "23";
obj1.LocAuth = "true";
obj1.LocLat = "123.22";
obj1.LocLng = "123.22";
obj1.LocOpen = "true";
obj1.LocSucc = "true";
obj1.LocTime = 123L;
obj1.LocType = "gps";
obj1.PkgId = "fsdfId";
obj1.PkgName = "fsdf.sdf";
obj1.SdkVersion = "6.0.1";
req.AppContextParam_ = obj1;
List<CainiaoGuoguoFulfilGetrealnameinfoIdentitycodeRequest.ExecuteUserDtoDomain> list3 = new List<CainiaoGuoguoFulfilGetrealnameinfoIdentitycodeRequest.ExecuteUserDtoDomain>();
CainiaoGuoguoFulfilGetrealnameinfoIdentitycodeRequest.ExecuteUserDtoDomain obj4 = new CainiaoGuoguoFulfilGetrealnameinfoIdentitycodeRequest.ExecuteUserDtoDomain();
list3.Add(obj4);
obj4.ExecuteUserId = 0L;
obj4.ExecuteUserType = "foo";
req.ExecuteUserList_ = list3;
req.IdentityCodeType = 1L;
req.IdentityCodeValue = "www.baidfafew.dsaf";
req.PersonalSession = "dsdf324234234324";
req.PersonalUserId = 324234234324L;
req.TaskOrderId = 1042423423L;
CainiaoGuoguoFulfilGetrealnameinfoIdentitycodeResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoGuoguoFulfilGetrealnameinfoIdentitycodeRequest;
$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));
$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->setIdentityCodeType("1");
$req->setIdentityCodeValue("www.baidfafew.dsaf");
$req->setPersonalSession("dsdf324234234324");
$req->setPersonalUserId("324234234324");
$req->setTaskOrderId("1042423423");
$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.getrealnameinfo.identitycode' \
-d 'partner_id=apidoc' \
-d 'sign=0BE91C62D3CC426F7EF475B5412BDFA5' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+16%3A47%3A44' \
-d 'v=2.0' \
-d 'app_context_param=null' \
-d 'execute_user_list=null' \
-d 'identity_code_type=1' \
-d 'identity_code_value=www.baidfafew.dsaf' \
-d 'personal_session=dsdf324234234324' \
-d 'personal_user_id=324234234324' \
-d 'task_order_id=1042423423'

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

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

req.app_context_param=""
req.execute_user_list=""
req.identity_code_type=1
req.identity_code_value="www.baidfafew.dsaf"
req.personal_session="dsdf324234234324"
req.personal_user_id=324234234324
req.task_order_id=1042423423
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.getrealnameinfo.identitycode");
add_param(pRequest,"app_context_param","数据结构JSON示例");
add_param(pRequest,"execute_user_list","数据结构JSON示例");
add_param(pRequest,"identity_code_type","1");
add_param(pRequest,"identity_code_value","www.baidfafew.dsaf");
add_param(pRequest,"personal_session","dsdf324234234324");
add_param(pRequest,"personal_user_id","324234234324");
add_param(pRequest,"task_order_id","1042423423");
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.getrealnameinfo.identitycode', {
	'app_context_param':'数据结构JSON示例',
	'execute_user_list':'数据结构JSON示例',
	'identity_code_type':'1',
	'identity_code_value':'www.baidfafew.dsaf',
	'personal_session':'dsdf324234234324',
	'personal_user_id':'324234234324',
	'task_order_id':'1042423423'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_guoguo_fulfil_getrealnameinfo_identitycode_response>
    <data>
        <real_name_info>
            <cert_no>foo</cert_no>
            <cert_type>0</cert_type>
            <extend_json>foo</extend_json>
            <picture_list>
                <real_name_picture_info>
                    <type>foo</type>
                    <url>foo</url>
                </real_name_picture_info>
            </picture_list>
            <real_name>foo</real_name>
            <sex>0</sex>
        </real_name_info>
    </data>
    <status_code>PARAMS_CANNOT_BE_NULL</status_code>
    <status_message>参数不能为空</status_message>
    <is_success>true</is_success>
    <trace_id>0be4314615320739620257888e18e2</trace_id>
</cainiao_guoguo_fulfil_getrealnameinfo_identitycode_response>

{
    "cainiao_guoguo_fulfil_getrealnameinfo_identitycode_response":{
        "data":{
            "real_name_info":{
                "cert_no":"foo",
                "cert_type":0,
                "extend_json":"foo",
                "picture_list":{
                    "real_name_picture_info":[
                        {
                            "type":"foo",
                            "url":"foo"
                        }
                    ]
                },
                "real_name":"foo",
                "sex":0
            }
        },
        "status_code":"PARAMS_CANNOT_BE_NULL",
        "status_message":"参数不能为空",
        "is_success":true,
        "trace_id":"0be4314615320739620257888e18e2"
    }
}

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.getrealnameinfo.identitycode (快递员寄件实名接口getRealNameInfoByIdentityCode)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ