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

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
execute_user_list	ExecuteUserDto []	可选		最大列表长度：20	执行人账号list
└ execute_user_id Number 可选 4398050052418 执行人账号id └ execute_user_type String 可选 FWD 执行人账号类型
personal_user_id	Number	可选	4398050052418		个人账号id
require_order_id	Number	可选	123456		需求单id
personal_session	String	可选	613241rarf12aada		个人session
task_id	Number	可选	654321		任务单id

名称	类型	示例值	描述
data	AbnormalReasonQueryResultDto	1234	data
fulfil_relate_list FulfilRelateDto [] fulfilRelateList area_relate_list AreaRelateDto [] areaRelateList └ area_id Number 区域id └ area_name String 区域名称 reason_list FulfilReasonDto [] 原因列表 └ reason_code Number 原因code └ reason_content String 原因内容 └ disabled Boolean disabled └ fulfil_type Number 履行方式 └ fulfil_type_desc String 履行方式描述 reason_list FulfilReasonDto [] 原因列表 └ reason_code Number 原因code └ reason_content String 原因 └ title_list String [] 标题列表
msg_code	String	"isv.invalid-parameter"	errorCode
error_message	String		errorMessage
status_code	String		statusCode
status_message	String		statusMessage
is_success	Boolean	false	success
trace_id	String		traceId

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGuoguoCourierQueryabnormalsRequest req = new CainiaoGuoguoCourierQueryabnormalsRequest();
List<CainiaoGuoguoCourierQueryabnormalsRequest.ExecuteUserDto> list2 = new ArrayList<CainiaoGuoguoCourierQueryabnormalsRequest.ExecuteUserDto>();
CainiaoGuoguoCourierQueryabnormalsRequest.ExecuteUserDto obj3 = new CainiaoGuoguoCourierQueryabnormalsRequest.ExecuteUserDto();
list2.add(obj3);
obj3.setExecuteUserId(4398050052418L);
obj3.setExecuteUserType("FWD");
req.setExecuteUserList(list2);
req.setPersonalUserId(4398050052418L);
req.setRequireOrderId(123456L);
req.setPersonalSession("613241rarf12aada");
req.setTaskId(654321L);
CainiaoGuoguoCourierQueryabnormalsResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoGuoguoCourierQueryabnormalsRequest req = new CainiaoGuoguoCourierQueryabnormalsRequest();
List<CainiaoGuoguoCourierQueryabnormalsRequest.ExecuteUserDtoDomain> list2 = new List<CainiaoGuoguoCourierQueryabnormalsRequest.ExecuteUserDtoDomain>();
CainiaoGuoguoCourierQueryabnormalsRequest.ExecuteUserDtoDomain obj3 = new CainiaoGuoguoCourierQueryabnormalsRequest.ExecuteUserDtoDomain();
list2.Add(obj3);
obj3.ExecuteUserId = 4398050052418L;
obj3.ExecuteUserType = "FWD";
req.ExecuteUserList_ = list2;
req.PersonalUserId = 4398050052418L;
req.RequireOrderId = 123456L;
req.PersonalSession = "613241rarf12aada";
req.TaskId = 654321L;
CainiaoGuoguoCourierQueryabnormalsResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoGuoguoCourierQueryabnormalsRequest;
$execute_user_list = new ExecuteUserDto;
$execute_user_list->execute_user_id="4398050052418";
$execute_user_list->execute_user_type="FWD";
$req->setExecuteUserList(json_encode($execute_user_list));
$req->setPersonalUserId("4398050052418");
$req->setRequireOrderId("123456");
$req->setPersonalSession("613241rarf12aada");
$req->setTaskId("654321");
$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.queryabnormals' \
-d 'partner_id=apidoc' \
-d 'sign=315AB7F00C76EE3586FF67A9ED7D9FE9' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-02+10%3A41%3A18' \
-d 'v=2.0' \
-d 'execute_user_list=null' \
-d 'personal_session=613241rarf12aada' \
-d 'personal_user_id=4398050052418' \
-d 'require_order_id=123456' \
-d 'task_id=654321'

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

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

req.execute_user_list=""
req.personal_user_id=4398050052418
req.require_order_id=123456
req.personal_session="613241rarf12aada"
req.task_id=654321
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.queryabnormals");
add_param(pRequest,"execute_user_list","数据结构JSON示例");
add_param(pRequest,"personal_user_id","4398050052418");
add_param(pRequest,"require_order_id","123456");
add_param(pRequest,"personal_session","613241rarf12aada");
add_param(pRequest,"task_id","654321");
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.queryabnormals', {
	'execute_user_list':'数据结构JSON示例',
	'personal_user_id':'4398050052418',
	'require_order_id':'123456',
	'personal_session':'613241rarf12aada',
	'task_id':'654321'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_guoguo_courier_queryabnormals_response>
    <data>
        <fulfil_relate_list>
            <fulfil_relate_dto>
                <area_relate_list>
                    <area_relate_dto>
                        <area_id></area_id>
                        <area_name></area_name>
                        <reason_list>
                            <fulfil_reason_dto>
                                <reason_code></reason_code>
                                <reason_content></reason_content>
                            </fulfil_reason_dto>
                        </reason_list>
                    </area_relate_dto>
                </area_relate_list>
                <disabled></disabled>
                <fulfil_type></fulfil_type>
                <fulfil_type_desc></fulfil_type_desc>
                <reason_list>
                    <fulfil_reason_dto>
                        <reason_code></reason_code>
                        <reason_content></reason_content>
                    </fulfil_reason_dto>
                </reason_list>
            </fulfil_relate_dto>
        </fulfil_relate_list>
        <title_list>
            <string></string>
        </title_list>
    </data>
    <msg_code>&quot;isv.invalid-parameter&quot;</msg_code>
    <error_message></error_message>
    <status_code></status_code>
    <status_message></status_message>
    <is_success>false</is_success>
    <trace_id></trace_id>
</cainiao_guoguo_courier_queryabnormals_response>

{
    "cainiao_guoguo_courier_queryabnormals_response":{
        "data":{
            "fulfil_relate_list":{
                "fulfil_relate_dto":[
                    {
                        "area_relate_list":{
                            "area_relate_dto":[
                                {
                                    "area_id":,
                                    "area_name":"",
                                    "reason_list":{
                                        "fulfil_reason_dto":[
                                            {
                                                "reason_code":,
                                                "reason_content":""
                                            }
                                        ]
                                    }
                                }
                            ]
                        },
                        "disabled":,
                        "fulfil_type":,
                        "fulfil_type_desc":"",
                        "reason_list":{
                            "fulfil_reason_dto":[
                                {
                                    "reason_code":,
                                    "reason_content":""
                                }
                            ]
                        }
                    }
                ]
            },
            "title_list":{
                "string":[
                    ""
                ]
            }
        },
        "msg_code":"\"isv.invalid-parameter\"",
        "error_message":"",
        "status_code":"",
        "status_message":"",
        "is_success":false,
        "trace_id":""
    }
}

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.queryabnormals (驿站派件查看异常原因列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈