淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
session_code	String	必须	aeebf50269d5400fa55af4b660478dc2		会话ID
biz_source	String	可选	yz_p2e		业务来源

名称	类型	示例值	描述
status_message	String	001	errorMessage
status_code	String	参数错误	errorCode
is_success	Boolean	true	success
data	CnUserBGXBindInfoDO	1	data
cnuser_info_dos Cnuserinfodos [] 1 cnUserInfoDOs └ create_device_id String 11 createDeviceId └ is_confirmed Number 0 isConfirmed └ boss_id Number 0 bossId └ user_type Number 0 userType └ city String 杭州 city └ enterprise_flag Number 0 enterpriseFlag └ avatar_url String www.cainiao.com avatarUrl └ alipay_type String 1 alipayType └ gender Number 0 gender └ ext_infos String 1 extInfos └ from_type Number 0 fromType └ alipay_id String 1 alipayId └ status Number 0 status └ link_mobile String 13732203455 linkMobile └ cn_user_id Number 0 cnUserId └ class_cainiao String com.cainiao.cnuser.client.domain.CnUserInfoDO class └ main_account_id Number 0 mainAccountId └ identity_card String 13732203455 identityCard └ isv_account_id String 423432534534 isvAccountId └ havana_id Number 0 havanaId └ nick String 梓茉 nick └ email String 小燕子4-220@163.com email └ alipay_user_type Number 0 alipayUserType └ security_mobile String 13732203455 securityMobile └ cp_mobile String 13732203455 mobile └ client_type String 1 clientType └ create_location String 杭州 createLocation └ gmt_modified Date 1507548970856 gmtModified └ birthday String 1 birthday └ user_agent String 1 userAgent └ locale String 1 locale └ lang String 1 lang └ sdk_version String 1 sdkVersion └ version Number 0 version └ work_station String 1 workStation └ verify_r_p_status Number 0 verifyRPStatus └ wangwang String 1 wangwang └ tag2 String 1 tag2 └ tag3 String 1 tag3 └ weixin String 1 weixin └ duty String 1 duty └ duty_type Number 0 dutyType └ domain String 1 domain └ current_device_id String 1 currentDeviceId └ alipay_account String 1 alipayAccount └ tag1 String 1 tag1 └ gmt_create Date 1507548970856 gmtCreate └ enterprise_name String 1 enterpriseName └ enterprise_id Number 0 enterpriseId └ main_account_flag Number 0 mainAccountFlag └ security_email String 1 securityEmail └ employee_no String 1 employeeNo └ enterprise_code String 1 enterpriseCode └ address String 1 address └ ext_info String 1 extInfo └ real_name String 1 realName └ attributes String 1 attributes └ display_name String 1 displayName └ need_confirm Number 0 needConfirm └ cp_user_id String 1 cpUserID

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoMemberWirelessCourierGetbgxbindusersRequest req = new CainiaoMemberWirelessCourierGetbgxbindusersRequest();
req.setSessionCode("aeebf50269d5400fa55af4b660478dc2");
req.setBizSource("yz_p2e");
CainiaoMemberWirelessCourierGetbgxbindusersResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoMemberWirelessCourierGetbgxbindusersRequest req = new CainiaoMemberWirelessCourierGetbgxbindusersRequest();
req.SessionCode = "aeebf50269d5400fa55af4b660478dc2";
req.BizSource = "yz_p2e";
CainiaoMemberWirelessCourierGetbgxbindusersResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoMemberWirelessCourierGetbgxbindusersRequest;
$req->setSessionCode("aeebf50269d5400fa55af4b660478dc2");
$req->setBizSource("yz_p2e");
$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.member.wireless.courier.getbgxbindusers' \
-d 'partner_id=apidoc' \
-d 'sign=D702BC2C8F975158027B93464A44E634' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-26+09%3A59%3A25' \
-d 'v=2.0' \
-d 'biz_source=yz_p2e' \
-d 'session_code=aeebf50269d5400fa55af4b660478dc2'

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

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

req.session_code="aeebf50269d5400fa55af4b660478dc2"
req.biz_source="yz_p2e"
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.member.wireless.courier.getbgxbindusers");
add_param(pRequest,"session_code","aeebf50269d5400fa55af4b660478dc2");
add_param(pRequest,"biz_source","yz_p2e");
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.member.wireless.courier.getbgxbindusers', {
	'session_code':'aeebf50269d5400fa55af4b660478dc2',
	'biz_source':'yz_p2e'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_member_wireless_courier_getbgxbindusers_response>
    <status_message>001</status_message>
    <status_code>参数错误</status_code>
    <is_success>true</is_success>
    <data>
        <cnuser_info_dos>
            <cnuserinfodos>
                <create_device_id>11</create_device_id>
                <is_confirmed>0</is_confirmed>
                <boss_id>0</boss_id>
                <user_type>0</user_type>
                <city>杭州</city>
                <enterprise_flag>0</enterprise_flag>
                <avatar_url>www.cainiao.com</avatar_url>
                <alipay_type>1</alipay_type>
                <gender>0</gender>
                <ext_infos>1</ext_infos>
                <from_type>0</from_type>
                <alipay_id>1</alipay_id>
                <status>0</status>
                <link_mobile>13732203455</link_mobile>
                <cn_user_id>0</cn_user_id>
                <class_cainiao>com.cainiao.cnuser.client.domain.CnUserInfoDO</class_cainiao>
                <main_account_id>0</main_account_id>
                <identity_card>13732203455</identity_card>
                <isv_account_id>423432534534</isv_account_id>
                <havana_id>0</havana_id>
                <nick>梓茉</nick>
                <email>小燕子4-220@163.com</email>
                <alipay_user_type>0</alipay_user_type>
                <security_mobile>13732203455</security_mobile>
                <cp_mobile>13732203455</cp_mobile>
                <client_type>1</client_type>
                <create_location>杭州</create_location>
                <gmt_modified>1507548970856</gmt_modified>
                <birthday>1</birthday>
                <user_agent>1</user_agent>
                <locale>1</locale>
                <lang>1</lang>
                <sdk_version>1</sdk_version>
                <version>0</version>
                <work_station>1</work_station>
                <verify_r_p_status>0</verify_r_p_status>
                <wangwang>1</wangwang>
                <tag2>1</tag2>
                <tag3>1</tag3>
                <weixin>1</weixin>
                <duty>1</duty>
                <duty_type>0</duty_type>
                <domain>1</domain>
                <current_device_id>1</current_device_id>
                <alipay_account>1</alipay_account>
                <tag1>1</tag1>
                <gmt_create>1507548970856</gmt_create>
                <enterprise_name>1</enterprise_name>
                <enterprise_id>0</enterprise_id>
                <main_account_flag>0</main_account_flag>
                <security_email>1</security_email>
                <employee_no>1</employee_no>
                <enterprise_code>1</enterprise_code>
                <address>1</address>
                <ext_info>1</ext_info>
                <real_name>1</real_name>
                <attributes>1</attributes>
                <display_name>1</display_name>
                <need_confirm>0</need_confirm>
                <cp_user_id>1</cp_user_id>
            </cnuserinfodos>
        </cnuser_info_dos>
    </data>
</cainiao_member_wireless_courier_getbgxbindusers_response>

{
    "cainiao_member_wireless_courier_getbgxbindusers_response":{
        "status_message":"001",
        "status_code":"参数错误",
        "is_success":true,
        "data":{
            "cnuser_info_dos":{
                "cnuserinfodos":[
                    {
                        "create_device_id":"11",
                        "is_confirmed":0,
                        "boss_id":0,
                        "user_type":0,
                        "city":"杭州",
                        "enterprise_flag":0,
                        "avatar_url":"www.cainiao.com",
                        "alipay_type":"1",
                        "gender":0,
                        "ext_infos":"1",
                        "from_type":0,
                        "alipay_id":"1",
                        "status":0,
                        "link_mobile":"13732203455",
                        "cn_user_id":0,
                        "class_cainiao":"com.cainiao.cnuser.client.domain.CnUserInfoDO",
                        "main_account_id":0,
                        "identity_card":"13732203455",
                        "isv_account_id":"423432534534",
                        "havana_id":0,
                        "nick":"梓茉",
                        "email":"小燕子4-220@163.com",
                        "alipay_user_type":0,
                        "security_mobile":"13732203455",
                        "cp_mobile":"13732203455",
                        "client_type":"1",
                        "create_location":"杭州",
                        "gmt_modified":"1507548970856",
                        "birthday":"1",
                        "user_agent":"1",
                        "locale":"1",
                        "lang":"1",
                        "sdk_version":"1",
                        "version":0,
                        "work_station":"1",
                        "verify_r_p_status":0,
                        "wangwang":"1",
                        "tag2":"1",
                        "tag3":"1",
                        "weixin":"1",
                        "duty":"1",
                        "duty_type":0,
                        "domain":"1",
                        "current_device_id":"1",
                        "alipay_account":"1",
                        "tag1":"1",
                        "gmt_create":"1507548970856",
                        "enterprise_name":"1",
                        "enterprise_id":0,
                        "main_account_flag":0,
                        "security_email":"1",
                        "employee_no":"1",
                        "enterprise_code":"1",
                        "address":"1",
                        "ext_info":"1",
                        "real_name":"1",
                        "attributes":"1",
                        "display_name":"1",
                        "need_confirm":0,
                        "cp_user_id":"1"
                    }
                ]
            }
        }
    }
}

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.member.wireless.courier.getbgxbindusers (查询个人账号关联的包裹侠Group的个人-企业账号关联列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ