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

dingtalk.oapi.edu.recommend.return (学习推荐数据回流)

家长首页学习推荐数据回流

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
summary	String	可选	摘要		摘要
result_value	String	必须	1		结果分值
thumbnail	String	必须	缩略图		缩略图
type	String	必须	1		类型 1词汇 2课文 3题目 4考试 5知识点 6课程 7其他
title	String	必须	标题		标题
userid	String	必须	1234		传入的学习孩子userid
class_id	Number	可选	1234		班级ID 家庭场景取孩子的班级ID
return_url	String	必须	/pages/index/index		回跳地址
subject_code	String	可选	xxx		学科
result_type	Number	必须	1		结果分值类型 1 对错 2 百分打分 3百分比打分 4 数值
textbook_code	String	可选	xxx		教材版本
out_content_id	String	必须	1234		ISV侧内容唯一ID
out_tx_id	String	必须	123		外部提交ID 唯一
labelList	String []	可选	"人教版","语文","第一单元"	最大列表长度：100	内容标签，推荐扩散给其他用户使用
totalTime	Number	可选	10		内容总时长，单位秒
learnTime	Number	可选	10		用户学习时长，单位秒

响应参数

名称	类型	示例值	描述
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/recommend/return");
OapiEduRecommendReturnRequest req = new OapiEduRecommendReturnRequest();
req.setSummary("摘要");
req.setResultValue("1");
req.setThumbnail("缩略图");
req.setType("1");
req.setTitle("标题");
req.setUserid("1234");
req.setClassId(1234L);
req.setReturnUrl("/pages/index/index");
req.setSubjectCode("xxx");
req.setResultType(1L);
req.setTextbookCode("xxx");
req.setOutContentId("1234");
req.setOutTxId("123");
req.setLabelList("\"人教版\",\"语文\",\"第一单元\"");
req.setTotalTime(10L);
req.setLearnTime(10L);
OapiEduRecommendReturnResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/recommend/return");
OapiEduRecommendReturnRequest req = new OapiEduRecommendReturnRequest();
req.Summary = "摘要";
req.ResultValue = "1";
req.Thumbnail = "缩略图";
req.Type = "1";
req.Title = "标题";
req.Userid = "1234";
req.ClassId = 1234L;
req.ReturnUrl = "/pages/index/index";
req.SubjectCode = "xxx";
req.ResultType = 1L;
req.TextbookCode = "xxx";
req.OutContentId = "1234";
req.OutTxId = "123";
req.LabelList = "\"人教版\",\"语文\",\"第一单元\"";
req.TotalTime = 10L;
req.LearnTime = 10L;
OapiEduRecommendReturnResponse 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 OapiEduRecommendReturnRequest;
$req->setSummary("摘要");
$req->setResultValue("1");
$req->setThumbnail("缩略图");
$req->setType("1");
$req->setTitle("标题");
$req->setUserid("1234");
$req->setClassId("1234");
$req->setReturnUrl("/pages/index/index");
$req->setSubjectCode("xxx");
$req->setResultType("1");
$req->setTextbookCode("xxx");
$req->setOutContentId("1234");
$req->setOutTxId("123");
$req->setLabelList("\"人教版\",\"语文\",\"第一单元\"");
$req->setTotalTime("10");
$req->setLearnTime("10");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/edu/recommend/return");

curl -X POST "https://oapi.dingtalk.com/topapi/edu/recommend/return" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=17d018cc-7539-4b05-9fe7-2200f4fc189b' \
-d 'class_id=1234' \
-d 'labelList=%5C%22%E4%BA%BA%E6%95%99%E7%89%88%5C%22%2C%5C%22%E8%AF%AD%E6%96%87%5C%22%2C%5C%22%E7%AC%AC%E4%B8%80%E5%8D%95%E5%85%83%5C%22' \
-d 'learnTime=10' \
-d 'out_content_id=1234' \
-d 'out_tx_id=123' \
-d 'result_type=1' \
-d 'result_value=1' \
-d 'return_url=%2Fpages%2Findex%2Findex' \
-d 'subject_code=xxx' \
-d 'summary=%E6%91%98%E8%A6%81' \
-d 'textbook_code=xxx' \
-d 'thumbnail=%E7%BC%A9%E7%95%A5%E5%9B%BE' \
-d 'title=%E6%A0%87%E9%A2%98' \
-d 'totalTime=10' \
-d 'type=1' \
-d 'userid=1234'

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

req=dingtalk.api.OapiEduRecommendReturnRequest("https://oapi.dingtalk.com/topapi/edu/recommend/return")

req.summary="摘要"
req.result_value="1"
req.thumbnail="缩略图"
req.type="1"
req.title="标题"
req.userid="1234"
req.class_id=1234
req.return_url="/pages/index/index"
req.subject_code="xxx"
req.result_type=1
req.textbook_code="xxx"
req.out_content_id="1234"
req.out_tx_id="123"
req.labelList=""人教版","语文","第一单元""
req.totalTime=10
req.learnTime=10
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.recommend.return");
add_param(pRequest,"summary","摘要");
add_param(pRequest,"result_value","1");
add_param(pRequest,"thumbnail","缩略图");
add_param(pRequest,"type","1");
add_param(pRequest,"title","标题");
add_param(pRequest,"userid","1234");
add_param(pRequest,"class_id","1234");
add_param(pRequest,"return_url","/pages/index/index");
add_param(pRequest,"subject_code","xxx");
add_param(pRequest,"result_type","1");
add_param(pRequest,"textbook_code","xxx");
add_param(pRequest,"out_content_id","1234");
add_param(pRequest,"out_tx_id","123");
add_param(pRequest,"labelList","\"人教版\",\"语文\",\"第一单元\"");
add_param(pRequest,"totalTime","10");
add_param(pRequest,"learnTime","10");
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.recommend.return', {
	'summary':'摘要',
	'result_value':'1',
	'thumbnail':'缩略图',
	'type':'1',
	'title':'标题',
	'userid':'1234',
	'class_id':'1234',
	'return_url':'/pages/index/index',
	'subject_code':'xxx',
	'result_type':'1',
	'textbook_code':'xxx',
	'out_content_id':'1234',
	'out_tx_id':'123',
	'labelList':'\"人教版\",\"语文\",\"第一单元\"',
	'totalTime':'10',
	'learnTime':'10'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "success":true,
    "errcode":1000,
    "errmsg":"错误信息"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.edu.recommend.return (学习推荐数据回流)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ