更新于 2026-05-26调用本接口获取企业用户通讯录中的个人信息。
企业内部应用和第三方企业应用在调用该接口前,需要先获取个人用户的accessToken,获取方式请参考获取登录用户的访问凭证。
| 基本信息 | 基本信息 |
|---|---|
| HTTP URL | https://api.dingtalk.com/v1.0/contact/users/{unionId} |
| HTTP Method | GET |
| 支持的应用类型 | 企业内部应用第三方企业应用第三方个人应用 |
| 权限要求 | 通讯录个人信息读权限 |
| 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | 是 | 调用服务端接口的授权凭证。使用个人用户的accessToken,请参考获取登录用户的访问凭证。 |
| 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| unionId | String | 是 | 用户的unionId。 |
说明
如需获取当前授权人的信息,unionId参数可以传me。 |
C#
// This file is auto-generated, don't edit it. Thanks. using System; using System.Collections; using System.Collections.Generic; using System.IO; using System.Threading.Tasks; using Tea; using Tea.Utils; namespace AlibabaCloud.SDK.Sample { public class Sample { /** * 使用 Token 初始化账号Client * @return Client * @throws Exception */ public static AlibabaCloud.SDK.Dingtalkcontact_1_0.Client CreateClient() { AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config(); config.Protocol = "https"; config.RegionId = "central"; return new AlibabaCloud.SDK.Dingtalkcontact_1_0.Client(config); } public static void Main(string[] args) { AlibabaCloud.SDK.Dingtalkcontact_1_0.Client client = CreateClient(); AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.GetUserHeaders getUserHeaders = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.GetUserHeaders(); getUserHeaders.XAcsDingtalkAccessToken = ""; try { client.GetUserWithOptions("z21HjQliSzpw0Yxxxx", getUserHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions()); } catch (TeaException err) { if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message)) { // err 中含有 code 和 message 属性,可帮助开发定位问题 } } catch (Exception _err) { TeaException err = new TeaException(new Dictionary { { "message", _err.Message } }); if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message)) { // err 中含有 code 和 message 属性,可帮助开发定位问题 } } } } }
| 名称 | 类型 | 描述 |
|---|---|---|
| nick | String | 用户的钉钉昵称。 |
| avatarUrl | String | 头像URL。 |
| mobile | String | 用户的手机号。 |
说明
第三方企业应用无法获取用户完整手机号,本接口对手机号进行脱敏处理,第三方企业应用获取手机号示例:155****3240。
如果要获取用户手机号,需要在钉钉开发者后台申请个人手机号信息权限,如下图。
|
| openId | String | 用户的openId。 |
| unionId | String | 用户的unionId。 |
| email | String | 用户的个人邮箱。
说明
添加个人邮箱。
|
| stateCode | String | 手机号对应的国家号。 |
HTTP/1.1 200 OK
Content-Type:application/json
{
"nick" : "zhangsan",
"avatarUrl" : "https://xxx",
"mobile" : "150xxxx9144",
"openId" : "123",
"unionId" : "z21HjQliSzpw0Yxxxx",
"email" : "zhangsan@alibaba-inc.com",
"stateCode" : "86"
}
若调用该接口报错,可根据错误信息在全局错误码文档中查找解决方案。
| HttpCode | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 404 | invalidParameter.user.notFound | 找不到该用户 | 用户不存在时返回这个错误码 |