请求
| 基本信息 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/v2/user/getuserinfo |
| HTTP Method | POST |
| 支持的应用类型 | appType-企业内部应用appType-第三方企业应用 |
| 权限要求 | permission-qyapi_base-调用企业API时需要具备的基本权限 |
查询参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| access_token | String | 是 | 6ed1bxxx | 调用该API的应用凭证。 - 企业内部应用,通过获取企业内部应用的access_token接口获取。 - 第三方企业应用,通过获取第三方企业的access_token接口获取。 |
请求体
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| code | String | 是 | bab02f63c1e030fbbxxxx | 免登授权码,获取方式请参考: - 小程序免登授权码 - 微应用免登授权码 说明 此授权码五分钟内有效,且只能使用一次。 |
请求示例
curl -X POST "https://api.dingtalk.io/topapi/v2/user/getuserinfo" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=417124xxxx2a3c270d5' \
-d 'code=123456'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/v2/user/getuserinfo");
OapiV2UserGetuserinfoRequest req = new OapiV2UserGetuserinfoRequest();
req.setCode("bab02f63c1e030fbbxxxx");
OapiV2UserGetuserinfoResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
# -*- coding: utf-8 -*-
import dingtalk.api
req=dingtalk.api.OapiV2UserGetuserinfoRequest("https://api.dingtalk.io/topapi/v2/user/getuserinfo")
req.code="123456"
try:
resp= req.getResponse(access_token)
print(resp)
except Exception,e:
print(e)
include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');
$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiV2UserGetuserinfoRequest;
$req->setCode("123456");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/v2/user/getuserinfo");
let { Config, OapiV2UserGetuserinfoParams, OapiV2UserGetuserinfoRequest } = require('./client.js');
let Client = require('./client.js').default
async function test() {
const config = new Config()
config.serverUrl = 'https://api.dingtalk.io/topapi/v2/user/getuserinfo'
config.session = 'access_token'
const params = new OapiV2UserGetuserinfoParams();
params.code = 'bab02f63c1e030fbbxxxx'
const request = new OapiV2UserGetuserinfoRequest()
request.params = params
const client = new Client(config)
try {
const res = await client.oapiV2UserGetuserinfo(request)
console.log(res.body)
} catch (err) {
console.log(err)
}
}
test()
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/v2/user/getuserinfo");
OapiV2UserGetuserinfoRequest req = new OapiV2UserGetuserinfoRequest();
req.Code = "123456";
OapiV2UserGetuserinfoResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
响应
响应体
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| request_id | String | e8krly4vyiln | 请求ID。 |
| errcode | Number | 0 | 返回码**。** |
| errmsg | String | ok | 对返回码的文本描述内容。 |
| result | UserGetByCodeResponse | 返回结果。 | |
| userid | String | user456 | 用户的userId。 |
| device_id | String | 12drtfxxxxx | 设备ID。 |
| sys | Boolean | true | 是否是管理员。 - true:是 - false:不是 |
| sys_level | Number | 1 | 级别。 - 1:主管理员 - 2:子管理员 - 100:老板 - 0:其他(如普通员工) |
| associated_unionid | String | N2o5U3axxxx | 用户关联的unionId。 |
| unionid | String | gliiW002zUxxxx | 用户unionId。 |
| name | String | 张xx | 用户名字。 |
响应体示例
{
"errcode": 0,
"result": {
"associated_unionid": "N2o5U3axxxx",
"unionid": "gliiW0piiii02zBUjUxxxx",
"device_id": "12drtfxxxxx",
"sys_level": 1,
"name": "张xx",
"sys": true,
"userid": "userid123"
},
"errmsg": "ok"
}