文档中心 > API类目 > 钉钉API

dingtalk.oapi.edu.user.list (获取家校用户身份列表)

获取家校用户身份列表

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	描述
page_size	Number	必须	30	最大30条，最小1条
page_no	Number	必须	1	页码，从1开始
role	String	必须	teacher	家校人员身份
class_id	Number	必须	123435	班级id

响应参数

名称	类型	示例值	描述
result	Result	{}	结果值
└ has_more Boolean true 是否还有数据 details OpenEduUserDetail [] 人员身份列表 └ class_id Number 4240006 班级id └ role String guardian 角色 └ feature String {} 人员各个身份属性 └ name String test3爸爸/test新增爸爸在班级中的监护人名 └ userid String 15919287602721543266165 人员id └ unionid String Pxjifla=fdhgaxxxxxxxxx unionid └ gmtCreate Number 1612408015000 创建时间，时间戳 └ gmtModified Number 1615356859000 修改时间，时间戳
success	Boolean	true	是否成功
errcode	Number	0	错误码，只有当success为false时才有效
errmsg	String	ok	错误信息，只有当success为false时才有效

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/user/list");
OapiEduUserListRequest req = new OapiEduUserListRequest();
req.setPageSize(30L);
req.setPageNo(1L);
req.setRole("teacher");
req.setClassId(123435L);
OapiEduUserListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/user/list");
OapiEduUserListRequest req = new OapiEduUserListRequest();
req.PageSize = 30L;
req.PageNo = 1L;
req.Role = "teacher";
req.ClassId = 123435L;
OapiEduUserListResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiEduUserListRequest;
$req->setPageSize("30");
$req->setPageNo("1");
$req->setRole("teacher");
$req->setClassId("123435");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/edu/user/list");

curl -X POST "https://oapi.dingtalk.com/topapi/edu/user/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=4cda051d-e00f-4593-a0f0-8eec45e35b37' \
-d 'class_id=123435' \
-d 'page_no=1' \
-d 'page_size=30' \
-d 'role=teacher'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.OapiEduUserListRequest("https://oapi.dingtalk.com/topapi/edu/user/list")

req.page_size=30
req.page_no=1
req.role="teacher"
req.class_id=123435
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.edu.user.list");
add_param(pRequest,"page_size","30");
add_param(pRequest,"page_no","1");
add_param(pRequest,"role","teacher");
add_param(pRequest,"class_id","123435");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.edu.user.list', {
	'page_size':'30',
	'page_no':'1',
	'role':'teacher',
	'class_id':'123435'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "has_more":true,
        "details":[
            {
                    "class_id":4240006,
                    "role":"guardian",
                    "feature":"{}",
                    "name":"test3爸爸\/test新增爸爸",
                    "userid":"15919287602721543266165",
                    "unionid":"Pxjifla=fdhgaxxxxxxxxx",
                    "gmtCreate":1612408015000,
                    "gmtModified":1615356859000
            }
        ]
    },
    "success":true,
    "errcode":0,
    "errmsg":"ok"
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.edu.user.list (获取家校用户身份列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ