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

cainiao.guoguo.employee.queryemployees (查询员工列表)

查询员工列表

公共参数

请求地址：

环境	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
personal_session	String	必须	1231		菜鸟账号session

响应参数

名称	类型	示例值	描述
data	EmployeeListDto		返回结果
employee_list EmployeeDto [] 员工账号列表 └ account_status Number 1 账号状态 └ account_status_str String 有效账号状态文本 └ cp_code String K_TTKD CP的编码 └ cp_name String 天天快递 CP名称 └ create_time Date 2018-08-11 00:00:00 创建时间 └ employee_id Number 4398049239505 企业账号ID └ employee_no String 111232 工号 └ personal_id Number 4398049239505 个人账号ID └ work_status Number 1 在职状态 └ work_status_str String 在职在职状态 └ org_code String orgCode └ org_name String orgName
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);
CainiaoGuoguoEmployeeQueryemployeesRequest req = new CainiaoGuoguoEmployeeQueryemployeesRequest();
req.setPersonalUserId(1231L);
req.setPersonalSession("1231");
CainiaoGuoguoEmployeeQueryemployeesResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

XML示例
JSON示例

<cainiao_guoguo_employee_queryemployees_response>
    <data>
        <employee_list>
            <employee_dto>
                <account_status>1</account_status>
                <account_status_str>有效</account_status_str>
                <cp_code>K_TTKD</cp_code>
                <cp_name>天天快递</cp_name>
                <create_time>2018-08-11 00:00:00</create_time>
                <employee_id>4398049239505</employee_id>
                <employee_no>111232</employee_no>
                <personal_id>4398049239505</personal_id>
                <work_status>1</work_status>
                <work_status_str>在职</work_status_str>
                <org_code></org_code>
                <org_name></org_name>
            </employee_dto>
        </employee_list>
    </data>
    <status_code>foo</status_code>
    <status_message>foo</status_message>
    <is_success>true</is_success>
</cainiao_guoguo_employee_queryemployees_response>

异常示例

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>

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

菜鸟无线API

cainiao.guoguo.employee.queryemployees (查询员工列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ