注意:以下文档只适用于TOP接口,请谨慎使用!

文档中心 > API类目 > MOZI账号API

alibaba.mozi.buc.account.pagebyfuzzy (根据人员基本信息模糊查询用户)

根据人员基本信息模糊查询租户内的该用户的信息

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
page_by_fuzzy PageAccountsByFuzzyRequest 可选 模糊查询人员和账号
  • └ return_total_size
  • Boolean
  • 可选
  • true
  • true
  • └ company_ids
  • String []
  • 可选
  • test
  • 不用管
  • └ tenant_id
  • Number
  • 必须
  • 123
  • 租户ID
  • └ right_fuzzy
  • Boolean
  • 可选
  • true
  • 右模糊
  • └ account_type
  • String
  • 可选
  • 21
  • 账号类型,21 钉钉 11 淘宝
  • └ fuzzy_str
  • String
  • 必须
  • test
  • 模糊查询的值,可以是姓名,昵称,工号,账号名等
  • └ available
  • String
  • 可选
  • T
  • 是否可用 T可用 F不可用
  • └ page_size
  • Number
  • 必须
  • 20
  • 每页的大小
  • └ request_meta_data
  • String
  • 可选
  • test
  • 附件信息
  • └ hr_status
  • String
  • 可选
  • A
  • 是否在职 A在职 I离职
  • └ page_no
  • Number
  • 必须
  • 1
  • 第几页
  • └ left_fuzzy
  • Boolean
  • 可选
  • false
  • 是否左模糊,集团暂时不支持
  • └ user_type
  • String
  • 可选
  • 不用管
  • 可用不用管
  • └ active_level
  • Number
  • 可选
  • 0
  • 0表示未激活,1表示激活
  • └ status
  • Number
  • 可选
  • 0
  • 状态,0表示正常,不填是全部

响应参数

名称 类型 示例值 描述
result PageAccountsByFuzzyResult 返回结果 返回结果
  • └ total_size
  • Number
  • 1
  • 总量
  • data_list
  • T []
  • account_list
  • 返回结果
  • └ avatar
  • String
  • url
  • 头像
  • └ emp_id
  • String
  • 123
  • 工号
  • └ first_name
  • String
  • zhangsan
  • 英文全名
  • └ last_name
  • String
  • 张三
  • 中文全名
  • └ name_cn
  • String
  • 张三
  • 中文全名
  • └ name_en
  • String
  • zhangsan
  • 英文全名
  • └ nick_name_cn
  • String
  • 张三
  • 昵称
  • └ hr_status
  • String
  • A
  • 在职状态
  • └ active_level
  • Number
  • 1
  • 激活状态
  • └ available
  • String
  • T
  • 是否可用
  • └ mainland
  • String
  • Y
  • 是不是大陆
  • └ account_type
  • String
  • 1
  • 账号类型
  • └ status
  • String
  • 0
  • 租户内状态
  • └ site_language
  • String
  • ZH_CN
  • 站点语言
  • └ refer_account
  • String
  • test
  • 三方账号名
  • └ refer_id
  • String
  • 123
  • 三方账号ID
  • └ namespace
  • String
  • taobao
  • 账号平台
  • └ account
  • String
  • aaa
  • 账号名称
  • └ tenant_id
  • Number
  • 123
  • 租户ID
  • └ id
  • Number
  • 123
  • 账号ID
  • └ success
  • Boolean
  • true
  • 是否成功
  • └ request_id
  • String
  • 1224
  • 请求的序列化
  • └ page_size
  • Number
  • 20
  • 每页多少
  • └ current_page
  • Number
  • 1
  • 当前第几页
  • └ response_message
  • String
  • OK
  • 返回的状态消息
  • └ response_meta_data
  • String
  • test
  • 返回附加值
  • └ response_code
  • String
  • 0
  • 返回码

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaMoziBucAccountPagebyfuzzyRequest req = new AlibabaMoziBucAccountPagebyfuzzyRequest();
AlibabaMoziBucAccountPagebyfuzzyRequest.PageAccountsByFuzzyRequest obj1 = new AlibabaMoziBucAccountPagebyfuzzyRequest.PageAccountsByFuzzyRequest();
obj1.setReturnTotalSize(true);
obj1.setCompanyIds("test");
obj1.setTenantId(123L);
obj1.setRightFuzzy(true);
obj1.setAccountType("21");
obj1.setFuzzyStr("test");
obj1.setAvailable("T");
obj1.setPageSize(20L);
obj1.setRequestMetaData("test");
obj1.setHrStatus("A");
obj1.setPageNo(1L);
obj1.setLeftFuzzy(false);
obj1.setUserType("不用管");
obj1.setActiveLevel(0L);
obj1.setStatus(0L);
req.setPageByFuzzy(obj1);
AlibabaMoziBucAccountPagebyfuzzyResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_mozi_buc_account_pagebyfuzzy_response>
    <result>
        <total_size>1</total_size>
        <data_list>
            <t>
                <avatar>url</avatar>
                <emp_id>123</emp_id>
                <first_name>zhangsan</first_name>
                <last_name>张三</last_name>
                <name_cn>张三</name_cn>
                <name_en>zhangsan</name_en>
                <nick_name_cn>张三</nick_name_cn>
                <hr_status>A</hr_status>
                <active_level>1</active_level>
                <available>T</available>
                <mainland>Y</mainland>
                <account_type>1</account_type>
                <status>0</status>
                <site_language>ZH_CN</site_language>
                <refer_account>test</refer_account>
                <refer_id>123</refer_id>
                <namespace>taobao</namespace>
                <account>aaa</account>
                <tenant_id>123</tenant_id>
                <id>123</id>
            </t>
        </data_list>
        <success>true</success>
        <request_id>1224</request_id>
        <page_size>20</page_size>
        <current_page>1</current_page>
        <response_message>OK</response_message>
        <response_meta_data>test</response_meta_data>
        <response_code>0</response_code>
    </result>
</alibaba_mozi_buc_account_pagebyfuzzy_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

返回
顶部