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

alibaba.mozi.buc.account.pageall (查询租户内内所有账号)

查询租户内内所有账号

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
page_all PageAllAccountsRequest 可选 查询租户内所有人员和账号
  • └ return_total_size
  • Boolean
  • 可选
  • true
  • 是否返回总数
  • └ tenant_id
  • Number
  • 必须
  • 123
  • 租户ID
  • └ account_type
  • String
  • 可选
  • 21
  • 账号类型,21 钉钉 11 淘宝
  • └ available
  • String
  • 可选
  • T
  • 是否可用 T可用 F不可用,不填是全部
  • └ page_size
  • Number
  • 可选
  • 20
  • 每页的大小
  • └ request_meta_data
  • String
  • 可选
  • 可以不填
  • 附加信息
  • └ hr_status
  • String
  • 可选
  • A
  • 是否在职 A在职 I离职,不填是全部
  • └ page_no
  • Number
  • 可选
  • 1
  • 当前页号
  • └ active_level
  • Number
  • 可选
  • 1
  • 0表示未激活,1表示激活,不填是全部
  • └ status
  • Number
  • 可选
  • 0
  • 状态,0表示正常,5是离职回收,104是冻结,不填是全部

响应参数

名称 类型 示例值 描述
result PageAllAccountsResult data 返回结果
  • └ total_size
  • Number
  • 100
  • 返回的记录总数
  • data_list
  • T []
  • account_list
  • 返回的数据
  • └ id
  • Number
  • 1
  • 账号ID
  • └ tenant_id
  • Number
  • 123
  • 租户ID
  • └ account
  • String
  • test
  • 账号名
  • └ namespace
  • String
  • taobao
  • 账号平台
  • └ refer_id
  • String
  • 123
  • 三方账号ID
  • └ refer_account
  • String
  • test
  • 三方账号名
  • └ site_language
  • String
  • ZH_CN
  • 站点语言ZH_CN,EN
  • └ status
  • String
  • 0
  • 状态 0表示正常
  • └ account_type
  • String
  • 1
  • 账号类型
  • └ mainland
  • String
  • Y
  • 是否是大陆Y表示是,N不是
  • └ available
  • String
  • T
  • 是否可用
  • └ active_level
  • Number
  • 1
  • 是否激活
  • └ hr_status
  • String
  • A
  • 是否在职
  • └ nick_name_cn
  • String
  • 张三
  • 昵称
  • └ name_en
  • String
  • test
  • 英文全名
  • └ name_cn
  • String
  • 张三
  • 中文全名
  • └ last_name
  • String
  • 张三
  • 中文全名
  • └ first_name
  • String
  • test
  • 英文全名
  • └ emp_id
  • String
  • 123
  • 工号
  • └ avatar
  • String
  • url
  • 头像
  • └ success
  • Boolean
  • true
  • 是否成功
  • └ request_id
  • String
  • 123
  • 请求的序列化
  • └ 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);
AlibabaMoziBucAccountPageallRequest req = new AlibabaMoziBucAccountPageallRequest();
AlibabaMoziBucAccountPageallRequest.PageAllAccountsRequest obj1 = new AlibabaMoziBucAccountPageallRequest.PageAllAccountsRequest();
obj1.setReturnTotalSize(true);
obj1.setTenantId(123L);
obj1.setAccountType("21");
obj1.setAvailable("T");
obj1.setPageSize(20L);
obj1.setRequestMetaData("可以不填");
obj1.setHrStatus("A");
obj1.setPageNo(1L);
obj1.setActiveLevel(1L);
obj1.setStatus(0L);
req.setPageAll(obj1);
AlibabaMoziBucAccountPageallResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_mozi_buc_account_pageall_response>
    <result>
        <total_size>100</total_size>
        <data_list>
            <t>
                <id>1</id>
                <tenant_id>123</tenant_id>
                <account>test</account>
                <namespace>taobao</namespace>
                <refer_id>123</refer_id>
                <refer_account>test</refer_account>
                <site_language>ZH_CN</site_language>
                <status>0</status>
                <account_type>1</account_type>
                <mainland>Y</mainland>
                <available>T</available>
                <active_level>1</active_level>
                <hr_status>A</hr_status>
                <nick_name_cn>张三</nick_name_cn>
                <name_en>test</name_en>
                <name_cn>张三</name_cn>
                <last_name>张三</last_name>
                <first_name>test</first_name>
                <emp_id>123</emp_id>
                <avatar>url</avatar>
            </t>
        </data_list>
        <success>true</success>
        <request_id>123</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_pageall_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

返回
顶部