选择应用类型
第三方企业应用开发
学习地图
动态与公告
应用开发平台简介(新版)
应用开发平台简介
开发应用(新版)
开发应用
服务端API
开发指南
API总览
身份验证(免登)
应用授权
获取访问凭证
钉钉统一授权套件
通讯录管理
概述
权限申请
用户管理
查询用户详情
获取部门用户基础信息
获取部门用户userid列表
获取部门用户详情
获取员工人数
根据unionid获取用户userid
获取管理员列表
获取管理员通讯录权限范围
获取管理员的应用管理权限
获取用户属性可见性设置
设置用户属性可见性
删除用户属性可见性设置
搜索用户userId
通讯录userId排序
企业帐号
部门管理
角色管理
外部联系人
行业通讯录
企业管理
通讯录ID转译
获取通讯录权限范围
获取用户通讯录个人信息
常见问题
上下游组织(原合作空间)
上下级组织(原关联组织)
考勤
日程
日志
签到
服务窗
音视频
钉工牌
OA审批
即时通信IM
待办任务
智能填表
组织大脑
智能人事
互动卡片
企业文化
专属开放
钉钉客联
行业开放
生态开放
应用市场
智能招聘
智能硬件
文档/文件
HCM 主数据
钉钉碳中和
宜搭应用开发
客户管理
Teambition 项目管理
钉钉快办
Agoal
炼丹炉(模型服务)
AI 助理
365会员
附录
客户端API
AppLink协议
事件订阅
常见问题
运营规范
历史文档

搜索用户userId新版SDK

更新于 2023-01-18调用本接口,搜索用户userId。

接口功能介绍

调用本接口根据用户名称搜索用户userId,具体信息如下图。

权限

要调用此API,需要以下权限之一。

应用类型

是否支持

权限

API Explorer调试

企业内部应用暂不支持搜索企业通讯录的权限暂不支持
第三方企业应用支持搜索企业通讯录的权限API Explorer
第三方个人应用暂不支持搜索企业通讯录的权限暂不支持

请求方法

Loading...

Header参数

名称

类型

是否必填

描述

x-acs-dingtalk-access-token

String

调用该接口的访问凭证。

Body参数

名称

类型

是否必填

描述

queryWord

String

用户名称、名称拼音或英文名称。

offset

Integer

分页页码。

size

Integer

分页大小。

fullMatchField

Integer

是否精确匹配。

  • 1:精确匹配用户名称。
说明

该参数不传,默认模糊匹配用户名称。

返回参数

名称

类型

描述

hasMore

Boolean

是否还有更多数据。

  • true:是

  • false:否

totalCount

Long

总记录数。

list

Array of String

用户userId。

示例

请求示例

Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...

返回示例

Loading...

错误码

HttpCode

错误码

错误信息

说明

400

parameter.error

参数错误

参数错误

500

system.busy

系统错误

系统错误

点击纠错