dingtalk.corp.search.corpcontact.baseinfo (搜索企业通讯录基本接口)

根据姓名和工号搜索企业员工

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
query String 必须 测试 搜索词,长度大于2开始搜
offset Number 必须 0 开始位置,从0开始
size Number 必须 10 拉取个数上限100

响应参数

名称 类型 示例值 描述
result DingOpenResult result
  • page_result
  • PageResult
  • pageResult
  • └ has_more
  • Boolean
  • true
  • 是否还有更多数据
  • └ offset
  • Number
  • 3
  • 下次翻页的入参
  • └ total
  • Number
  • 5000
  • 能获取的总条数(offset+size不能超过这个值)
  • value_list
  • GroupContactResult []
  • value
  • └ name
  • String
  • 张三
  • 姓名
  • └ title
  • String
  • 开发
  • 职位
  • └ ali_tmp_dept
  • String
  • 阿里-钉钉-开发
  • aliTmpDept
  • └ flower_name
  • String
  • 李四
  • flowerName
  • └ job_number
  • String
  • 1234
  • jobNumber
  • └ userid
  • String
  • dsiecs
  • userid
  • └ work_station
  • String
  • 办公室
  • workStation
  • └ ding_open_errcode
  • Number
  • dingOpenErrcode
  • └ error_msg
  • String
  • errorMsg
  • └ success
  • Boolean
  • success

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
DingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
CorpSearchCorpcontactBaseinfoRequest req = new CorpSearchCorpcontactBaseinfoRequest();
req.setQuery("测试");
req.setOffset(0L);
req.setSize(10L);
CorpSearchCorpcontactBaseinfoResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<dingtalk_corp_search_corpcontact_baseinfo_response>
    <result>
        <page_result>
            <has_more>true</has_more>
            <offset>3</offset>
            <total>5000</total>
            <value_list>
                <group_contact_result>
                    <name>张三</name>
                    <title>开发</title>
                    <ali_tmp_dept>阿里-钉钉-开发</ali_tmp_dept>
                    <flower_name>李四</flower_name>
                    <job_number>1234</job_number>
                    <userid>dsiecs</userid>
                    <work_station>办公室</work_station>
                </group_contact_result>
            </value_list>
        </page_result>
        <ding_open_errcode></ding_open_errcode>
        <error_msg></error_msg>
        <success></success>
    </result>
</dingtalk_corp_search_corpcontact_baseinfo_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

返回
顶部