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

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

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
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
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    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());

    响应示例

    • JSON示例
    1
    2
    3
    4
    5
    {
        "success":true,
        "errcode":1000,
        "errmsg":"错误信息"
    }

    异常示例

    • JSON示例
    1
    2
    3
    4
    {
        "errcode":88,
        "errmsg":"ding talk error"
    }

    错误码解释

    错误码 错误描述 解决方案

    API工具

    如何获得此API

    FAQ

    返回
    顶部