淘宝开放平台

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

钉钉API

dingtalk.oapi.edu.course.summadata.list (获取课程概要数据)

获取课程概要数据

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
cursor Number 必须 0
  • 最小值：0
    		•  分页游标，从0开始
    size Number 必须 10
  • 最小值：1
  • 最大值：100
    		•  分页大小
    course_code String 必须 GJKI49001 课程编码
    op_userid String 必须 manager 当前操作人的用户ID
    category_codes String [] 必须 BASIC_INFO,RAISE_HAND
  • 最大列表长度：100
    		•  数据类别编码数组

    响应参数

    名称 类型 示例值 描述
    result PageQueryResponse result
    • └ next_cursor
    • Number
    • 0
    • 表示下一次分页的游标，如果next_corsor为null或者has_more为false，表示没有更多的分页数据
    • └ has_more
    • Boolean
    • true
    • 表示是否还有更多的数据
    • list
    • CourseSummaryDataDTO []
    • list
    • └ category_code
    • String
    • BASIC_INFO
    • 数据类别编码
    • └ category_biz_key
    • String
    • 1_6d20b8ae-edd3-4ac8-b8d0-70be7837b4b4
    • 数据类别业务唯一键
    • └ data
    • Json
    • {"classroomMemberCount":2,"classroomEndTime":1600696867000,"classroomStartTime":1600696128000,"classroomMessageCount":2}
    • 数据（key：数据因子编码，value： 对应的数据）
    • └ course_code
    • String
    • GJKI49001
    • 课程编码
    success Boolean true 请求是否成功
    errcode Number 0 错误编码
    errmsg String 成功 错误信息

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    1
    2
    3
    4
    5
    6
    7
    8
    9
    DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/course/summadata/list");
    OapiEduCourseSummadataListRequest req = new OapiEduCourseSummadataListRequest();
    req.setCursor(0L);
    req.setSize(10L);
    req.setCourseCode("GJKI49001");
    req.setOpUserid("manager");
    req.setCategoryCodes("BASIC_INFO,RAISE_HAND");
    OapiEduCourseSummadataListResponse rsp = client.execute(req, access_token);
    System.out.println(rsp.getBody());

    响应示例

    • JSON示例
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    {
        "result":{
            "next_cursor":0,
            "has_more":true,
            "list":[
                {
                        "category_code":"BASIC_INFO",
                        "category_biz_key":"1_6d20b8ae-edd3-4ac8-b8d0-70be7837b4b4",
                        "data":"{\"classroomMemberCount\":2,\"classroomEndTime\":1600696867000,\"classroomStartTime\":1600696128000,\"classroomMessageCount\":2}",
                        "course_code":"GJKI49001"
                }
            ]
        },
        "success":true,
        "errcode":0,
        "errmsg":"成功"
    }

    异常示例

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

    错误码解释

    错误码 错误描述 解决方案

    API工具

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

    如何获得此API

    FAQ

    我要提问
    返回
    顶部