课件相关接口

直播云SDK API提供课件上传和转换服务，转换后统一格式为网页课件，转换课件格式支持主流的pdf、word、ppt和mp3/mp4格式。以下接口建议使用https://openapi.weclassroom.com，测试环境: http://test-openapi.weclassroom.com，验签规则请查看附录下验签代码示例

本章接口列表：

课件上传与转换接口

接口说明： 该接口提供课件上传与转换服务，上传分为两个纬度，1、课节纬度，代表上传到该课节的所属课件，当只填课节id不填用户id即为课节纬度2、课节加用户纬度，当接口上传参数填写用户id后，即为课节+用户纬度，同一纬度下，不能上传相同课件地址，否则为重复上传。

接口URL: /file/upload/onlineppt
接口域名: http(s)://api.weclassroom.com (测试环境:http://test-api.weclassroom.com ) (老域名，可以使用但不再更新维护)
接口域名: http(s)://openapi.weclassroom.com (测试环境:http://test-openapi.weclassroom.com)(新域名,建议使用）
验签规则请查看附录下验签代码示例

api接口和openapi接口统一请求方式: POST
api接口上传参数:

openapi接口上传参数:

signMsg包含参数:

返回格式: JSON

返回参数说明:

data参数说明

支持格式说明:

返回常见错误：

成功示例：

{
    "status": "1",
    "time": "2019-05-30 15:06:34",
    "message": "upload succ", 
    "id": 15162954
}

失败示例：

{
    "status": 0,
    "msg": "该网址已经存在,请重新选网址",
    "data": 1
}

课件获取接口

接口说明： 该接口主要提供获取课件转换状态和转换结果，转换结果包含课件创建时间、转换后地址、备份地址、课件大小、课件名称等基本信息。查询只提供两种纬度查询:

1. 机构维度，当请求参数不包含课件id 参数时，即默认查询该机构下的课件列表;
2. 课件维度，当请求参数包含课件id时，查询该课件id对应课件的相关转换信息，课件id为上传课件时，返回的id参数。

接口URL: /file/get/light/list
接口域名: http(s)://api.weclassroom.com (测试环境:http://test-api.weclassroom.com ) (老域名，可以使用但不再更新维护)
接口域名: http(s)://openapi.weclassroom.com (测试环境:http://test-openapi.weclassroom.com )(新域名，建议使用）
验签规则请查看附录下验签代码示例

api接口和openapi接口访问方式: GET
api接口请求参数:

openapi接口上传参数:

signMsg包含参数:

接口返回参数:

data主要参数说明：

备注:接口部分参数为辅助信息，不影响机构对接使用，故不做具体说明

转换失败码表:

查询失败示例：

{
    "status": "0",
    "time": "2017-04-06 14:31:09",
    "message": "参数错误"
}

查询成功但是课件转换失败示例：

{
    "status": "1",
    "msg": "succ",
    "data": [{
        "id": 15162960,
        "lesson_id": 1111192,
        "teacher_id": 1233456,
        "filename": "dsfsdfs",
        "filesize": 111119,
        "attach_origin_url": "https://i.weclassroom.com/lesson/jenkins/light/79/1233456/15162954/wordpage.html",
        "attach_convert_url": "11051",
        "convert_backup": null,
        "convert_zip_url": null,
        "convert_zip_backup_url": null,
        "created_at": "2019-05-30 15:34:25",
        "type": 1
    }]
}

查询成功示例：

{
    "status": "1",
    "msg": "succ",
    "data": [{
        "id": 15162957,
        "lesson_id": 111119,
        "teacher_id": 1233456,
        "filename": "dsfsdfs",
        "filemark": "79",
        "filesize": 111119,
        "attach_origin_url": "https://s.weclassroom.com/lesson/wordpage.html",
        "attach_convert_url": "11051",
        "convert_backup": "http:// ws.weclassroom.com/lesson/wordpage.html",
        "convert_zip_url": "http://s.weclassroom.com/lesson/48764a04adc1d.zip",
        "convert_zip_backup_url": "http://ws.weclassroom.com/4764a04adc1d.zip",
        "created_at": "2019-05-30 15:19:16",
        "convert_time": "2019-05-30 15:19:33",
        "type": 4
    }]
}

课件删除接口

接口说明： 删除机构下课件，根据teacher_id 和file_id来确定唯一的文件进行删除，由于third_token根据lesson_id验签，所以lesson_id必传，此处传任意值即可。
接口URL: /institution/coursewares/remove
接口域名: http(s)://api.weclassroom.com (测试环境:http://test-api.weclassroom.com) (老域名，可以使用但不再更新维护)
接口域名: http(s)://openapi.weclassroom.com (测试环境:http://test-openapi.weclassroom.com)(新域名，建议使用）
验签规则请查看附录下验签代码示例

api接口和openapi接口统一访问方式: POST
api接口上传参数:

openapi接口上传参数:

signMsg包含参数:

成功返回:

{
    "status": 1,
    "time": 1558941706,
    "msg": "删除成功"
}

失败返回:

{
    "status": 0,
    "time": 1558948243,
    "msg": [
        "The teacher_id field is required."
    ]
}
{
    "status": 0,
    "time": 1558948243,
    "msg": [
        "课件不存在"
    ]
}

机构课件查询接口

接口说明： SDK对接机构教师课件查询，支持多种纬度查询。此接口提供机构下教师上传课件后的查询功能，支持老师id，课件id，和时间段组合查询，并已分页方式返回，其中lesson_id可以传任意值，不参与查询。

接口URL: /institution/coursewares
接口域名: http(s)://api.weclassroom.com (测试环境:http://test-api.weclassroom.com ) (老域名，可以使用但不再更新维护)
接口域名: http(s)://openapi.weclassroom.com (测试环境:http://test-openapi.weclassroom.com )(新域名，建议使用） 验签规则请查看附录下验签代码示例

api接口和openapi接口统一访问方式: GET
api接口上传参数:

openapi接口上传参数:

signMsg包含参数:

data参数:

data.data参数：

成功返回：

{
    "status": 1,
    "time": 1563330382,
    "msg": "",
    "data": {
        "total": 53,  //总课件数
        "per_page": 10, //每页包含
        "current_page": 1, //当前页
        "last_page": 6,
        "next_page_url": "http://mxc.api.weclassroom.com/institution/coursewares?page=2&institution_id=79&per_page=10",  //下一页
        "prev_page_url": null, //上一页
        "from": 1, //第 x 条
        "to": 10, //第x 条
        "data": [ //此处只展示1天，节省空间
            {
                "id": 3,
                "lesson_id": 210113788,
                "teacher_id": 119436,
                "attach_convert_url": null, //转码后地址
                "filename": "yuchao",
                "filesize": 1,
                "status": 0,
                "attach_origin_url": "https://cloudclass-dev.oss-cn-beijing.aliyuncs.com/lesson/pdf/109088/RmnnrGdw4t1.ppt", //转码前地址
                "convert_backup": null,  //转码备份
                "convert_zip_url": null, //压缩包地址
                "convert_zip_backup_url": null,//备份的压缩包地址
                "type": 1
            }
        ]
    }
}

失败返回：

{
    "status": 0,
    "time": 1558948243,
    "msg": [
        "The lesson_id field is required."
    ]
}

上传机构课件

接口说明： 该接口主要提供课件上传功能，直播云提供课件转换服务 接口URL: /light/upload/courseWare
接口域名: http(s)://openapi.weclassroom.com (测试环境:http://test-openapi.weclassroom.com)
验签规则请查看附录下验签代码示例 接口请求方式: POST
openapi接口上传参数:

signMsg包含参数:

返回格式: JSON

返回参数说明:

返回示例:

{
    "status": 1,
    "error_code": 10000,
    "time": "2021-05-11 15:56:40",
    "message": "上传成功",
    "id": 28895
}

删除机构课件

接口说明： 该接口主要提供课件删除功能 接口URL: /light/delete/courseWare
接口域名: http(s)://openapi.weclassroom.com (测试环境:http://test-openapi.weclassroom.com)
验签规则请查看附录下验签代码示例 接口请求方式: POST
openapi接口上传参数:

signMsg包含参数:

返回格式: JSON

返回参数说明:

返回示例:

{
    "status": 1,
    "error_code": 10000,
    "time": "2021-05-11 15:56:40",
    "message": "操作成功"
}

绑定机构课件

接口说明： 该接口主要提供课件绑定功能，一个课件绑定多个课件 接口URL: /light/bind/lesson/courseWare
接口域名: http(s)://openapi.weclassroom.com (测试环境:http://test-openapi.weclassroom.com)
验签规则请查看附录下验签代码示例 接口请求方式: POST
openapi接口上传参数:

signMsg包含参数:

返回格式: JSON

返回参数说明:

返回示例:

{
    "status": 1,
    "error_code": 10000,
    "msg": "操作成功",
    "time": "2021-05-11 15:47:59"
}

机构课件列表

接口说明： 该接口主要提供课件查询功能（带分页） 接口URL: /light/courseWare/list
接口域名: http(s)://openapi.weclassroom.com (测试环境:http://test-openapi.weclassroom.com)
验签规则请查看附录下验签代码示例 接口请求方式: POST
openapi接口上传参数:

signMsg包含参数:

返回格式: JSON

返回参数说明:

data参数说明

list参数说明

返回示例:

{
    "status": 1,
    "error_code": 10000,
    "time": "2021-05-14 11:11:58",
    "data": {
        "count": 37,
        "page": 1,
        "pageSize": 20,
        "currentPage": 1,
        "list": [
            {
                "id": 28895,
                "teacher_id": 0,
                "filename": "dewweweweewewe.pdf",
                "filesize": 28390,
                "attach_origin_url": "https://cloudclass-dev.oss-cn-beijing.aliyuncs.com/test/abc123.pdf",
                "attach_convert_url": "http://cloudclass-dev.oss-cn-beijing.aliyuncs.com/courseware/template/pdf/v1/pdfpage.html?json=lesson/jenkins/79/28890/oss_plist.json&pageCount=16&firstSize=1400*1981",
                "convert_backup": null,
                "convert_zip_url": null,
                "convert_zip_backup_url": null,
                "convert_status": 2,
                "created_at": "2021-05-11 15:56:40",
                "updated_at": "2021-05-11 15:56:40",
                "type": 3
            }
        ]
    }