阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
mail_cp_code	String	可选	YUNDA		cp code
execute_user_list	ExecuteUserDto []	可选		最大列表长度：20	账号ID+type数据
└ execute_user_id Number 可选 43980 ID └ execute_user_type String 可选 CP,FWD,PERSON 类型
mail_no	String	可选	111000333		运单号
personal_session	String	可选	aaabbb		个人账号session
personal_user_id	Number	可选	43980		个人账号ID

名称	类型	示例值	描述
data	GotTaskOrderDto	1234	data
└ got_status String ok ok 揽收成功, fail 揽收失败, list 一号多单, got_task_error GotTaskErrorDto 揽收错误 └ code String 400 错误码 └ description String 运单已被氢一揽收描述 └ title String 该运单不属于你错误原因 task_cp_list GotTaskCpdto [] taskCpList └ cp_code String TTKDEX cpCode └ cp_name String 天天快递公司名字 └ mail_no String 110 运单号 task_info GotTaskInfoDto taskInfo └ area_name String A区柜子区域名字 └ fulfil_desc String 9号楼履行描述 └ fulfil_type String 上门履行方式 └ is_tb_order Boolean true 是否淘系订单 └ mail_no String 0002 运单号 └ receiver_address String 收件人地址收件人地址 └ receiver_name String 氢一收件人名字 └ receiver_phone String 156 收件人号码 └ station_order_type String station_general 驿站2.0：staion_2_0，综合站： station_general └ require_order_id Number 110 需求单号 └ task_id Number 220 任务单号 └ fulfil_type_id String 11 履行方式编号
status_code	String	200	statusCode
status_message	String	OK	statusMessage
is_success	Boolean	false	success
trace_id	String	2222	traceId

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGuoguoCourierTaskorderGotRequest req = new CainiaoGuoguoCourierTaskorderGotRequest();
req.setMailCpCode("YUNDA");
List<CainiaoGuoguoCourierTaskorderGotRequest.ExecuteUserDto> list2 = new ArrayList<CainiaoGuoguoCourierTaskorderGotRequest.ExecuteUserDto>();
CainiaoGuoguoCourierTaskorderGotRequest.ExecuteUserDto obj3 = new CainiaoGuoguoCourierTaskorderGotRequest.ExecuteUserDto();
list2.add(obj3);
obj3.setExecuteUserId(43980L);
obj3.setExecuteUserType("CP,FWD,PERSON");
req.setExecuteUserList(list2);
req.setMailNo("111000333");
req.setPersonalSession("aaabbb");
req.setPersonalUserId(43980L);
CainiaoGuoguoCourierTaskorderGotResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoGuoguoCourierTaskorderGotRequest req = new CainiaoGuoguoCourierTaskorderGotRequest();
req.MailCpCode = "YUNDA";
List<CainiaoGuoguoCourierTaskorderGotRequest.ExecuteUserDtoDomain> list2 = new List<CainiaoGuoguoCourierTaskorderGotRequest.ExecuteUserDtoDomain>();
CainiaoGuoguoCourierTaskorderGotRequest.ExecuteUserDtoDomain obj3 = new CainiaoGuoguoCourierTaskorderGotRequest.ExecuteUserDtoDomain();
list2.Add(obj3);
obj3.ExecuteUserId = 43980L;
obj3.ExecuteUserType = "CP,FWD,PERSON";
req.ExecuteUserList_ = list2;
req.MailNo = "111000333";
req.PersonalSession = "aaabbb";
req.PersonalUserId = 43980L;
CainiaoGuoguoCourierTaskorderGotResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoGuoguoCourierTaskorderGotRequest;
$req->setMailCpCode("YUNDA");
$execute_user_list = new ExecuteUserDto;
$execute_user_list->execute_user_id="43980";
$execute_user_list->execute_user_type="CP,FWD,PERSON";
$req->setExecuteUserList(json_encode($execute_user_list));
$req->setMailNo("111000333");
$req->setPersonalSession("aaabbb");
$req->setPersonalUserId("43980");
$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.courier.taskorder.got' \
-d 'partner_id=apidoc' \
-d 'sign=EFCC90EE46CC910A099506109928A74E' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+15%3A48%3A48' \
-d 'v=2.0' \
-d 'execute_user_list=null' \
-d 'mail_cp_code=YUNDA' \
-d 'mail_no=111000333' \
-d 'personal_session=aaabbb' \
-d 'personal_user_id=43980'

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

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

req.mail_cp_code="YUNDA"
req.execute_user_list=""
req.mail_no="111000333"
req.personal_session="aaabbb"
req.personal_user_id=43980
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.courier.taskorder.got");
add_param(pRequest,"mail_cp_code","YUNDA");
add_param(pRequest,"execute_user_list","数据结构JSON示例");
add_param(pRequest,"mail_no","111000333");
add_param(pRequest,"personal_session","aaabbb");
add_param(pRequest,"personal_user_id","43980");
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.courier.taskorder.got', {
	'mail_cp_code':'YUNDA',
	'execute_user_list':'数据结构JSON示例',
	'mail_no':'111000333',
	'personal_session':'aaabbb',
	'personal_user_id':'43980'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_guoguo_courier_taskorder_got_response>
    <data>
        <got_status>ok</got_status>
        <got_task_error>
            <code>400</code>
            <description>运单已被 氢一 揽收</description>
            <title>该运单不属于你</title>
        </got_task_error>
        <task_cp_list>
            <got_task_cpdto>
                <cp_code>TTKDEX</cp_code>
                <cp_name>天天快递</cp_name>
                <mail_no>110</mail_no>
            </got_task_cpdto>
        </task_cp_list>
        <task_info>
            <area_name>A区柜子</area_name>
            <fulfil_desc>9号楼</fulfil_desc>
            <fulfil_type>上门</fulfil_type>
            <is_tb_order>true</is_tb_order>
            <mail_no>0002</mail_no>
            <receiver_address>收件人地址</receiver_address>
            <receiver_name>氢一</receiver_name>
            <receiver_phone>156</receiver_phone>
            <station_order_type>station_general</station_order_type>
            <require_order_id>110</require_order_id>
            <task_id>220</task_id>
            <fulfil_type_id>11</fulfil_type_id>
        </task_info>
    </data>
    <status_code>200</status_code>
    <status_message>OK</status_message>
    <is_success>false</is_success>
    <trace_id>2222</trace_id>
</cainiao_guoguo_courier_taskorder_got_response>

{
    "cainiao_guoguo_courier_taskorder_got_response":{
        "data":{
            "got_status":"ok",
            "got_task_error":{
                "code":"400",
                "description":"运单已被 氢一 揽收",
                "title":"该运单不属于你"
            },
            "task_cp_list":{
                "got_task_cpdto":[
                    {
                        "cp_code":"TTKDEX",
                        "cp_name":"天天快递",
                        "mail_no":"110"
                    }
                ]
            },
            "task_info":{
                "area_name":"A区柜子",
                "fulfil_desc":"9号楼",
                "fulfil_type":"上门",
                "is_tb_order":true,
                "mail_no":"0002",
                "receiver_address":"收件人地址",
                "receiver_name":"氢一",
                "receiver_phone":"156",
                "station_order_type":"station_general",
                "require_order_id":110,
                "task_id":220,
                "fulfil_type_id":"11"
            }
        },
        "status_code":"200",
        "status_message":"OK",
        "is_success":false,
        "trace_id":"2222"
    }
}

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.courier.taskorder.got (综合站扫码揽收接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈