文档中心 > API类目 > 欢行开发平台API

alibaba.tae.common.user.query (欢行人员搜索)

欢行人员搜索

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
employee_search_open_request_dto EmployeeSearchOpenRequestDTO 必须 根据关键字模糊搜索当前租户的在职员工,返回工号、姓名昵称、部门、头像和任职序号
  • └ tenant_key
  • String
  • 必须
  • ant
  • 租户身份标识;开放API调用必填,Agent调用由上下文识别
  • └ app_key
  • String
  • 必须
  • ant_group
  • 调用方应用身份;开放API调用必填,Agent调用由上下文识别
  • └ keyword
  • String
  • 可选
  • 书宾
  • 搜索关键字;不传时返回空列表
  • └ employee_no
  • String
  • 必须
  • 091103
  • 企业员工工号;开放API调用必填,Agent调用由登录态注入

响应参数

名称 类型 示例值 描述
result_code String A00001 错误码
result_message String 系统异常 错误信息
content EmployeeSearchInfoDTO [] 在职员工列表
  • └ work_no
  • String
  • 091103
  • 员工工号
  • └ display_name
  • String
  • 书宾
  • 员工展示名称,格式为姓名(昵称)
  • └ dept_name
  • String
  • 阿里控股-平台技术-企业智能事业部-CFO技术-财税技术
  • 员工所属部门名称
  • └ avatar
  • String
  • https://static-legacy.dingtalk.com/media/lADPDgQ9qZ8ylY3NAWjNAWg_360_360.jpg
  • 员工头像地址
  • └ order_num
  • String
  • 1
  • 员工账号中的任职序号
is_success Boolean true 系统调用是否成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaTaeCommonUserQueryRequest req = new AlibabaTaeCommonUserQueryRequest();
AlibabaTaeCommonUserQueryRequest.EmployeeSearchOpenRequestDTO obj1 = new AlibabaTaeCommonUserQueryRequest.EmployeeSearchOpenRequestDTO();
obj1.setTenantKey("ant");
obj1.setAppKey("ant_group");
obj1.setKeyword("书宾");
obj1.setEmployeeNo("091103");
req.setEmployeeSearchOpenRequestDto(obj1);
AlibabaTaeCommonUserQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_tae_common_user_query_response>
    <result_code>A00001</result_code>
    <result_message>系统异常</result_message>
    <content>
        <employee_search_info_d_t_o>
            <work_no>091103</work_no>
            <display_name>书宾</display_name>
            <dept_name>阿里控股-平台技术-企业智能事业部-CFO技术-财税技术</dept_name>
            <avatar>https://static-legacy.dingtalk.com/media/lADPDgQ9qZ8ylY3NAWjNAWg_360_360.jpg</avatar>
            <order_num>1</order_num>
        </employee_search_info_d_t_o>
    </content>
    <is_success>true</is_success>
</alibaba_tae_common_user_query_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

FAQ

返回
顶部