阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	描述
work_bench_context	WorkBenchContext	可选	系统自动生成
└ campus_id Number 可选 11 园区id └ system_id String 可选 11 系统id
query_dto	QueryEmployeeDto	可选	查询对象
└ company_id Number 必须 1 公司ID └ dept_id Number 必须 22 部门ID，查公司所有员工传入0 └ search_kw String 可选张三查询关键字 └ join_type Number 必须 1 1查询为入职状态的人员， 0查询为邀请状态的人员 └ size Number 必须 1 分页大小 └ page Number 必须 1 当前页码

名称	类型	示例值	描述
result	PageResult	{}	分页结果
└ error_ext_info String {"errormsg":"ok"} 错误详情 └ error_level String 1 错误等级 └ success Boolean true 是否成功 └ error_msg String ok 错误消息 └ error_code String 200 错误码 └ request_id String 1 请求id content Page {} 响应内容 └ total_page Number 10 总页数 └ current_page Number 1 当前页 └ page_size Number 10 每页数量 └ total_count Number 100 总数量 items Items [] {} 返回结果集 └ mobile String 187****8536 手机号 └ account_id Number 1 账号 └ id Number 1 主键ID └ name String jack 名字 └ nick_name String 老马昵称 └ en_name String jack 英文名称 └ sex String M 性别 └ work_no String 1 工号 └ work_status String INVITED 工作状态在职“WORKING” 离职“LEFT” 邀请“INVITED” └ company_name String 阿里巴巴公司名称 └ birthday String 2017-11-10 18:43:57 生日 └ company_id Number 1 公司ID └ super_emp_id Number 1 上级ID └ super_emp_name String 所属上级姓名 └ position String 主管职位 └ dept_id String 1 部门id └ dept_name String 智慧建筑部门名称 └ office_location String 乐佳国际2号楼办公室地址 └ dept_manager_id Number 1 部门管理员ID └ dept_manager_name String 老王部门管理员名字 └ row_num Number 1 rowNum └ month_order_url String xxx.xxx.com 月账单URL └ company_manage_url String xxx.xxx.com 公司管理URL

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaIbWorkcoreEmployeeQueryemployeesRequest req = new AlibabaIbWorkcoreEmployeeQueryemployeesRequest();
AlibabaIbWorkcoreEmployeeQueryemployeesRequest.WorkBenchContext obj1 = new AlibabaIbWorkcoreEmployeeQueryemployeesRequest.WorkBenchContext();
obj1.setCampusId(11L);
obj1.setSystemId("11");
req.setWorkBenchContext(obj1);
AlibabaIbWorkcoreEmployeeQueryemployeesRequest.QueryEmployeeDto obj2 = new AlibabaIbWorkcoreEmployeeQueryemployeesRequest.QueryEmployeeDto();
obj2.setCompanyId(1L);
obj2.setDeptId(22L);
obj2.setSearchKw("张三");
obj2.setJoinType(1L);
obj2.setSize(1L);
obj2.setPage(1L);
req.setQueryDto(obj2);
AlibabaIbWorkcoreEmployeeQueryemployeesResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaIbWorkcoreEmployeeQueryemployeesRequest req = new AlibabaIbWorkcoreEmployeeQueryemployeesRequest();
AlibabaIbWorkcoreEmployeeQueryemployeesRequest.WorkBenchContextDomain obj1 = new AlibabaIbWorkcoreEmployeeQueryemployeesRequest.WorkBenchContextDomain();
obj1.CampusId = 11L;
obj1.SystemId = "11";
req.WorkBenchContext_ = obj1;
AlibabaIbWorkcoreEmployeeQueryemployeesRequest.QueryEmployeeDtoDomain obj2 = new AlibabaIbWorkcoreEmployeeQueryemployeesRequest.QueryEmployeeDtoDomain();
obj2.CompanyId = 1L;
obj2.DeptId = 22L;
obj2.SearchKw = "张三";
obj2.JoinType = 1L;
obj2.Size = 1L;
obj2.Page = 1L;
req.QueryDto_ = obj2;
AlibabaIbWorkcoreEmployeeQueryemployeesResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaIbWorkcoreEmployeeQueryemployeesRequest;
$work_bench_context = new WorkBenchContext;
$work_bench_context->campus_id="11";
$work_bench_context->system_id="11";
$req->setWorkBenchContext(json_encode($work_bench_context));
$query_dto = new QueryEmployeeDto;
$query_dto->company_id="1";
$query_dto->dept_id="22";
$query_dto->search_kw="张三";
$query_dto->join_type="1";
$query_dto->size="1";
$query_dto->page="1";
$req->setQueryDto(json_encode($query_dto));
$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=alibaba.ib.workcore.employee.queryemployees' \
-d 'partner_id=apidoc' \
-d 'sign=035FE2EE5BEF7403770EC43EFDF22A63' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+21%3A49%3A54' \
-d 'v=2.0' \
-d 'query_dto=null' \
-d 'work_bench_context=null'

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

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

req.work_bench_context=""
req.query_dto=""
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,"alibaba.ib.workcore.employee.queryemployees");
add_param(pRequest,"work_bench_context","数据结构JSON示例");
add_param(pRequest,"query_dto","数据结构JSON示例");
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('alibaba.ib.workcore.employee.queryemployees', {
	'work_bench_context':'数据结构JSON示例',
	'query_dto':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_ib_workcore_employee_queryemployees_response>
    <result>
        <error_ext_info>{&quot;errormsg&quot;:&quot;ok&quot;}</error_ext_info>
        <error_level>1</error_level>
        <success>true</success>
        <error_msg>ok</error_msg>
        <error_code>200</error_code>
        <request_id>1</request_id>
        <content>
            <total_page>10</total_page>
            <current_page>1</current_page>
            <page_size>10</page_size>
            <total_count>100</total_count>
            <items>
                <items>
                    <mobile>187****8536</mobile>
                    <account_id>1</account_id>
                    <id>1</id>
                    <name>jack</name>
                    <nick_name>老马</nick_name>
                    <en_name>jack</en_name>
                    <sex>M</sex>
                    <work_no>1</work_no>
                    <work_status>INVITED</work_status>
                    <company_name>阿里巴巴</company_name>
                    <birthday>2017-11-10 18:43:57</birthday>
                    <company_id>1</company_id>
                    <super_emp_id>1</super_emp_id>
                    <super_emp_name>所属</super_emp_name>
                    <position>主管</position>
                    <dept_id>1</dept_id>
                    <dept_name>智慧建筑</dept_name>
                    <office_location>乐佳国际2号楼</office_location>
                    <dept_manager_id>1</dept_manager_id>
                    <dept_manager_name>老王</dept_manager_name>
                    <row_num>1</row_num>
                    <month_order_url>xxx.xxx.com</month_order_url>
                    <company_manage_url>xxx.xxx.com</company_manage_url>
                </items>
            </items>
        </content>
    </result>
</alibaba_ib_workcore_employee_queryemployees_response>

{
    "alibaba_ib_workcore_employee_queryemployees_response":{
        "result":{
            "error_ext_info":"{\"errormsg\":\"ok\"}",
            "error_level":"1",
            "success":true,
            "error_msg":"ok",
            "error_code":"200",
            "request_id":"1",
            "content":{
                "total_page":10,
                "current_page":1,
                "page_size":10,
                "total_count":100,
                "items":{
                    "items":[
                        {
                            "mobile":"187****8536",
                            "account_id":1,
                            "id":1,
                            "name":"jack",
                            "nick_name":"老马",
                            "en_name":"jack",
                            "sex":"M",
                            "work_no":"1",
                            "work_status":"INVITED",
                            "company_name":"阿里巴巴",
                            "birthday":"2017-11-10 18:43:57",
                            "company_id":1,
                            "super_emp_id":1,
                            "super_emp_name":"所属",
                            "position":"主管",
                            "dept_id":"1",
                            "dept_name":"智慧建筑",
                            "office_location":"乐佳国际2号楼",
                            "dept_manager_id":1,
                            "dept_manager_name":"老王",
                            "row_num":1,
                            "month_order_url":"xxx.xxx.com",
                            "company_manage_url":"xxx.xxx.com"
                        }
                    ]
                }
            }
        }
    }
}

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

alibaba.ib.workcore.employee.queryemployees (分页查询部门下员工信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈