云视频API接口文档v2.3.1

云视频API接口文档云视频API接口文档版本：V2.3乐视网乐视云事业部目录相关说明4请求参数说明4返回参数说明4接口说明5修订历史记录日期版本说明作者2012-06-18V1.0起草陈新2012-07-10V1.1增加xml参数返回方式；增加flash上传接口陈新2012-08-08V1.2增加数据统计类接口；增加使用示例陈新2012-09-08V2.0采用新的方式进行参数传递，改进验证码生成规则陈新2012-10-29V2.1接口地址改名；视频上传初始化和断点续传接口返回值增加progress_url；增加视频上传进度查询接口陈新2012-11-19V2.2增加截图管理类接口陈新2013-02-20V2.2增加视频暂停和恢复接口；视频上传（Flash方式）增加flash_width和flash_height参数陈新2013-4-18V2.2video.upload.flash接口增加client_ip参数张喆浩2013-04-19V2.3视频列表和视频信息接口增加file_md5参数金宗锐2013-07-25V2.3增加支持分片参数uploadtype金宗锐2014-09-15V2.3增加视频自定义截图URL地址参数金宗锐相关说明1 使用HTTP协议进行信息交互，字符编码统一采用UTF-82 除非特殊说明，接口地址统一为：/open.php3 除非特殊说明，同时支持GET和POST两种参数传递方式4 除非特殊说明，返回信息支持JSON和XML两种方式5 除了sign外，其余所有请求参数值都需要进行URL编码6 参数表中，类型一栏声明的定义为：int 代表整数类型；string 代表字符串类型，如果后面有括号，括号中的数字代表该参数的最大长度；array表示数组类型系统参数说明名称类型必选描述user_uniquestringY用户唯一标识码，由乐视网统一分配并提供timestampintY当前Unix时间戳，请保证请求服务器时间正确，有些API接口是有时效性要求的apistringY调用API接口的名称formatstringY返回参数格式：支持json和xml两种方式verstringY协议版本号，统一取值为2.0signstringY验证码，生成规则详见下面的说明，其中secretkey是由乐视网统一分配并提供的用户密钥。sign生成规则可以分为4个步骤：1、 把其它所有参数按key升序排序。2、 把key和它对应的value拼接成一个字符串。按步骤1中顺序，把所有键值对字符串拼接成一个字符串。3、 把分配给的secretkey拼接在第2步骤得到的字符串后面。4、 计算第3步骤字符串的md5值，使用md5值的16进制字符串作为sign的值。返回参数说明名称类型描述codeint状态值：0表示操作成功；其它值表示失败，具体含义见message说明messagestring状态说明totalint符合条件的记录数量dataarray返回具体信息接口说明视频管理1. 视频上传初始化（Web方式）api名称：video.upload.init功能描述：视频上传前调用，获取正式上传时需要的一些信息应用参数说明：名称类型必选描述video_namestring(200)Y视频名称client_ipstring(15)N用户IP地址。为了保证用户上传的速度，建议将用户公网IP地址写入该参数file_sizeintN文件大小，单位为字节uploadtypeintN是否分片上传，0不分片，1分片；默认0返回参数data说明：名称类型描述video_idint视频IDvideo_uniquestring视频唯一标识码upload_urlstring视频上传地址，视频上传时提交地址progress_urlstring视频上传进度查询地址tokenstring视频上传标识，用于断点续传和上传进度查询uploadtypeint是否分片上传，0不分片，1分片2. 视频上传（Web方式）接口地址：由video.upload.init返回的upload_url确定功能描述：视频上传请求参数：由video.upload.init返回的upload_url确定，请不要进行任何修改返回参数data说明：名称类型描述注意事项：1、该接口只支持POST参数传递方式2、上传时form表单提交地址由video.uploadinit返回的upload_url确定，需要添加参数enctype=multipart/form-data，form表单中上传文件的参数名称为video_file示例如下：3、支持以下视频格式，请上传时做一下后缀名校验：微软视频：.wmv .avi .dat .asfReal Player：.rm .rmvb .ramMPEG视频：.mpg .mpeg手机视频：.3gpApple视频：.movSony视频：.mp4 .m4vDV视频：.dvix .dv其他常见视频：.mkv .flv .vob .qt .divx .cpk .fli .flc .mod3. 视频断点续传（Web方式）api名称：video.upload.resume功能描述：视频文件断点续传应用参数说明：名称类型必选描述tokenstring(500)Y视频上传标识uploadtypeintN是否分片上传，0不分片，1分片；默认0返回参数data说明：名称类型描述upload_urlstring视频续传地址，视频续传时提交地址progress_urlstring视频上传进度查询地址upload_sizeint已经上传的文件大小，单位为字节uploadtypeint是否分片上传，0不分片，1分片4. 视频上传进度查询（Web方式）接口地址：由video.upload.init或video.upload.resume返回的progress_url确定功能描述：视频上传进度查询，只有文件在上传过程中调用才有意义请求参数：由video.upload.init或video.upload.resume返回的progress_url确定，请不要进行任何修改返回参数data说明：名称类型描述total_sizeint视频文件总大小，单位为字节upload_sizeint已经上传的数据大小，单位为字节5. 视频上传（Flash方式）api名称：video.upload.flash功能描述：通过Flash插件方式进行视频上传应用参数说明：名称类型必选描述video_namestring(200)Y视频名称js_callbackstring(50)NJavascript回调函数，视频上传完毕后调用flash_widthintNFlash宽度，默认值为600flash_heightintNFlash高度，默认值为450client_ipstring(15)N用户IP地址。为了保证用户上传的速度，建议将用户公网IP地址写入该参数返回参数data说明：名称类型描述video_idint视频IDvideo_uniquestring视频唯一标识码flash_uploadstringflash上传html代码6. 视频信息更新api名称：video.update功能描述：编辑单个视频的相关信息应用参数说明：名称类型必选描述video_idintY视频IDvideo_namestring(200)N视频名称video_descstring(500)N视频简介tagstring(200)N标签is_payintN视频是否收费：0表示不收费；1表示收费（收费视频播放时会进行用户鉴权，请不要随便设置）Video_urlStringN返回参数data说明：名称类型描述7. 获取视频列表api名称：video.list功能描述：获取视频列表信息应用参数说明：名称类型必选描述indexintN开始页索引，默认值为1sizeintN分页大小，默认值为10，最大值为100statusintN视频状态：0表示全部；10表示可以正常播放；20表示处理失败；30表示正在处理过程中。默认值为0返回参数data说明：名称类型描述video_idint视频IDvideo_uniquestring视频唯一标识码video_namestring视频名称statusint视频状态：10表示可以正常播放；20表示处理失败；30表示正在处理过程中video_descstring视频简介tagstring标签is_payint视频是否收费：0表示不收费；1表示收费imgstring视频截图URL地址video_durationint播放时长，单位为秒initial_sizeint上传文件原始大小，单位为字节error_descstring错误描述，视频处理失败的具体原因描述add_timestring视频添加时间，格式为：yyyy-mm-dd hh:ii:sscomplete_timestring上传完毕时间，格式为：yyyy-mm-dd hh:ii:ssfile_md5string视频源文件的MD5值init_picstring视频自定义截图URL地址，默认为空8. 获取单个视频信息api名称：video.get功能描述：获取单个视频的详细信息应用参数说明：名称类型必选描述video_idintY视频ID返回参数data说明：名称类型描述video_idint视频IDvideo_uniquestring视频唯一标识码video_namestring视频名称statusint视频状态：10表示可以正常播放；20表示处理失败；30表示正在处理过程中 40表示停用video_descstring视频简介tagstring标签is_payint视频是否收费：0表示不收费；1表示收费imgstring视频截图URL地址video_durationint播放时长，单位为秒initial_sizeint上传文件原始大小，单位为字节error_descstring错误描述，视频处理失败的具体原因描述add_timestring视频添加时间，格式为：yyyy-mm-dd hh:ii:sscomplete_timestring上传完毕时间，格式为：yyyy-mm-dd hh:ii:ssfile_md5string视频源文件的MD5值init_picstring视频自定义截图URL地址，默认为空9. 视频删除api名称：video.del功能描述：删除视频应用参数说明：名称类型必选描述video_idintY视频ID返回参数data说明：名称类型描述10. 视频批量删除api名称：video.del.batch功能描述：批量删除视频应用参数说明：名称类型必选描述video_id_liststringY视频ID列表，使用符号-作为间隔符，每次最多操作50条记录返回参数data说明：名称类型描述11. 视频暂停api名称：video.pause功能描述：对播放正常的视频进行暂停操作应用参数说明：名称类型必选描述video_idintY视频ID返回参数data说明：名称类型描述12. 视频恢复api名称：video.restore功能描述：对暂停的视频进行恢复操作应用参数说明：名称类型必选描述video_idintY视频ID返回参数data说明：名称类型描述截图管理1. 获取视频截图api名称：image.get功能描述：获取视频截图应用参数说明：名称类型必选描述video_idintY视频IDsizestringY截图尺寸，每种尺寸各有8张图。有以下尺寸供选择：100_100、200_200、300_300、120_90、128_96、132_99、160_120、200_150、400_300、160_90、320_180、640_360、90_120、120_160、150_200、300_400返回参数data说明：名称类型描述img1string截图地址1img8string截图地址8数据统计1. 视频小时数据api名称：data.video.hour功能描述：获取以小时为单位的视频数据应用参数说明：名称类型必选描述datestring(10)Y日期，格式为：yyyy-mm-ddhourintN小时，0-23之间video_idintN视频IDindexintN开始页索引，默认值为1sizeintN分页大小，默认值为10，最大值为100返回参数data说明：名称类型描述hourint小时，0-23之间video_idint视频IDvideo_viewint视频展示量2. 视频天数据api名称：data.video.date功能描述：获取以天为单位的视频数据应用参数说明：名称类型必选描述start_datestring(10)Y开始日期，格式为：yyyy-mm-ddend_datestring(10)Y结束日期，格式为：yyyy-mm-ddvideo_idintN视频ID，不输入该参数将返回所有视频的数据indexintN开始页索引，默认值为1sizeintN分页大小，默认值为10，最大值为100返回参数data说明：名称类型描述datestring日期video_idint视频IDvideo_viewint视频展示量3. 所有数据api名称：data.total.date功能描述：获取以天为单位的所有数据应用参数说明：名称类型必选描述start_datestring(10)Y开始日期，格式为：yyyy-mm-ddend_datestring(10)Y结束日期，格式为：yyyy-mm-ddindexintN开始页索引，默认值为1sizeintN分页大小，默认值为10，最大值为100返回参数data说明：名称类型描述datestring日期total_viewint视频展示量使用示例用户密钥：secretkey=900150983cd24fb0d6963f7d28e17f72系统参数：user_unique=abcde12345timestamp=1347091285api=video.listformat=jsonver=2.0应用参数：index=1size=50步骤一：将所有参数按照字典顺序（英文字母）排序，如下api=video.listformat=jsonindex=1size=50timestamp=1347091285user_unique=abcde12345ver=2.0步骤二：按照步骤一排序好的顺序，把key和它对应的value拼接成一个字符串apivideo.listformatjsonindex1size50timestamp1347091285user_uniqueabcde12345ver2.0步骤三：把secretkey拼接到步骤二得到的字符串后面apivideo.listfo