荔枝云平台基础服务能力管理调用v

1、荔枝云-PaaS 平台基础服务能力管理规范服务调用规范(V1.3)江苏省广播电视总台北京新奥特云视科技2015 年 8 月目录第 1 章 调用说明101 . 1 概述101 . 2 请求结构说明10请求地址10公共参数11地址示例111 . 3 返回结果11第 2 章 接口认证122 . 1 获取令牌12功能描述12接口地址12请求参数12返回参数12请求示例13返回示例13服务状态码列表132 . 2第 3 章 转码服务相关接口153 . 1 创建转码任务15功能描述15接口地址15请求参数15返回参数16回调参数16请求示例16返回示例173 . 2 转码状态. 17功能描述17接口地址1

2、8请求参数18返回参数18请求示例18返回示例193 . 3 转码任务重试19功能描述19接口地址19请求参数19请求示例20返回示例203 . 4 转码模板. 20功能描述20接口地址21请求参数21返回参数21请求示例22返回示例233 . 5 转码服务状态码列表24第 4 章 技审服务相关接口244 . 1 创建技审任务24功能描述24接口地址24请求参数25返回参数25回调参数25请求示例26返回示例274 . 2 技审任务. 27功能描述27接口地址27请求参数27返回参数27请求示例28返回示例284 . 3 技审任务重试29功能描述29接口地址29请求参数29请求示例29返回示例

3、304 . 4 技审服务状态码列表30第 5 章 截图服务相关接口305 . 1 关键帧截图31功能描述31接口地址31请求参数31返回参数31回调参数31状态码32请求示例33返回示例335 . 2 定时截图33功能描述33接口地址34请求参数34返回参数34回调参数34状态码35请求示例35返回示例365 . 3 定点截图36功能描述36接口地址36请求参数37返回参数37回调参数37状态码38请求示例38返回示例395 . 4 定量截图39功能描述39接口地址39请求参数39返回参数40回调参数40状态码41请求示例41返回示例415 . 5 截图服务状态码列表42第 6 章 收录服务相

4、关接口426 . 1 任务添加43功能描述43接口地址43请求参数43返回参数43回调参数44请求示例44返回示例446 . 2 模板列表. 45功能描述45接口地址45请求参数45返回参数45请求示例46返回示例466 . 3 模板参数. 47功能描述47接口地址47请求参数47返回参数47请求示例48返回示例486 . 4 任务. 49功能描述49接口地址49请求参数49返回参数49请求示例50返回示例506 . 5 收录服务状态码列表51第 7 章服务相关接口517 . 1 频道开通（推流模式）51功能描述51接口地址51请求参数52返回参数52请求示例52返回示例537 . 2 频道开

5、通（拉流模式）53功能描述53接口地址53请求参数54返回参数54请求示例54返回示例557 . 3 频道关闭接口55功能描述55接口地址55请求参数55请求示例56返回示例567 . 4 模板接口56功能描述56接口地址57请求参数57返回参数57请求示例57返回示例587 . 5 模板参数接口58功能描述58接口地址58请求参数58返回参数59请求示例59返回示例607 . 6 频道状态接口61功能描述61接口地址61请求参数61返回参数61请求示例61返回示例62服务状态码列表627 . 7第 8 章 语音识别服务相关接口628 . 1 提交任务接口63功能描述63接口地址63请求参数6

6、3返回参数64回调参数64请求示例64返回示例65任务接口658 . 2功能描述65接口地址65请求参数66返回参数66请求示例66返回示例678 . 3 语音识别服务状态码列表67第1章 调用说明1.1 概述欢迎使用荔枝云-PaaS 平台云服务。用户可以使用本文档介绍的 API 对荔枝云-PaaS 平台云服务进行相关操作。对于接口的首先要获取令牌，每次请求都需要验证令牌信息，如果超过两个小时没有使用，令牌信息将过期，需要重新申领令牌。对荔枝云-PaaS 平台接口调用是通过向荔枝云-PaaS 平台的服务端地址HTTPPOST 请求，并按照接口说明在请求中加入相应请求参数；根据请求的处理情况，系

7、统会返回处理结果。1.2 请求结构说明请求地址荔枝云-PaaS 平台的服务接入地址规则：http:/公共参数接口地址地址由三部分组成：域名：服务所提供的内容。公共参数：参考公共参数说明中的内容说明，由系统统一进行分配，用户调用接口时按分配的内容进行填写。接口地址：服务提供的内容。注：所有参数项必须传递，非必填项的值可为空，所有参数区分大小写。请求及返回结果都使用 UTF-8 字符集进行编码。公共参数地址示例获取令牌的接口地址。http:/appCode/versionId/companyId/userId/serviceCode/auth/token/getAccessToken/【第一部分】

8、【第二部分】接口地址分为两个部分，第一部分是公共请求参数，必含项。第二部分是具体服务的接口地址。1.3 返回结果“code”:”,#状态码, 参照附录“message”:”,#描述信息“data”:“key”:”value”,“key”:”value”#结果数据，详情查看各接口返回参数属性含义类型说明必填appCode应用标识String应用唯一标识（由荔枝云平台提供）是versionId版本号String接口版本号，当前版本号为 V1是companyId企业标识String企业唯一标识（由荔枝云平台提供）是userId用户标识String用户唯一标识（用户填充）是serviceCode服务类

9、型标识String服务类型唯一标识（由荔枝云平台提供）是第2章 接口认证2.1 获取令牌功能描述荔枝云-PaaS 平台的服务会对每个的请求进行验证，需要在请求中带上令牌信息。此接口是以 OAuth2.0 模式实现认证和。令牌的获取方式：用户传递的应用标识、版本号、企业标识、服务标识、密钥和时间戳生成相应的令牌，该令牌有效时长为 2 小时。接口地址auth/token/getAccessToken/请求参数返回参数属性含义类型说明accessToken令牌String有时效性的属性含义类型说明必填accessKey密钥String密钥（此密钥由荔枝云平台提供，需）是timeStamp时间戳Str

10、ing请求接口时，请求方当前时间毫秒数是请求示例返回示例2.2服务状态码列表代码描述说明0Success操作1Authorization fail获取失败“code”:“0”,“message”:“”, “data”： “accessToken”:”05784E32D86340D976677714905E6D53B2E041F124A3D1603BAAD66E21880E E5”POST/appCode/versionId/companyId/userId/serviceCode/auth/token/getAccessTok en/User-Agent: curl/7.12.1 (x86_6

11、4-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/0.9.7a zlib/ libidn/0.5.6Pragma: no-cache Accept: */*Host:Content-Type:application/x-www-form-urlencoded Content-Length:XaccessKey=0A3D1603BAAD66E21880EE5&timeStampnput Parameter Invalid输入参数不合法第3章 转码服务相关接口荔枝云 转码服务可以支持不同格式的视音频转码，支持一入多

12、出、模板方式等快捷的转码形式。利用集群优势，使用切片转码方式可以极大的提高转码效率。转码服务提供任务创建、转码状态、任务重试和模板接口。3.1 创建转码任务功能描述创建转码任务前需要通过接口认证，获取令牌。根据请求参数创建转码任务，后返回对应的转码任务 ID。接口地址transcode/task/create/请求参数参数含义格式说明必填accessToken令牌String获取令牌接口返回的令牌是timeStamp时间戳String请求接口时，请求方当前 UTC 时间，毫秒数是srcFileUrl源文件地址String源文件地址是callbackUrl回调地址String回调通知地址否pri

13、ority优先级Int优先级，由低到高，取值（1-10）否fixedInfo固定信息String回调时该字符串保持原值返回给用户否output文件输出集合Array转码输出模板 ID 数组是isSplit是否切片Boolean是否切片，默认值是 false否返回参数回调参数转码任务结束后，由转码服务发起调用，回调地址为callbackUrl 的值，具体调用参数见下表回调请求示例：请求示例POSTPOST /callback/restUser-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/0.9.7a zl

14、ib/ libidn/0.5.6Pragma: no-cache Accept: */*Host:Content-Type:application/x-www-form-urlencoded Content-Length:XtaskId = task-id&status =2&fixedInfo=abc参数含义格式说明必填taskId任务 IdString创建转码任务时，产生的唯一标识是status任务结果状态Int转码任务结果状态，-1(失败)，2（）是fixedInfo固定信息String回调时该字符串保持原值返回给用户否参数含义格式说明taskId任务 Id

15、String创建转码任务时，产生的唯一标识destUrl文件生成路径Array返回文件生成路径，文件生成数量跟转码输出模板数相等，生成的文件名为【uuid_模板 ID】。注意： 只有在回调通知任务执行后此地址才能正常URL 无效返回示例3.2 转码状态功能描述任务前需要通过接口认证，获取令牌。根据转码任务 ID，当前转码“code”:0 , #状态码“message”:”,#描述信息“data”:“taskId”: “task-id”# 任务ID“destUrl”:“”,“” #文件路径/appCode/versionId/companyId/userId/serviceCode/transc

16、ode/task/create/ User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1OpenSSL/0.9.7a zlib/ libidn/0.5.6 Pragma: no-cacheAccept: */* Host:Content-Type:application/x-www-form-urlencoded Content-Length:XaccessToken=78888gfd&timestamp=&srcFileUrl= rest&priority=1&fixedI

17、nfo=&output=hd_h264,sd_h264&isSplit=true任务状态。接口地址transcode/task/query/请求参数返回参数请求示例POST / appCode/versionId/companyId/userId/serviceCode/ transcode/task/query/User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/0.9.7a zlib/ libidn/0.5.6Pragma: no-cache Accept: */*H

18、ost:Content-Type:application/x-www-form-urlencoded Content-Length:X参数含义格式说明status任务状态Int任务当前状态，-1(任务出错)、0(任务排队)、1(任务正在执行)、2(任务完成)progress任务进度Int进度值，0-100 整数参数含义格式说明必填accessToken令牌String获取令牌接口返回的令牌是timeStamp时间戳String请求接口时，请求方当前 UTC 时间，毫秒数是taskId任务 IDString任务 ID是返回示例3.3 转码任务重试功能描述转码重试前需要通过接口认证，获取令牌。根据

19、转码任务 ID，重新启动转码任务，主要用于转码任务失败时，可以调用该接口来做重新转码。接口地址transcode/task/retry/请求参数参数含义格式说明必填accessToken令牌String获取令牌接口返回的令牌是timeStamp时间戳String请求接口时，请求方当前 UTC 时间，毫秒数是“code”:0 , #状态码“message”:”,#描述信息“data”:“status”: 0,“progress” : 50accessToken=78888gfd&timestamp=&taskId=task-id请求示例返回示例3.4 转码模板功能描述转码模板前需

20、要通过接口认证，获取令牌。“code”:0 , #状态码“message”:”,#描述信息“data”:POST /appCode/versionId/companyId/userId/serviceCode/ transcode/task/retry/User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/0.9.7a zlib/ libidn/0.5.6Pragma: no-cache Accept: */*Host:Content-Type:application/x-www-form

21、-urlencoded Content-Length:XaccessToken=78888gfd&timestamp=&taskId=task-idtaskId任务 IDString任务 ID是接口地址transcode/template/query/请求参数返回参数参数含义格式说明templateId模板 IdString转码模板 IdtemplateName模板名称String转码模板名称vCodec编码格式String编码格式( dv、h263、h264、mpeg1mpeg2、mpeg4、ms1、rv10、rv20、rv30、rv40、wmv1、wmv2、wmv3)vBi

22、trate码率Int编码码率，：kb/sfps帧率Float帧率，：fpsgop图像组IntI 帧间隔width图像宽Int图像宽度height图像高Int图像高度aspect图像比例String图像比例pixelFormat图像格式String图像格式picUrl图片 UrlStringLogo 或水印的 url 路径，用于叠加 logo 或水印到图像上picX图片 x 坐标IntLogo 或水印叠加在图像上 x 坐标(图像左上角为坐标原点)picY图像 y 坐标IntLogo 或水印叠加在y 坐标(图像左上角为坐标原点)picWidth图片宽Int叠加到图像上的 Logo 或水印的宽pic

23、Height图片高Int叠加到图像上的 Logo 或水印的高vProfile概述String概述，用于 h264 编码使用vLevel级别String级别，用于 h264 编码使用subtitleUrl字幕 UrlString字幕 Url参数含义格式说明必填accessToken令牌String获取令牌接口返回的令牌是timeStamp时间戳String请求接口时，请求方当前 UTC 时间，毫秒数是请求示例POST/appCode/versionId/companyId/userId/serviceCode/transcode/template/quer y/User-Agent: curl/

24、7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/0.9.7a zlib/ libidn/0.5.6Pragma: no-cache Accept: */*Host:Content-Type:application/x-www-form-urlencoded Content-Length:XaccessToken=78888gfd&timestamp=aCodec音频编码格式String音频编码格式（ aac、aac_latm、ac3、amr_nb、amr_wb、mp2、mp3、opus、pcm_alaw、pc

25、m_f32be、pcm_f32le、pcm_f64be、pcm_f64le、pcm_s16be、pcm_s16le、pcm_s24be、pcm_s24le、pcm_s32be、pcm_s32le、pcm_s8、pcm_u16be、pcm_u16le、pcm_u24be、pcm_u24le、pcm_u32be、pcm_u32le、pcm_u8、ra_144、wmapro、wmav1、wmav2、Vorbis）aBitrate音频码率Int音频编码码率channel音频声道Int音频编码声道sampleRate采样率Int音频采样率，HzextraParam扩展参数String扩展参数format

26、打包格式String输出打包格式(asf、avi、dv、flv、mp4、swf、mxf、rm、mov、m4v、h261、h263、h264、mpg、ts、3gp、mkv、wmv、vob）extraInfo附加信息String文件附加信息返回示例“code”:0 , #状态码“message”:”,#描述信息“data”:“templates”: “templateId”: “uf879940”, “templateName” : “hd_h264”, “vCodec” : “h264”, “vBitrate” : 1500,“fps” : 25.0,“gop” : 100,“width” :

27、1280,“height” : 720,“aspect” : “16:9”, “pixelFormat” : “yuv420p”, “picUrl” : “”,“picX” : 0,“picY” : 0,“picWidth” : 0,“picHeight” : 0, “vProfile” : “”,“vLevel” : 3.1,“subtitleUrl” : “”,“aCodec” : “aac”, “aBitrate” : 128,“channel” : 2,“sampleRate” : 44100, “extraParam” : “”,“format” : “flv”,“extraInfo

28、” : “”3.5 转码服务状态码列表第4章 技审服务相关接口技审服务是对视音频通过自动检测，来发现视音频文件中是否存在黑场、彩场、静帧、彩条、静音、声音过高、声音过低故障。本服务提供任务创建、任务、任务重试接口。4.1 创建技审任务功能描述创建技审任务前需要通过接口认证，获取令牌。根据请求参数创建技审任务，后返回对应的技审任务 ID。接口地址techeye/task/create/代码描述说明0Success操作60001Source File Not Found源文件地址无效60002Input Parameter Invalid输入参数不合法60003Inner Error系统内部错误6

29、0004Unknow Error未知错误60005TaskId Is Not Exist任务 id 不存在60006Task failure转码失败请求参数附表：检测参数返回参数回调参数技审任务结束后，由技审服务发起调用，回调地址为callbackUrl 的值，具体调用参数见下表回调请求示例：POST /callback/rest/参数含义格式说明必填taskId任务 IdString创建技审任务时，产生的唯一标识是status任务结果状态Int技审任务结果状态，-1(失败)，2（）是fixedInfo固定信息String回调时该字符串保持原值返回给用户否参数含义格式说明taskId任务 Id

30、String创建技审任务时，产生的唯一标识参数类型必填说明detectTypeInt是0(黑场);1(静帧);2(彩条);3(彩场);4(静音);5(声音过高);6(声音过低)thresholdFloat是检测阈值continueValueInt是持续发生某一故障的时长，毫秒。参数含义格式说明必填accessToken令牌String获取令牌接口返回的令牌是timeStamp时间戳String请求接口时，请求方当前 UTC 时间，毫秒数是srcFileUrl源文件地址String需要技审的源文件地址是callbackUrl回调地址String技审结束，回调通知地址否priority优先级Int

31、优先级，由低到高，取值（1-10）否fixedInfo固定信息String回调时该字符串保持原值返回给用户否detectParams技审参数Array技审检测参数数组，具体检测参数见附表是请求示例POST/appCode/versionId/companyId/userId/serviceCode/techeye/task/create/ User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1OpenSSL/0.9.7a zlib/ libidn/0.5.6 Pragma: no-cacheAccept:

32、*/* Host:Content-Type:application/x-www-form-urlencoded Content-Length:XaccessToken=78888gfd&timestamp=&taskId = task-id&status =2&srcFileUrl=“detectType” : 0, “threshold” : 0.89,“continueValue” : 125,“detectType” : 1, “threshold” : 0.80,“continueValue” : 125,“detectType” : 2, “thres

33、hold” : 0.85,“continueValue” : 25,“detectType” : 3, “threshold” : 0.89,“continueValue” : 25,“detectType” : 4, “threshold” : 20,“continueValue” : 441000,“detectType” : 5, “threshold” : 70,“continueValue” : 441000,“detectType” : 6, “threshold” :30, “continueValue” : 441000User-Agent: curl/7.12.1 (x86_

34、64-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/0.9.7a zlib/ libidn/0.5.6Pragma: no-cache Accept: */*Host:Content-Type:application/x-www-form-urlencoded Content-Length:XtaskId = task-id&status =2&fixedInfo=返回示例4.2 技审任务功能描述任务前需要通过接口认证，获取令牌。根据技审任务ID，技审任务内容。接口地址techeye/task/query/请求参数返回参数参数含

35、义格式说明status任务状态Int任务当前状态，-1(任务出错)、0(任务排队)、1(任务参数含义格式说明必填accessToken令牌String获取令牌接口返回的令牌是timeStamp时间戳String请求接口时，请求方当前 UTC 时间，毫秒数是taskId任务 IDString任务 ID是“code”:0 , #状态码“message”:”,#描述信息“data”:“taskId”:”task-id”# 任务ID附表：检测参数请求示例返回示例“code”:0 , #状态码“message”:”,#描述信息“data”:“status”: 0,“progress” : 50, “fa

36、ults” : POST /appCode/versionId/companyId/userId/serviceCode/ techeye/task/query/User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/0.9.7a zlib/ libidn/0.5.6Pragma: no-cache Accept: */*Host:Content-Type:application/x-www-form-urlencoded Content-Length:XaccessToken=78888g

37、fd&timestamp=&taskId=task-id参数类型说明faultTypeInt0(黑场);1(静帧);2(彩条);3(彩场);4(静音);5(声音过高);6(声音过低)startTimeString故障开始时间，格式 00:00:00.000stopTimeString故障结束时间，格式 00:00:00.000正在执行)、2(任务完成)progress任务进度Int进度值，0-100 整数faults技审结果Array技审检测结果，详细见附表4.3 技审任务重试功能描述技审重试前需要通过接口认证，获取令牌。根据技审任务ID，重新启动技审任务，主要用于技审任务失败

38、时，可以调用该接口来做重新技审。接口地址techeye/task/retry/请求参数请求示例POST/appCode/versionId/companyId/userId/serviceCode/techeye/task/retry/ User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1OpenSSL/0.9.7a zlib/ libidn/0.5.6 Pragma: no-cache参数含义格式说明必填accessToken令牌String获取令牌接口返回的是timeStamp时间戳String请求接

39、口时，请求方当前 UTC 时间，毫秒数是taskId任务 IDString任务 ID是“detectType” : 0,“startTime” : “00:01:00.000”,“stopTime” : “00:01:01.960”返回示例4.4 技审服务状态码列表第5章 截图服务相关接口截图服务提供截图功能，服务提供多种截图方式，包括按关键帧自动截图、定代码描述说明0Success操作70001Source File Not Found源文件地址无效70002Input Parameter Invalid输入参数不合法70003Inner Error系统内部错误70004Unknow Err

40、or未知错误70005TaskId Is Not Exist任务 id 不存在70006task is failed任务失败70007Query error技询任务失败“code”:0 , #状态码“message”:”,#描述信息“data”:Accept: */* Host:Content-Type:application/x-www-form-urlencoded Content-Length:XaccessToken=78888gfd&timestamp=&taskId=task-id时截图、按数量截图等方式，完成自动截取中的图片并保存到集中中，降低外部系统截取图片和保

41、存图片的复杂度。5.1 关键帧截图功能描述调用关键帧截图服务需要获取令牌。通过参数中所传递的地址，关键帧截图服务会自动按照关键帧截取该的图片。接口地址screenShot/shotByKeyFrame/请求参数返回参数回调参数截图任务结束后，由截图服务发起调用，回调地址为的值，具体调用callbackUrl参数见下表参数含义格式说明taskId任务 IdString创建截图任务时，产生的唯一标识参数含义格式说明必填accessToken令牌String获取令牌接口返回的令牌是timeStamp时间戳String请求接口时，请求方当前时间毫秒数是Url地址String地址是callBackUrl

42、回调地址String截图操作完成后回调地址是回调请求示例：状态码代码描述说明0success操作80001Source file not found源文件地址无效80002Input parameter invalid输入参数不合法80005Inner error系统内部错误80006Unknow error未知错误POST /callback/rest/User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/0.9.7a zlib/ libidn/0.5.6Pragma: no-cache

43、 Accept: */*Host:Content-Type:application/x-www-form-urlencoded Content-Length:XtaskId = task-id&status =2&pointscreen="pointTime ": "00:00:01.400", "imageUrl": ""参数含义格式说明必填taskId任务 IdString创建截图任务时，产生的唯一标识是status任务结果状态String截图任务结果状态，-1(失败)，2（）是pointscr

44、een截图信息Array包含 pointTime(截取图片的时间点)与imageUrl(对应截图存放的 Url)是请求示例返回示例5.2 定时截图功能描述任务前需要通过接口认证，获取令牌。“code”:0 , #状态码“message”:”,#描述信息“data”:taskid：POST/appCode/versionId/companyId/userId/serviceCode/screenShot/shotByKeyFra me/User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/0.9.7azl

45、ib/ libidn/0.5.6Pragma: no-cache Accept: */*Host:Content-Type:application/x-www-form-urlencoded Content-Length:XaccessToken=0A3D1603BAAD66E21880EE5&timeStamp=1435642027&vi deoUrl=接口地址screenShot/shotByInterval/请求参数返回参数回调参数截图任务结束后，由截图服务发起调用，回调地址为callbackUrl 的值，具体调用参数见下表回调请求示例：POST /call

46、back/rest/User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/0.9.7a zlib/ libidn/0.5.6参数含义格式说明必填taskId任务 IdString创建截图任务时，产生的唯一标识是status任务结果状态String截图任务结果状态，-1(失败)，2（）是pointscreen截图信息Array包含 pointTime(截取图片的时间点)与imageUrl(对应截图存放的 Url)是参数含义格式说明taskId任务 IdString创建截图任务时，产生的唯一标

47、识参数含义格式说明必填accessToken令牌String获取令牌接口返回的令牌是timeStamp时间戳String请求接口时，请求方当前时间毫秒数是Url地址String地址是interval偏移量Int时间间隔（：秒），默认为 5 秒是callBackUrl回调地址String截图操作完成后回调地址是状态码请求示例POST/appCode/versionId/companyId/userId/serviceCode/screenShot/shotByInterva l/User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/0.9.7azlib/ libidn/0.5.6Pragma: no-cache Accept: */*Host:Content-Type:application/x-www-form-urlencoded代码描述说明0success操作80001Source file no