淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
personal_user_id	Number	可选	1231	菜鸟账号ID
invitation_id	Number	可选	1231	邀请ID
personal_session	String	可选	1231	菜鸟账号session
application_org_id	Number	可选	1231	申请组织id
join_type	String	可选	1231	组织加入类型

名称	类型	示例值	描述
data	EmployeeCheckResultDto		返回结果
item_check_lists EmployeeCheckItemResultDto [] 状态检验集合 └ result Boolean false 检验结果 └ result_code String foo 检验结果编码 └ result_level String block 阻塞等级 └ result_msg String foo 检验信息 └ result_title String resultTitle └ result Boolean false 检验结果 └ result_code String foo 检验结果编码 └ result_level String block 阻塞等级 └ result_msg String 检测通过检验内容 └ result_tilte String 检测通过检测标题 └ result_tip String 温馨提示温馨提示
status_code	String	foo	状态编码
status_message	String	foo	状态信息
is_success	Boolean	true	成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGuoguoEmployeeCheckinvitationRequest req = new CainiaoGuoguoEmployeeCheckinvitationRequest();
req.setPersonalUserId(1231L);
req.setInvitationId(1231L);
req.setPersonalSession("1231");
req.setApplicationOrgId(1231L);
req.setJoinType("1231");
CainiaoGuoguoEmployeeCheckinvitationResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoGuoguoEmployeeCheckinvitationRequest req = new CainiaoGuoguoEmployeeCheckinvitationRequest();
req.PersonalUserId = 1231L;
req.InvitationId = 1231L;
req.PersonalSession = "1231";
req.ApplicationOrgId = 1231L;
req.JoinType = "1231";
CainiaoGuoguoEmployeeCheckinvitationResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoGuoguoEmployeeCheckinvitationRequest;
$req->setPersonalUserId("1231");
$req->setInvitationId("1231");
$req->setPersonalSession("1231");
$req->setApplicationOrgId("1231");
$req->setJoinType("1231");
$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.employee.checkinvitation' \
-d 'partner_id=apidoc' \
-d 'sign=9EBA26C56FCFDAC8F64AF092F1193054' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+16%3A40%3A36' \
-d 'v=2.0' \
-d 'application_org_id=1231' \
-d 'invitation_id=1231' \
-d 'join_type=1231' \
-d 'personal_session=1231' \
-d 'personal_user_id=1231'

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

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

req.personal_user_id=1231
req.invitation_id=1231
req.personal_session="1231"
req.application_org_id=1231
req.join_type="1231"
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.employee.checkinvitation");
add_param(pRequest,"personal_user_id","1231");
add_param(pRequest,"invitation_id","1231");
add_param(pRequest,"personal_session","1231");
add_param(pRequest,"application_org_id","1231");
add_param(pRequest,"join_type","1231");
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.employee.checkinvitation', {
	'personal_user_id':'1231',
	'invitation_id':'1231',
	'personal_session':'1231',
	'application_org_id':'1231',
	'join_type':'1231'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_guoguo_employee_checkinvitation_response>
    <data>
        <item_check_lists>
            <employee_check_item_result_dto>
                <result>false</result>
                <result_code>foo</result_code>
                <result_level>block</result_level>
                <result_msg>foo</result_msg>
                <result_title></result_title>
            </employee_check_item_result_dto>
        </item_check_lists>
        <result>false</result>
        <result_code>foo</result_code>
        <result_level>block</result_level>
        <result_msg>检测通过</result_msg>
        <result_tilte>检测通过</result_tilte>
        <result_tip>温馨提示</result_tip>
    </data>
    <status_code>foo</status_code>
    <status_message>foo</status_message>
    <is_success>true</is_success>
</cainiao_guoguo_employee_checkinvitation_response>

{
    "cainiao_guoguo_employee_checkinvitation_response":{
        "data":{
            "item_check_lists":{
                "employee_check_item_result_dto":[
                    {
                        "result":false,
                        "result_code":"foo",
                        "result_level":"block",
                        "result_msg":"foo",
                        "result_title":""
                    }
                ]
            },
            "result":false,
            "result_code":"foo",
            "result_level":"block",
            "result_msg":"检测通过",
            "result_tilte":"检测通过",
            "result_tip":"温馨提示"
        },
        "status_code":"foo",
        "status_message":"foo",
        "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"
	}
}

错误码	错误描述	解决方案

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

开放平台

菜鸟无线API

cainiao.guoguo.employee.checkinvitation (检查邀请)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ