开发指南接口调用说明
本文接口是旧版规范服务端API，如何调用参见旧版API VS 新版API。
开发者在调用通讯录接口时，只能获取到在授权范围内的员工通讯录信息，获取非授权范围内的员工通讯录信息会提示获取部门/员工不在授权范围内。
请求
| 基本信息 | |
|---|---|
| HTTP URL | https://oapi.dingtalk.io/auth/scopes |
| HTTP Method | GET |
| 支持的应用类型 | appType-企业内部应用appType-第三方企业应用 |
| 权限要求 | permission-qyapi_base-调用企业API时需要具备的基本权限 |
查询参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| access_token | String | 是 | 6ed1bxxx | 调用该API的应用凭证。 - 企业内部应用，通过获取企业内部应用的access_token接口获取。 - 第三方企业应用，通过获取第三方企业的access_token接口获取。 |
请求示例
curl -X GET "https://oapi.dingtalk.io/auth/scopes" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=2314cdxxxxbcd10713'
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/auth/scopes");
OapiAuthScopesRequest req = new OapiAuthScopesRequest();
req.setHttpMethod("GET");
OapiAuthScopesResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiAuthScopesRequest("https://oapi.dingtalk.io/auth/scopes")
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_GET , DingTalkConstant::$FORMAT_JSON);
$req = new OapiAuthScopesRequest;
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.io/auth/scopes");
IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/auth/scopes");
OapiAuthScopesRequest req = new OapiAuthScopesRequest();
req.SetHttpMethod("GET");
OapiAuthScopesResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
响应
响应体
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| auth_org_scopes | AuthOrgScopes | 授权信息。 | |
| authed_user | String[] | [“user1”,“user”] | 授权可获取通信录信息的员工userid列表。 |
| authed_dept | Number[] | [1,2,3] | 授权可获取通信录信息的部门ID列表。 |
| auth_user_field | String[] | [“name”,“email”] | 授权可获取的企业用户字段。 |
| errmsg | String | ok | 返回码描述。 |
| errcode | Number | 0 | 返回码。 |
响应体示例
{
"errcode":0,
"condition_field":[],
"auth_user_field":[
"jobnumber",
"isLeader",
"name",
"position",
"isAdmin",
"avatar",
"department",
"userid",
"deviceId",
"isHide"
],
"auth_org_scopes":{
"authed_user":[],
"authed_dept":[
1
]
},
"errmsg":"ok"
}