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

dingtalk.oapi.edu.family.child.get (查询家庭孩子信息)

查询家庭孩子信息

公共参数

环境	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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
child_userid	String	必须	1123		孩子userid
op_userid	String	必须	1234L		操作者userid

响应参数

名称	类型	示例值	描述
result	ChildDto	ChildDto	结果数据
└ userid String 123 孩子家庭userid └ nick String nick 孩子nick bind_students BindStudent [] list[BindStudent] 孩子信息 └ corp_id String dingxxxx 学校CorpId └ class_id String 123 班级ID └ period_code String primary_school_1 孩子学段年级对应学段元数据的年级一级 └ userid String 1234 孩子学校的userid └ avatar String @mediaId 头像 └ open_id String xxxxx 孩子对应的openId 已废弃 └ unionId String xxxxx 孩子对应的unionId
success	Boolean	true	是否成功
errcode	Number	1000	错误代码
errmsg	String	错误代码	错误信息

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/family/child/get");
OapiEduFamilyChildGetRequest req = new OapiEduFamilyChildGetRequest();
req.setChildUserid("1123");
req.setOpUserid("1234L");
OapiEduFamilyChildGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/family/child/get");
OapiEduFamilyChildGetRequest req = new OapiEduFamilyChildGetRequest();
req.ChildUserid = "1123";
req.OpUserid = "1234L";
OapiEduFamilyChildGetResponse 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 OapiEduFamilyChildGetRequest;
$req->setChildUserid("1123");
$req->setOpUserid("1234L");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/edu/family/child/get");

curl -X POST "https://oapi.dingtalk.com/topapi/edu/family/child/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=c8e7f532-1f6c-4f96-aea2-13d01bb58821' \
-d 'child_userid=1123' \
-d 'op_userid=1234L'

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

req=dingtalk.api.OapiEduFamilyChildGetRequest("https://oapi.dingtalk.com/topapi/edu/family/child/get")

req.child_userid="1123"
req.op_userid="1234L"
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.family.child.get");
add_param(pRequest,"child_userid","1123");
add_param(pRequest,"op_userid","1234L");
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.family.child.get', {
	'child_userid':'1123',
	'op_userid':'1234L'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "userid":"123",
        "nick":"nick",
        "bind_students":[
            {
                    "corp_id":"dingxxxx",
                    "class_id":"123",
                    "period_code":"primary_school_1",
                    "userid":"1234"
            }
        ],
        "avatar":"@mediaId",
        "open_id":"xxxxx",
        "unionId":"xxxxx"
    },
    "success":true,
    "errcode":1000,
    "errmsg":"错误代码"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.edu.family.child.get (查询家庭孩子信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ