淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
apply_base_info_list	ApplyBaseInfo []	必须		最大列表长度：20	每个申请人的通知结果
└ apply_id String 可选 111 申请人Id └ outer_apply_id String 可选 222 商家申请人Id └ err_code Number 可选 500 错误码 └ success Boolean 可选 true 通知结果 └ err_msg String 可选 xxxxx 错误信息 └ ext_info String 可选 xxxx 扩展信息 └ sign_url String 可选 http://xxxx 出签结果url └ invoice_url String 可选 http://xxxx 发票url └ sign_oss_key String 可选 xxxx 出签结果osskey └ invoice_oss_key String 可选 xxxx 发票osskey └ apply_status Number 可选 10 申请状态 └ reject_letter_oss_key String 可选 xxx 拒签信osskey └ reject_letter_url String 可选 http://xxxx 拒签信url └ interview_time Date 可选 2018-02-01 08:00:00 面试时间 └ interview_request_time Date 可选 2018-02-01 08:00:00 面试发起时间 └ interview_branch String 可选 xxx 面试机构 └ interview_postcode String 可选 116011 面试地邮编 └ interview_city String 可选上海面试地城市 └ interview_country String 可选中国面试地国家 └ interview_phone_no String 可选 0411-12345678 面试电话 └ interview_fax String 可选 1234567 面试邮编 └ interview_addr String 可选 XXX 面试地址 └ request_doc_time Date 可选 2018-02-01 08:00:00 发起补充材料时间 form_fileds SupplementDocInfo [] 可选表单补充字段列表 └ apply_form_filed String 可选 name 表单字段 └ doc_type Number 可选 1 doc类型 └ doc_comment String 可选需写清晰补充材料描述 apply_docs SupplementDocInfo [] 可选上传资料补充列表 └ apply_form_filed String 可选 name 表单字段 └ doc_type Number 可选 1 doc类型 └ doc_comment String 可选需写清晰补充材料描述
order_id	Number	可选	11111		订单ID
notice_type	String	可选	2222		通知类型
outer_order_id	String	可选	1111		外部商家订单ID

名称	类型	示例值	描述
result	ResultSet		返回结果信息
└ error_code String xxx 错误码 └ error_msg String xxxx 错误码信息 └ is_success Boolean true 成功or 失败

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlitripTravelOnlinevisaOrderresultNotifyRequest req = new AlitripTravelOnlinevisaOrderresultNotifyRequest();
List<AlitripTravelOnlinevisaOrderresultNotifyRequest.ApplyBaseInfo> list2 = new ArrayList<AlitripTravelOnlinevisaOrderresultNotifyRequest.ApplyBaseInfo>();
AlitripTravelOnlinevisaOrderresultNotifyRequest.ApplyBaseInfo obj3 = new AlitripTravelOnlinevisaOrderresultNotifyRequest.ApplyBaseInfo();
list2.add(obj3);
obj3.setApplyId("111");
obj3.setOuterApplyId("222");
obj3.setErrCode(500L);
obj3.setSuccess(true);
obj3.setErrMsg("xxxxx");
obj3.setExtInfo("xxxx");
obj3.setSignUrl("http://xxxx");
obj3.setInvoiceUrl("http://xxxx");
obj3.setSignOssKey("xxxx");
obj3.setInvoiceOssKey("xxxx");
obj3.setApplyStatus(10L);
obj3.setRejectLetterOssKey("xxx");
obj3.setRejectLetterUrl("http://xxxx");
obj3.setInterviewTime(StringUtils.parseDateTime("2018-02-01 08:00:00"));
obj3.setInterviewRequestTime(StringUtils.parseDateTime("2018-02-01 08:00:00"));
obj3.setInterviewBranch("xxx");
obj3.setInterviewPostcode("116011");
obj3.setInterviewCity("上海");
obj3.setInterviewCountry("中国");
obj3.setInterviewPhoneNo("0411-12345678");
obj3.setInterviewFax("1234567");
obj3.setInterviewAddr("XXX");
obj3.setRequestDocTime(StringUtils.parseDateTime("2018-02-01 08:00:00"));
List<AlitripTravelOnlinevisaOrderresultNotifyRequest.SupplementDocInfo> list6 = new ArrayList<AlitripTravelOnlinevisaOrderresultNotifyRequest.SupplementDocInfo>();
AlitripTravelOnlinevisaOrderresultNotifyRequest.SupplementDocInfo obj7 = new AlitripTravelOnlinevisaOrderresultNotifyRequest.SupplementDocInfo();
list6.add(obj7);
obj7.setApplyFormFiled("name");
obj7.setDocType(1L);
obj7.setDocComment("需写清晰");
list4.setFormFileds(list6);
List<AlitripTravelOnlinevisaOrderresultNotifyRequest.SupplementDocInfo> list10 = new ArrayList<AlitripTravelOnlinevisaOrderresultNotifyRequest.SupplementDocInfo>();
AlitripTravelOnlinevisaOrderresultNotifyRequest.SupplementDocInfo obj11 = new AlitripTravelOnlinevisaOrderresultNotifyRequest.SupplementDocInfo();
list10.add(obj11);
obj11.setApplyFormFiled("name");
obj11.setDocType(1L);
obj11.setDocComment("需写清晰");
list8.setApplyDocs(list10);
req.setApplyBaseInfoList(list2);
req.setOrderId(11111L);
req.setNoticeType("2222");
req.setOuterOrderId("1111");
AlitripTravelOnlinevisaOrderresultNotifyResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlitripTravelOnlinevisaOrderresultNotifyRequest req = new AlitripTravelOnlinevisaOrderresultNotifyRequest();
List<AlitripTravelOnlinevisaOrderresultNotifyRequest.ApplyBaseInfoDomain> list2 = new List<AlitripTravelOnlinevisaOrderresultNotifyRequest.ApplyBaseInfoDomain>();
AlitripTravelOnlinevisaOrderresultNotifyRequest.ApplyBaseInfoDomain obj3 = new AlitripTravelOnlinevisaOrderresultNotifyRequest.ApplyBaseInfoDomain();
list2.Add(obj3);
obj3.ApplyId = "111";
obj3.OuterApplyId = "222";
obj3.ErrCode = 500L;
obj3.Success = true;
obj3.ErrMsg = "xxxxx";
obj3.ExtInfo = "xxxx";
obj3.SignUrl = "http://xxxx";
obj3.InvoiceUrl = "http://xxxx";
obj3.SignOssKey = "xxxx";
obj3.InvoiceOssKey = "xxxx";
obj3.ApplyStatus = 10L;
obj3.RejectLetterOssKey = "xxx";
obj3.RejectLetterUrl = "http://xxxx";
obj3.InterviewTime = DateTime.Parse(2018-02-01 08:00:00");
obj3.InterviewRequestTime = DateTime.Parse(2018-02-01 08:00:00");
obj3.InterviewBranch = "xxx";
obj3.InterviewPostcode = "116011";
obj3.InterviewCity = "上海";
obj3.InterviewCountry = "中国";
obj3.InterviewPhoneNo = "0411-12345678";
obj3.InterviewFax = "1234567";
obj3.InterviewAddr = "XXX";
obj3.RequestDocTime = DateTime.Parse(2018-02-01 08:00:00");
List<AlitripTravelOnlinevisaOrderresultNotifyRequest.SupplementDocInfoDomain> list5 = new List<AlitripTravelOnlinevisaOrderresultNotifyRequest.SupplementDocInfoDomain>();
AlitripTravelOnlinevisaOrderresultNotifyRequest.SupplementDocInfoDomain obj6 = new AlitripTravelOnlinevisaOrderresultNotifyRequest.SupplementDocInfoDomain();
list5.Add(obj6);
obj6.ApplyFormFiled = "name";
obj6.DocType = 1L;
obj6.DocComment = "需写清晰";
obj3.FormFileds= list5;
List<AlitripTravelOnlinevisaOrderresultNotifyRequest.SupplementDocInfoDomain> list8 = new List<AlitripTravelOnlinevisaOrderresultNotifyRequest.SupplementDocInfoDomain>();
AlitripTravelOnlinevisaOrderresultNotifyRequest.SupplementDocInfoDomain obj9 = new AlitripTravelOnlinevisaOrderresultNotifyRequest.SupplementDocInfoDomain();
list8.Add(obj9);
obj9.ApplyFormFiled = "name";
obj9.DocType = 1L;
obj9.DocComment = "需写清晰";
obj3.ApplyDocs= list8;
req.ApplyBaseInfoList_ = list2;
req.OrderId = 11111L;
req.NoticeType = "2222";
req.OuterOrderId = "1111";
AlitripTravelOnlinevisaOrderresultNotifyResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlitripTravelOnlinevisaOrderresultNotifyRequest;
$apply_base_info_list = new ApplyBaseInfo;
$apply_base_info_list->apply_id="111";
$apply_base_info_list->outer_apply_id="222";
$apply_base_info_list->err_code="500";
$apply_base_info_list->success="true";
$apply_base_info_list->err_msg="xxxxx";
$apply_base_info_list->ext_info="xxxx";
$apply_base_info_list->sign_url="http://xxxx";
$apply_base_info_list->invoice_url="http://xxxx";
$apply_base_info_list->sign_oss_key="xxxx";
$apply_base_info_list->invoice_oss_key="xxxx";
$apply_base_info_list->apply_status="10";
$apply_base_info_list->reject_letter_oss_key="xxx";
$apply_base_info_list->reject_letter_url="http://xxxx";
$apply_base_info_list->interview_time="2018-02-01 08:00:00";
$apply_base_info_list->interview_request_time="2018-02-01 08:00:00";
$apply_base_info_list->interview_branch="xxx";
$apply_base_info_list->interview_postcode="116011";
$apply_base_info_list->interview_city="上海";
$apply_base_info_list->interview_country="中国";
$apply_base_info_list->interview_phone_no="0411-12345678";
$apply_base_info_list->interview_fax="1234567";
$apply_base_info_list->interview_addr="XXX";
$apply_base_info_list->request_doc_time="2018-02-01 08:00:00";
$form_fileds = new SupplementDocInfo;
$form_fileds->apply_form_filed="name";
$form_fileds->doc_type="1";
$form_fileds->doc_comment="需写清晰";
$apply_base_info_list->form_fileds = $form_fileds;
$apply_docs = new SupplementDocInfo;
$apply_docs->apply_form_filed="name";
$apply_docs->doc_type="1";
$apply_docs->doc_comment="需写清晰";
$apply_base_info_list->apply_docs = $apply_docs;
$req->setApplyBaseInfoList(json_encode($apply_base_info_list));
$req->setOrderId("11111");
$req->setNoticeType("2222");
$req->setOuterOrderId("1111");
$resp = $c->execute($req, $sessionKey);

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=alitrip.travel.onlinevisa.orderresult.notify' \
-d 'partner_id=apidoc' \
-d 'session=045cfe76-9a0f-47b2-9eb9-2cd3a94e4158' \
-d 'sign=787858BEE0D1B5E7B7D1D0C8736343C4' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-01-07+06%3A29%3A54' \
-d 'v=2.0' \
-d 'apply_base_info_list=null' \
-d 'notice_type=2222' \
-d 'order_id=11111' \
-d 'outer_order_id=1111'

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

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

req.apply_base_info_list=""
req.order_id=11111
req.notice_type="2222"
req.outer_order_id="1111"
try:
	resp= req.getResponse(sessionkey)
	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,"alitrip.travel.onlinevisa.orderresult.notify");
add_param(pRequest,"apply_base_info_list","数据结构JSON示例");
add_param(pRequest,"order_id","11111");
add_param(pRequest,"notice_type","2222");
add_param(pRequest,"outer_order_id","1111");
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('alitrip.travel.onlinevisa.orderresult.notify', {
	'apply_base_info_list':'数据结构JSON示例',
	'order_id':'11111',
	'notice_type':'2222',
	'outer_order_id':'1111'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alitrip_travel_onlinevisa_orderresult_notify_response>
    <result>
        <error_code>xxx</error_code>
        <error_msg>xxxx</error_msg>
        <is_success>true</is_success>
    </result>
</alitrip_travel_onlinevisa_orderresult_notify_response>

{
    "alitrip_travel_onlinevisa_orderresult_notify_response":{
        "result":{
            "error_code":"xxx",
            "error_msg":"xxxx",
            "is_success":true
        }
    }
}

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"
	}
}

错误码	错误描述	解决方案
isv.PARAM_ERROR	参数异常	根据错误提示修改

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

开放平台

度假-签证管理API

alitrip.travel.onlinevisa.orderresult.notify (签证订单服务完成通知接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ