文档中心 > API类目 > 菜鸟无线API

cainiao.guoguo.courier.online.query (小件员上下班设置查询)

小件员sdk查询当前的上下班设置：当前状态、自动上班开关状态

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
courier_id	Number	必须	1234		小件员菜鸟账号id
session_code	String	必须	123456		登录session

响应参数

名称	类型	示例值	描述
status_code	String	-1	状态码
data	CourierOnlineConfigDto	{}	查询结果
└ online Boolean true 是否在线 └ auto_online Boolean true 是否自动上班
is_success	Boolean	true	调用是否成功
status_message	String	查询失败	错误描述

请求示例

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGuoguoCourierOnlineQueryRequest req = new CainiaoGuoguoCourierOnlineQueryRequest();
req.setCourierId(1234L);
req.setSessionCode("123456");
CainiaoGuoguoCourierOnlineQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoGuoguoCourierOnlineQueryRequest req = new CainiaoGuoguoCourierOnlineQueryRequest();
req.CourierId = 1234L;
req.SessionCode = "123456";
CainiaoGuoguoCourierOnlineQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoGuoguoCourierOnlineQueryRequest;
$req->setCourierId("1234");
$req->setSessionCode("123456");
$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.online.query' \
-d 'partner_id=apidoc' \
-d 'sign=A31108C91BF47D82D4FD185A38CDE470' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-02+09%3A45%3A09' \
-d 'v=2.0' \
-d 'courier_id=1234' \
-d 'session_code=123456'

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

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

req.courier_id=1234
req.session_code="123456"
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.online.query");
add_param(pRequest,"courier_id","1234");
add_param(pRequest,"session_code","123456");
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.online.query', {
	'courier_id':'1234',
	'session_code':'123456'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<cainiao_guoguo_courier_online_query_response>
    <status_code>-1</status_code>
    <data>
        <online>true</online>
        <auto_online>true</auto_online>
    </data>
    <is_success>true</is_success>
    <status_message>查询失败</status_message>
</cainiao_guoguo_courier_online_query_response>

{
    "cainiao_guoguo_courier_online_query_response":{
        "status_code":"-1",
        "data":{
            "online":true,
            "auto_online":true
        },
        "is_success":true,
        "status_message":"查询失败"
    }
}

异常示例

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工具

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

如何获得此API

FAQ

我要提问

返回
顶部

菜鸟无线API

cainiao.guoguo.courier.online.query (小件员上下班设置查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈