Spark API演示工具
为帮助开发者方便的使用Spark API,我们设计了API交互演示工具,开发者可使用有效的API Key获取账户信息或操作账户下的数据。
参数 | 值 | 描述 |
---|---|---|
flashurl | Flash控件地址 | |
userid | 用户ID | |
categoryid | 二级分类ID | |
title | 视频标题,字符长度0~40,超出部分自动截取 若为空则采用去后缀文件名作为title |
|
tag | 视频标签,单个标签字符长度0~10,标签字符总长度:0~20 超出部分自动截取 |
|
description | 视频描述,字符长度0~200,超出部分自动截取 | |
选择文件 |
|
|
description=&tag=&title=&userid=&time=&hash=
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/user
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/video
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/video/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/video/v3
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/video/v4
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/video/v5
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
imagetype | 返回封面截图的类型,默认值:0(0:小图;1:大图) | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/video/v6
Response.
参数 | 值 | 描述 |
---|---|---|
videoid | 视频ID | |
userid | 用户ID | |
title | 视频标题,字符长度0~40 | |
description | 视频描述,字符长度0~200 | |
tag | 视频标签,单个标签字符长度0~10,标签字符总长度:0~20 超出部分自动截取 |
|
categoryid | 二级分类ID | |
playurl | 视频播放页面地址,若不编辑播放地址,请勿加入此参数。 | |
imageindex | 参数为视频封面截图序号,若不编辑视频封面截图序号,请勿加入此参数。 注:非正常状态的视频,不可编辑截图序号。 |
|
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/video/update
Response.
参数 | 值 | 描述 |
---|---|---|
videoid | 视频ID 注:处理中的视频不能进行删除操作。 | |
userid | 用户ID | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/video/delete
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/video/category
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/video/category/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
name | 分类名称 | |
super_categoryid | 一级分类ID,若为空,创建一级分类 | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/category/create
Response.
参数 | 值 | 描述 |
---|---|---|
categoryid | 视频分类ID | |
userid | 用户ID | |
name | 分类名称 | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/category/update
Response.
参数 | 值 | 描述 |
---|---|---|
categoryid | 视频分类ID | |
userid | 用户ID | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/category/delete
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
num_per_page | 返回信息时,每页显示视频的个数,阈值为:1~100。 | |
page | 当前页数 | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/playlists
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
name | 播放列表名称 | |
videoid | 播放列表要添加的视频ID,用","分割 | |
categoryid | 视频分类ID | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/playlist/create
Response.
参数 | 值 | 描述 |
---|---|---|
playlistid | 播放列表ID | |
userid | 用户ID | |
name | 播放列表修改后名称 | |
videoid | 播放列表要添加的视频ID,用","分割 | |
categoryid | 视频分类ID | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/playlist/update
Response.
参数 | 值 | 描述 |
---|---|---|
playlistid | 播放列表ID | |
userid | 用户ID | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/playlist/delete
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
id | 播放列表id | |
num_per_page | 分页参数,每页显示数量 注:允许范围为 1~100,默认值:100 | |
page | 分页参数,当前页码 | |
https://spark.bokecc.com/api/playlist/get
Response.
参数 | 值 | 描述 |
---|---|---|
videoid | 视频ID | |
userid | 用户ID | |
playerid | 播放器ID,若不加入此参数则返回默认播放器 | |
playerwidth | 播放器宽度,单位(px) | |
playerheight | 播放器高度,单位(px) | |
autoplay | 是否自动播放标识,默认为true | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/video/playcode
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid_from | 起始视频ID,若为空则从第一个视频开始。 | |
videoid_to | 终止视频ID,若为空则到最后一个上传的视频。 | |
num_per_page | 返回信息时,每页显示视频的个数,阈值为:1~100。 | |
page | 当前页数 | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/videos
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid_from | 起始视频ID,若为空则从第一个视频开始。 | |
videoid_to | 终止视频ID,若为空则到最后一个上传的视频。 | |
num_per_page | 返回信息时,每页显示视频的个数,阈值为:1~100。 | |
page | 当前页数 | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/videos/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid_from | 起始视频ID,若为空则从第一个视频开始。 | |
videoid_to | 终止视频ID,若为空则到最后一个上传的视频。 | |
num_per_page | 返回信息时,每页显示视频的个数,阈值为:1~100。 | |
page | 当前页数 | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/videos/v3
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid_from | 起始视频ID,若为空则从第一个视频开始。 | |
videoid_to | 终止视频ID,若为空则到最后一个上传的视频。 | |
num_per_page | 返回信息时,每页显示视频的个数,阈值为:1~100。 | |
page | 当前页数 | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/videos/v4
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid_from | 起始视频ID,若为空则从第一个视频开始。 | |
videoid_to | 终止视频ID,若为空则到最后一个上传的视频。 | |
num_per_page | 返回信息时,每页显示视频的个数,阈值为:1~100。 | |
page | 当前页数 | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/videos/v5
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
mode | 查询方式 0:指定要查询的视频的起始位置;1:指定一批视频进行查询(不传默认值为0) | |
videoids | 要查询的一批视频id,以英文状态下逗号分隔,最大值100,不可为空(mode=1时有效) | |
videoid_from | 起始 videoid,若为空,则从上传的第一个视频开始(mode=0时有效) | |
videoid_to | 终止 videoid,若为空,则到最后一个上传的视频(mode=0时有效) | |
num_per_page | 返回信息时,每页包含的视频个数 注:允许范围为 1~100,默认值:100 | |
page | 当前页码 | |
https://spark.bokecc.com/api/videos/v6
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
mode | 查询方式 0:指定要查询的视频的起始位置;1:指定一批视频进行查询(不传默认值为0) | |
videoids | 要查询的一批视频id,以英文状态下逗号分隔,最大值100,不可为空(mode=1时有效) | |
videoid_from | 起始 videoid,若为空,则从上传的第一个视频开始(mode=0时有效) | |
videoid_to | 终止 videoid,若为空,则到最后一个上传的视频(mode=0时有效) | |
imagetype | 返回封面截图的类型,默认值:0(0:小图;1:大图) | |
num_per_page | 返回信息时,每页包含的视频个数 注:允许范围为 1~100,默认值:100 | |
page | 当前页码 | |
https://spark.bokecc.com/api/videos/v7
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
mode | 查询方式 0:指定要查询的视频的起始位置;1:指定一批视频进行查询(不传默认值为0) | |
videoids | 要查询的一批视频id,以英文状态下逗号分隔,最大值100,不可为空(mode=1时有效) | |
videoid_from | 起始 videoid,若为空,则从上传的第一个视频开始(mode=0时有效) | |
videoid_to | 终止 videoid,若为空,则到最后一个上传的视频(mode=0时有效) | |
imagetype | 返回封面截图的类型,默认值:0(0:小图;1:大图) | |
num_per_page | 返回信息时,每页包含的视频个数 注:允许范围为 1~100,默认值:100 | |
page | 当前页码 | |
https://spark.bokecc.com/api/videos/v8
Response.
参数 | 值 | 描述 |
---|---|---|
categoryid | 视频分类ID | |
userid | 用户ID | |
num_per_page | 返回信息时,每页显示视频的个数,阈值为:1~100。 | |
page | 当前页数 | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/videos/category
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
categoryid | 视频分类的id,不可为空 | |
subuserid | 子账号id,如果为空则查询分类下全部视频 | |
num_per_page | 返回信息时,每页包含的视频个数 注:阈值为 1~100 | |
page | 当前页码 | |
sort | 1、格式:排序字段:排序方式 2、排序字段:CREATION_DATE或FILE_SIZE 3、排序方式:ASC或DESC 4、注:格式中的”:”为英文半角 Example:sort=CREATION_DATE:DESC | |
https://spark.bokecc.com/api/videos/category/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
q | 查询条件,示例:TITLE:test。参数介绍 | |
sort | 排序方式,示例:CREATION_DATE:DESC 参数介绍 | |
categoryid | 二级分类ID | |
num_per_page | 返回信息时,每页显示视频的个数,阈值为:1~100 | |
page | 当前页数 | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/videos/search
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
date | 查询日期,日期不不能⼤大于今⽇,格式为yyyy-MM-dd,不可为空 | |
https://spark.bokecc.com/api/stats/playcount/user/hourly
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
date | 查询日期,日期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
https://spark.bokecc.com/api/stats/playcount/user/hourly/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
start_date | 查询开始⽇期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束⽇期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playcount/user/daily
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playcount/user/daily/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
date | 查询日期,日期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
https://spark.bokecc.com/api/stats/playcount/video/hourly
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
date | 查询日期,日期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
https://spark.bokecc.com/api/stats/playcount/video/hourly/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playcount/video/daily
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playcount/video/daily/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
date | 查询日期,日期不不能⼤大于今⽇,格式为yyyy-MM-dd,不可为空 | |
https://spark.bokecc.com/api/stats/playduration/user/hourly
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
date | 查询日期,日期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
https://spark.bokecc.com/api/stats/playduration/user/hourly/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
start_date | 查询开始⽇期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束⽇期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playduration/user/daily
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playduration/user/daily/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
date | 查询日期,日期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
https://spark.bokecc.com/api/stats/playduration/video/hourly
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
date | 查询日期,日期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
https://spark.bokecc.com/api/stats/playduration/video/hourly/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playduration/video/daily
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playduration/video/daily/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
date | 查询日期,⽇期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
https://spark.bokecc.com/api/stats/uniquevisitor/user/hourly
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
date | 查询日期,日期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
https://spark.bokecc.com/api/stats/uniquevisitor/user/hourly/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/newuniquevisitor/user/daily
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/uniquevisitor/user/daily/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
date | 查询日期,⽇期不能⼤于今日,格式为yyyy-MM-dd,不可为空 | |
https://spark.bokecc.com/api/stats/newuniquevisitor/user/hourly
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/newuniquevisitor/user/daily
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/attention/user/daily
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/attention/user/daily/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/attention/video/daily
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/attention/video/daily/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
top | 排行榜单视频个数,即前top个。最大不超过100。 | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),⽇期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playcount/sorted
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
top | 排行榜单视频个数,即前top个。最大不超过100。 | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playcount/sorted/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playcount/user/daily/domain
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playcount/user/daily/domain/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今⽇,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playcount/video/daily/domain
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playcount/video/daily/domain/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playduration/user/daily/domain
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playduration/user/daily/domain/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今⽇,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playduration/video/daily/domain
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playduration/video/daily/domain/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playcount/user/daily/device
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playcount/user/daily/operatingsystem
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playcount/user/daily/browser
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playcount/user/daily/location
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playcount/user/daily/location/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playcount/video/daily/location
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playcount/video/daily/location/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playduration/user/daily/location
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playduration/user/daily/location/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playduration/video/daily/location
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期(含),日期不能大于今日,格式为yyyy-MM-dd,不可为空 注:end_date与start_date之间的差值最多为30 | |
https://spark.bokecc.com/api/stats/playduration/video/daily/location/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
date | 查询日期,⽇期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
https://spark.bokecc.com/api/traffic/user/hourly
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期,格式为yyyy-MM-dd,不可为空 | |
https://spark.bokecc.com/api/traffic/user/daily
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
start_month | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_month | 查询结束日期(含),格式为yyyy-MM-dd,不可为空 | |
https://spark.bokecc.com/api/traffic/user/monthly
Response.
参数 | 值 | 描述 |
---|---|---|
userid | ⽤户 id,不可为空 | |
videoid | 视频 id,不可为空 | |
date | 查询日期,⽇期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
https://spark.bokecc.com/api/traffic/video/hourly
Response.
参数 | 值 | 描述 |
---|---|---|
userid | ⽤户 id,不可为空 | |
videoid | 视频 id,不可为空 | |
start_date | 查询开始日期(含),格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期,格式为yyyy-MM-dd,不可为空 | |
https://spark.bokecc.com/api/traffic/video/daily
Response.
参数 | 值 | 描述 |
---|---|---|
userid | ⽤户 id,不可为空 | |
videoid | 视频 id,不可为空 | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/subtitle/video
Response.
参数 | 值 | 描述 |
---|---|---|
userid | ⽤户 id,不可为空 | |
videoids | 视频 id,以","分割,最多100个,不可为空 | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/subtitle/videos
Response.
参数 | 值 | 描述 |
---|---|---|
userid | ⽤户 id,不可为空 | |
videoid | 视频 id,不可为空 | |
q | 查询的关键词,不可为空 | |
num_per_page | 返回信息时,每页包含的字幕信息条数 注:允许范围为1~100 | |
page | 当前页码 | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/subtitle/search/video
Response.
参数 | 值 | 描述 |
---|---|---|
userid | ⽤户 id,不可为空 | |
q | 查询的关键词,不可为空 | |
num_per_page | 返回信息时,每页包含的字幕信息条数 注:允许范围为1~100 | |
page | 当前页码 | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/subtitle/search/user
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
customid | ⾃定义ID | |
date | 查询日期,日期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
https://spark.bokecc.com/api/playlog/custom/user
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
customid | ⾃定义ID | |
date | 查询日期,日期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
num_per_page | 返回信息时,每⻚页包含的日志条数 注:允许范围为1~5000 | |
page | 当前页码 | |
https://spark.bokecc.com/api/playlog/custom/user/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
customid | 自定义 id,String类型,最大长度为100,不可为空 | |
date | 查询日期,日期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
num_per_page | 返回信息时,每页包含的日志条数 注:允许范围为1~5000 | |
page | 当前页码 | |
https://spark.bokecc.com/api/playlog/custom/user/v3
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID | |
customid | ⾃定义ID | |
date | 查询日期,日期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
https://spark.bokecc.com/api/playlog/custom/video
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID | |
customid | ⾃定义ID | |
date | 查询日期,日期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
num_per_page | 返回信息时,每⻚页包含的日志条数 注:允许范围为1~5000 | |
page | 当前页码 | |
https://spark.bokecc.com/api/playlog/custom/video/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
customid | 自定义 id,String类型,最大长度为100,不可为空 | |
date | 查询日期,日期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
num_per_page | 返回信息时,每页包含的日志条数 注:允许范围为1~5000 | |
page | 当前页码 | |
https://spark.bokecc.com/api/playlog/custom/video/v3
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID | |
date | 查询日期,日期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
https://spark.bokecc.com/api/playlog/video
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID | |
date | 查询日期,日期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
num_per_page | 返回信息时,每⻚页包含的日志条数 注:允许范围为1~5000 | |
page | 当前页码 | |
https://spark.bokecc.com/api/playlog/video/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
date | 查询日期,日期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
num_per_page | 返回信息时,每页包含的日志条数 注:允许范围为1~5000 | |
page | 当前页码 | |
https://spark.bokecc.com/api/playlog/video/v3
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
date | 查询日期,日期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
num_per_page | 返回信息时,每⻚页包含的日志条数 注:允许范围为1~5000 | |
page | 当前页码 | |
https://spark.bokecc.com/api/playlog/user/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
date | 查询日期,日期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
num_per_page | 返回信息时,每页包含的日志条数 注:允许范围为1~5000 | |
page | 当前页码 | |
https://spark.bokecc.com/api/playlog/user/v3
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID | |
format | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/video/original
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
start_time | 开始时间, 格式为yyyy-MM-dd HH:mm,不可为空 | |
end_time | 结束时间, 格式为yyyy-MM-dd HH:mm,不可为空 (时间间隔不能超90天) | |
https://spark.bokecc.com/api/bandwidth/user/detail
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID | |
https://spark.bokecc.com/api/mark/video
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoids | 视频 id,以","分割,最多100个,不可为空 | |
https://spark.bokecc.com/api/mark/videos
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
videomarks | 打点信息,不可为空,一个视频最多50条打点信息,示例:[{"markdesc":"测试1","marktime":"10"},{"markdesc":"测试2","marktime":"15"}...] | | |
https://spark.bokecc.com/api/mark/update
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
marktimes | 时间点,单位为秒,多个时间点以 , 隔开 示例:10,15,20 | |
https://spark.bokecc.com/api/mark/delete
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID | |
https://spark.bokecc.com/api/pwd/video
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoids | 视频 id,以","分割,最多100个,不可为空 | |
https://spark.bokecc.com/api/pwd/videos
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
status | 是否开启 自定义播放地址有效时长 0 关闭 (默认2小时,设置timeout 值无效) ,1开启 (必须设置timeout值) | |
timeout | 有效时间(单位:s) | |
https://spark.bokecc.com/api/authtimeout/update
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID | |
pwd | 视频播放密码 | |
https://spark.bokecc.com/api/videopwd/update
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videopwds | 视频id和密码,不可为空,最大100个视频(格式为:视频id和密码用英⽂状态下”:”分隔,两组信息之间用英文状态下的”,”分隔.如:”C16C7C0BEB9E478B9C33DC5901307461:23456,68398DCB9E98 9CD89C33DC5901307461:12345,........”) | |
https://spark.bokecc.com/api/videopwds/update
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
customid | 自定义ID | |
date | 查询日期,⽇期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
https://spark.bokecc.com/api/traffic/user/custom/hourly
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
customid | 自定义ID | |
start_date | 查询开始日期,格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期,格式为yyyy-MM-dd,不可为空 | |
https://spark.bokecc.com/api/traffic/user/custom/daily
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
customid | 自定义ID | |
start_month | 查询开始日期,格式为yyyy-MM,不可为空 | |
end_month | 查询结束日期,格式为yyyy-MM,不可为空 | |
https://spark.bokecc.com/api/traffic/user/custom/monthly
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID | |
customid | 自定义ID | |
date | 查询日期,格式为yyyy-MM-dd,不可为空 | |
https://spark.bokecc.com/api/traffic/video/custom/hourly
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID | |
customid | 自定义ID | |
start_date | 查询开始日期,格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期,格式为yyyy-MM-dd,不可为空 | |
https://spark.bokecc.com/api/traffic/video/custom/daily
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID,必选 | |
download_url | 视频下载地址,必选 | |
title | 视频标题 | |
description | 视频描述信息 | |
tag | 视频标签 | |
categoryid | 分类ID | |
notify_url | 视频处理完后的回调地址 | |
https://spark.bokecc.com/api/video/fetch
Response.
参数 | 值 | 描述 |
---|---|---|
editParam | 编辑视频参数(该参数为Json格式,具体请参见API文档),必选 | |
https://spark.bokecc.com/api/video/montage
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID,不可为空 | |
covertype | 要上传的封面类型:0小图,1大图,不可为空 | |
coverurl | 要上传的封面地址,不可为空 | |
https://spark.bokecc.com/api/video/coverupload
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID,必选 | |
videoid | 视频ID,必选 | |
srtname | 字幕播放器上显示名称,必选(最多四个字符) | |
srturl | 字幕地址,必选 | |
srtnum | 字幕序号,双字幕时用来区分是第一个还是第二个字幕(可选值1、2; 默认值为1) | |
fontfamily | 字幕字体(默认值 NewRoman) | |
fontsize | 字幕字体大小(默认值 20) | |
fontcolor | 字幕字体颜色(默认值 #FFFFFF) | |
fontsurroundcolor | 字幕字体环绕颜色(默认值为 #000000) | |
marginbottom | 字幕距离底部的距离百分比(默认值 15%) | |
fileencode | 字幕的编码方式(取值utf-8和gbk;默认值为 utf-8) | |
https://spark.bokecc.com/api/video/fetchsrt
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
date | 查询日期,日期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
show_type | 显示数据区分维度类型,不可为空。可选值 1(产品线)、2(终端类型)、3 (媒体类型) | |
https://spark.bokecc.com/api/traffic/user/hourly/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
start_date | 查询开始日期,格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期,格式为yyyy-MM-dd,不可为空 | |
show_type | 显示数据区分维度类型,不可为空。可选值 1(产品线)、2(终端类型)、3 (媒体类型) | |
https://spark.bokecc.com/api/traffic/user/daily/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
start_month | 查询开始日期,格式为yyyy-MM,不可为空 | |
end_month | 查询结束日期,格式为yyyy-MM,不可为空 | |
show_type | 显示数据的区分维度类型,不可为空,可选值 1(产品线)、2(终端类型)、3 (媒体类型) | |
https://spark.bokecc.com/api/traffic/user/monthly/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
date | 查询日期,日期不能大于今日,格式为yyyy-MM-dd,不可为空 | |
show_type | 显示数据区分维度类型,不可为空。可选值 1(产品线)、2(终端类型)、3 (媒体类型) | |
https://spark.bokecc.com/api/traffic/user/hourly/v3
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
start_date | 查询开始日期,格式为yyyy-MM-dd,不可为空 | |
end_date | 查询结束日期,格式为yyyy-MM-dd,不可为空 | |
show_type | 显示数据区分维度类型,不可为空。可选值 1(产品线)、2(终端类型)、3 (媒体类型) | |
https://spark.bokecc.com/api/traffic/user/daily/v3
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
start_month | 查询开始日期,格式为yyyy-MM,不可为空 | |
end_month | 查询结束日期,格式为yyyy-MM,不可为空 | |
show_type | 显示数据的区分维度类型,不可为空,可选值 1(产品线)、2(终端类型)、3 (媒体类型) | |
https://spark.bokecc.com/api/traffic/user/monthly/v3
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID,不可为空 | |
content | 问答题目,不可为空(80字以内) | |
explaininfo | 问题的解答,150字以内 | |
answers | 问题的答案以及是否正确,不可为空,最少2个,最多8个选项,从上到下对应A-H(示 例:[{“content”: “A、答案一”, “isright”:0}, .....]) | |
showtime | 问题出现的时间(取值需在视频的有效时间内),单位:s,不可为空 | |
isjump | 是否可跳过(0:不可跳过;1:可跳过),不可为空 | |
keepplay | 答错后是否可继续播放(0:不可继续播放;1:可以继续播放),不可为空 | |
backtime | 回看时间点,单位:s(如需设置成不需要回看时间可设置成 -1, keepplay 为0时必填), 不可为空 | |
https://spark.bokecc.com/api/question/create
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID,不可为空 | |
questionid | 问题 id, 不可为空 | |
content | 问答题目(80字以内) | |
explaininfo | 问题的解答,150字以内 | |
answers | 问题的答案以及是否正确,最少2个,最多8个选项,从上到下对应A-H(示 例:[{“content”: “A、答案一”, “isright”:0}, .....]) | |
showtime | 问题出现的时间(取值需在视频的有效时间内),单位:s, 不可为空 | |
isjump | 是否可跳过(0:不可跳过;1:可跳过), 不可为空 | |
keepplay | 答错后是否可继续播放(0:不可继续播放;1:可以继续播放), 不可为空 | |
backtime | 回看时间点,单位:s(如需设置成不需要回看时间可设置成 -1, keepplay 为0时必填), 不可为空 | |
https://spark.bokecc.com/api/question/update
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID,不可为空 | |
questionid | 问题ID, 不可为空 | |
https://spark.bokecc.com/api/question/delete
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID,不可为空 | |
questionid | 问题ID, 不可为空 | |
https://spark.bokecc.com/api/question/get/v2
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID,不可为空 | |
questionid | 问题ID, 不可为空 | |
https://spark.bokecc.com/api/question/get
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
videoid | 视频ID,不可为空 | |
https://spark.bokecc.com/api/question/list
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID,不可为空 | |
hour | 查询小时时间字符串,不可为空,格式:yyyyMMddHH | |
pagenum | 分⻚⻚码,可选.默认1. | |
pagesize | 分⻚⻚面大小,可选. 默认100,最大100 | |
https://spark.bokecc.com/api/question/records
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID,不可为空 | |
videoid | 查询的videoid, 不可为空 | |
starttime | 开始时间,可选(yyyy-MM-dd HH:mm:ss) | |
endtime | 结束时间,可选(yyyy-MM-dd HH:mm:ss) | |
pagenum | 分⻚⻚码,可选.默认1. | |
pagesize | 分⻚⻚面大小,可选. 默认100,最大100. | |
https://spark.bokecc.com/api/video/barrage
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
https://spark.bokecc.com/api/exercise/list
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
title | 练习题目,不可为空 | |
appeartime | 练习出现的时间,不可为空 | |
isjump | 是否允许跳过 (0否 ,1是) | |
isplay | 是否允许继续播放(0否 ,1是) | |
backsecond | 回看时间点(isplay=0时,backsecond必须有值) | |
questions | 题目 | |
https://spark.bokecc.com/api/exercise/create
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
exerciseid | 练习id,不可为空 | |
title | 练习题目,不可为空 | |
appeartime | 练习出现的时间,不可为空 | |
isjump | 是否允许跳过 (0否 ,1是) | |
isplay | 是否允许继续播放(0否 ,1是) | |
backsecond | 回看时间点(isplay=0时,backsecond必须有值) | |
questions | 题目 | |
https://spark.bokecc.com/api/exercise/update
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
exerciseids | 练习id,操作多个练习以英文分割,不可为空 | |
https://spark.bokecc.com/api/exercise/delete
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
https://spark.bokecc.com/api/exercise/get
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
exerciseid | 练习id,不可为空 | |
https://spark.bokecc.com/api/exercise/question/list
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
exerciseid | 练习id,不可为空 | |
questionid | 题目id,不可为空 | |
https://spark.bokecc.com/api/exercise/question/get
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
exerciseid | 练习id,不可为空 | |
questionid | 题目id,不可为空 | |
content | 题目内容,限长80字 填空题 格式{“before”:”1’,”after”:”2”} 翻译为before__after),不可为空 | |
explaininfo | 题目解析,限长500字 | |
answers | 答案(单选多选最少两个答案,最多八个答案,填空一个答案) 问题的答案以及是否正确,不可为空,(该字段数据类型为 jsonArray,最 少2个最多8个选项,从上到下对应A-H,示例( [ {"content":"选项一","isright":0},{"content":"选项二","isright":0} ] ) | |
https://spark.bokecc.com/api/exercise/question/update
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
exerciseid | 练习id,不可为空 | |
questionids | 题目id,多个题目以英文逗号分割,不可为空 | |
https://spark.bokecc.com/api/exercise/question/delete
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
showtime | 问题出现的时间(取值需在视频的有效时间内),单位:s,不可为空 | |
isjump | 本问题是否可跳过(0:不可跳过;1:可跳过),不可为空 | |
answers | 答题器选项内容及正确选项,不可为空(数据类型为jsonArray,数量为2-8个,示例:[{"content": "A", "isright":0}, …..]) | |
https://spark.bokecc.com/api/clicker/create
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
clickerid | 答题器id,不可为空 | |
https://spark.bokecc.com/api/clicker/delete
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
clickerid | 答题器id,不可为空 | |
https://spark.bokecc.com/api/clicker/get
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
https://spark.bokecc.com/api/clicker/list
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
clickerid | 问题id,不可为空 | |
showtime | 问题出现的时间(取值需在视频的有效时间内),单位:s,不可为空 | |
isjump | 本问题是否可跳过(0:不可跳过;1:可跳过),不可为空 | |
answers | 答题器答案内容及正确选项,(数据类型为jsonArray,数量为2-8个,示例:[{"content": "A", "isright":0}, …..]) 注:此字段如果为空,则不会对原答案进行修改。如果不为空,则会全量覆盖原答案,并将统计数据归零 | |
https://spark.bokecc.com/api/clicker/update
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
https://spark.bokecc.com/api/knowledge/get
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
https://spark.bokecc.com/api/knowledge/delete
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
name | 按钮名称,最多4个字,为空则按钮不可见 | |
time_axis_status | 时间轴状态(0隐藏 1显示) | |
pause_status | 知识点播放结束暂停状态(0不暂停 1暂停) | |
category | 知识点分类(该字段数据类型为jsonArray),每个知识点最少一个分类,每个分类下最少有一个子分类。 示例:[{"name": "分类1", "children": [{"end_time": 1,"name": "1-1","start_time": 0}]}] | |
https://spark.bokecc.com/api/knowledge/add
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
duration | token有效时长(单位秒,最大为1800s),不可为空 | |
https://spark.bokecc.com/api/clip/token/get
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
id | 媒资id,不可为空 | |
https://spark.bokecc.com/api/media/delete
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
type | 媒资类型 - 0 全部 - 1 图片 - 2 视频 - 3 音频 - 4 文字,不可为空 | |
categoryid | 分类id | |
page | 页号,默认为第一页 | |
num_per_page | 每页查询数量,默认为10,最大为20 | |
https://spark.bokecc.com/api/media/list
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
id | 媒资id,不可为空 | |
name | 媒资名称(媒资名称和媒资分类不能都为空) | |
categoryid | 媒资分类(媒资名称和媒资分类不能都为空) | |
https://spark.bokecc.com/api/media/modify
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
id | 媒资id,不可为空 | |
https://spark.bokecc.com/api/media/get
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
jobid | 媒资id,不可为空 | |
https://spark.bokecc.com/api/media/task/get
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoids | 视频id(多个以英文逗号分隔),每次最多查询50个视频 | |
https://spark.bokecc.com/api/media/exists/check
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoids | 视频id(多个以英文逗号分隔) | |
categoryid | 分类id | |
notifyurl | 回调地址 | |
https://spark.bokecc.com/api/media/exists/check
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
jobid | 任务id,不可为空 | |
https://spark.bokecc.com/api/media/local/cancel
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
name | 媒资分类名称,不可为空 | |
parentid | 上级id(如果为空则创建一级分类) | |
https://spark.bokecc.com/api/media/category/add
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
id | 媒资分类id,不可为空 | |
https://spark.bokecc.com/api/media/category/delete
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
https://spark.bokecc.com/api/media/category/list
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
id | 媒资分类id,不可为空 | |
parentid | 上级id(上级id和媒资分类名称不能同时为空) | |
name | 媒资分类名称(上级id和媒资分类名称不能同时为空) | |
https://spark.bokecc.com/api/media/category/modify
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
name | 项目名称,不可为空 | |
https://spark.bokecc.com/api/clip/project/create
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
id | 项目id,不可为空 | |
name | 项目名称,不可为空 | |
https://spark.bokecc.com/api/clip/project/modify
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
id | 项目id,不可为空 | |
https://spark.bokecc.com/api/clip/project/delete
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
https://spark.bokecc.com/api/clip/project/list
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
page | 页号,默认为第一页 | |
num_per_page | 每页查询数量,默认为10,最大为20 | |
https://spark.bokecc.com/api/clip/export/task/list
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
jobid | 任务id,不可为空 | |
https://spark.bokecc.com/api/clip/export/task/get
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
https://spark.bokecc.com/api/media/space/get
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
https://spark.bokecc.com/api/clip/duration/get
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
num_per_page | 每页显示数量,最大100 | |
page | 页码 | |
https://spark.bokecc.com/api/subuser/list
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoids | 视频id,多个视频id以英文半角逗号连接,最大数量100个,不可为空 | |
qualities | 视频清晰度 -1 原片,10 普通, 20 高清 ,多个清晰度以英文半角逗 号连接(视频如果没有相关清晰度,则不返回相关清晰度的 md5 数据 ) | |
https://spark.bokecc.com/api/videos/md5
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id,不可为空 | |
videoid | 视频id,不可为空 | |
start_date | 开始时间,格式为:yyyy-MM-dd | |
end_date | 结束时间,格式为:yyyy-MM-dd,跨度最大 365 天 | |
pagenum | 分页页码,默认为1 | |
pagesize | 分页页面大小,默认100,最大100 | |
https://spark.bokecc.com/api/question/custom/records
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id | |
type | 操作类型(1:关联两个视频,2:解除两个视频关联) | |
mainvideoid | 主视频id | |
associatevideoid | 关联视频id | |
https://spark.bokecc.com/api/video/associate
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id | |
videoid | 要查询的主videoid(多个以英文状态下的逗号分隔,不传默认查该用户的全部记录) | |
pagenum | 从第几页开始,默认值:1 | |
pagesize | 每页多少个,默认值:100 | |
https://spark.bokecc.com/api/video/association/list
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id | |
associateid | 关联记录 id(多个中间以英文状态下的逗号间隔,最多100个) | |
https://spark.bokecc.com/api/video/association/delete
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id | |
https://spark.bokecc.com/api/authplay/info
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户ID | |
authplaytype | 需要开启授权播放类型(1:FLASH,2:H5,3:移动SDK),多个以英文逗号分隔,默认关闭。 | |
isccplay | 是否允许后台预览(1:开启,0:关闭),默认关闭。 | |
verifyurl | 授权播放验证地址,长度不能超过255个字节,为空则清空授权播放验证地址。 | |
returntype | JSON XML | 返回信息格式 |
https://spark.bokecc.com/api/authplay/edit
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id | |
https://spark.bokecc.com/api/callback/video/upload/info
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id | |
url | 回调地址,长度不能超过255个字节,为空则删除回调地址设置。 | |
https://spark.bokecc.com/api/callback/video/upload/save
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id | |
https://spark.bokecc.com/api/callback/video/delete/info
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id | |
url | 回调地址,长度不能超过255个字节,为空则删除回调地址设置。 | |
https://spark.bokecc.com/api/callback/video/delete/save
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id | |
https://spark.bokecc.com/api/callback/clip/merge/info
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id | |
url | 回调地址,长度不能超过255个字节,为空则删除回调地址设置。 | |
https://spark.bokecc.com/api/callback/clip/merge/save
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id | |
superid | 视频父分类ID,为0时查询一级视频分类。 | |
page | 分页参数,页码,默认为1。取值范围:大于0的整数。 | |
num_per_page | 分页参数,每页显示数量,默认为10。取值范围:1~100之间的任意整数。 | |
https://spark.bokecc.com/api/video/subcategory
Response.
参数 | 值 | 描述 |
---|---|---|
userid | 用户id | |
videoid | 视频ID | |
callback | 回调地址 | |
https://spark.bokecc.com/api/asr/create
Response.
Player API演示工具
为帮助开发者方便的使用Flash API,我们提供以下播放演示工具。
JS源码示例
地址:https://dev.bokecc.com/static/js/display.js
播放器配置
function on_cc_player_init(vid, objectId ){
var config = {};
//关闭右侧菜单
config.rightmenu_enable = 0;
config.on_player_seek = "custom_seek";
config.on_player_ready = "custom_player_ready";
config.on_player_start = "custom_player_start";
config.on_player_pause = "custom_player_pause";
config.on_player_resume = "custom_player_resume";
config.on_player_stop = "custom_player_stop";
config.player_plugins = {// 插件名称 : 插件参数
Subtitle : {
url : "https://dev.bokecc.com/static/font/example.utf8.srt"
, size : 24
, color : 0xFFFFFF
, surroundColor : 0x3c3c3c
, bottom : 0.15
, font : "Helvetica"
, code : "utf-8"
}
};
var player = getSWF(objectId);
player.setConfig(config);
}
自定义函数
function custom_player_ready() {
$("#display_info").html("<strong>播放器配置</strong>:on_player_ready.");
showBtn("player_start");
disabledBtn("player_pause");
disabledBtn("player_resume");
disabledBtn("player_current");
disabledBtn("player_seek");
return;
}
$(function() {
disabledBtn = function(name){
var playerBtn = $("#" + name);
if(!playerBtn.prop("disabled")){
playerBtn.attr("disabled","disabled");
}
};
showBtn = function(name){
var playerBtn = $("#" + name);
if(playerBtn.prop("disabled")){
playerBtn.removeAttr("disabled");
}
};
});
获取播放器对象
function getSWF(objectId) {
if (window.document[ swfID ]) {
return window.document[ swfID ];
} else if (navigator.appName.indexOf("Microsoft") == -1) {
if (document.embeds && document.embeds[ swfID ]) {
return document.embeds[ swfID ];
}
} else {
return document.getElementById( swfID );
}
}
Player API接口调用
var prefix = "cc_";
function player_play(id) { // 开始播放
var player = getSWF(prefix + id);
player.start();
}
function player_pause(id) { // 暂停播放
var player = getSWF(prefix + id);
player.pause();
}
function player_resume(id) { // 恢复播放
var player = getSWF(prefix + id);
player.resume();
}