获取用户通讯录个人信息

说明

调用本接口获取企业用户通讯录中的个人信息。
服务地址：api.dingtalk.com

权限

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

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	通讯录个人信息读权限	API Explorer
第三方企业应用	支持	通讯录个人信息读权限	API Explorer
第三方个人应用	支持	通讯录个人信息读权限	API Explorer

错误码

HttpCode	错误码	错误信息	说明
404	invalidParameter.user.notFound	找不到该用户	用户不存在时返回这个错误码

请求参数

Path 参数

unionId

string

必需

用户的unionId。
如需获取当前授权人的信息，unionId参数可以传me。

Header 参数

x-acs-dingtalk-access-token

string

必需

调用服务端接口的授权凭证。使用个人用户的accessToken，请参考获取登录用户的访问凭证。

Body 参数application/json

object {0}

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

nick

string

用户的钉钉昵称。

可选

avatarUrl

string

头像URL。

可选

mobile

string

可选

用户的手机号。
如果要获取用户手机号，需要在开发者后台申请个人手机号信息权限，如下图。

openId

string

可选

用户的openId。

unionId

string

可选

用户的unionId。

string

用户的个人邮箱。

可选

stateCode

string

可选

手机号对应的国家号。

示例

{
  "nick": "string",
  "avatarUrl": "string",
  "mobile": "string",
  "openId": "string",
  "unionId": "string",
  "email": "string",
  "stateCode": "string"
}

获取用户通讯录个人信息

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码