搜索用户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 | 否 | 是否精确匹配。
说明
该参数不传,默认模糊匹配用户名称。 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
hasMore | Boolean | 是否还有更多数据。
|
totalCount | Long | 总记录数。 |
list | Array of String | 用户userId。 |
示例
请求示例
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
返回示例
Loading...
错误码
HttpCode | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | parameter.error | 参数错误 | 参数错误 |
500 | system.busy | 系统错误 | 系统错误 |