荔枝云paas平台统一媒资资源管理v

1、北京新奥特云视科技2015 年 8 月目录第 1 章 素材包规范101 . 1 素材包101.1.1 属性说明101.1.2 属性格式111 . 2 基本信息121.2.1属性说明121.2.2属性格式13信息类型141 . 31.3.1属性说明141.3.2属性格式14文件类型151 . 41.4.1属性说明151.4.2属性格式171 . 5 音频文件类型191.5.1 属性说明191.5.2 属性格式201 . 6 图片文件类型211.6.1 属性说明211.6.2 属性格式221 . 7 图形文件类型231.7.1 属性说明231.7.2 属性格式231 . 8 文稿类型241.8.1

2、 属性说明241.8.2 属性格式251 . 9 其他文件类型261.9.1 属性说明261.9.2 属性格式271 . 10 视音频出入点类型281.10.1 属性说明281.10.2 属性格式281 . 11 扩展属性类型291.11.1 属性说明291.11.2 属性格式29第 2 章 调用说明292 . 1 概述292 . 2 请求结构说明302.2.1请求地址302.2.2公共参数302.2.3地址示例312 . 3 返回结果31第 3 章 接口认证333 . 1 获取令牌333.1.1功能描述333.1.2接口地址333.1.3请求参数333.1.4返回参数343.1.5请求示例3

3、43.1.6返回示例34第 4 章 媒资服务364 . 1 内容上传364.1.1 FTP 上传364.1.2 断点续传374 . 2 7 上传进度. 434.2.1功能描述434.2.2接口地址434.2.3参数说明444.2.4返回参数444.2.5请求示例444.2.6返回示例454.2.7状态码454 . 3. 464.3.1功能描述464.3.2接口地址464.3.3参数说明464.3.4返回参数474.3.5请求示例474.3.6返回示例494.3.7状态码494 . 4. 494.4.1功能描述494.4.2接口地址504.4.3参数说明504.4.4返回参数504.4.5请求示

4、例504.4.6返回示例514.4.7状态码534 . 5 按条件. 544.5.1功能描述544.5.2接口地址544.5.3参数说明544.5.4返回参数554.5.5请求示例554.5.6返回示例554.5.7状态码584 . 6 删除. 584.6.1功能描述584.6.2接口地址594.6.3参数说明594.6.4返回参数594.6.5请求示例594.6.6返回示例604.6.7状态码604 . 7 更新素材包信息614.7.1功能描述614.7.2接口地址614.7.3参数说明614.7.4返回参数614.7.5请求示例614.7.6返回示例634.7.7状态码634 . 8 更新

5、多文件信息新增634.8.1 功能描述634.8.2接口地址644.8.3参数说明644.8.4返回参数644.8.5请求示例644.8.6返回示例664.8.7状态码674 . 9 更新多文件信息删除674.9.1功能描述674.9.2接口地址674.9.3参数说明684.9.4返回参数684.9.5请求示例684.9.6返回示例694.9.7状态码69包与已有多文件绑定接口704 . 104.10.1功能描述704.10.2接口地址704.10.3参数说明704.10.4返回参数714.10.5请求示例714.10.6返回示例714.10.7状态码72或移交接口724 . 114.11.1

6、功能描述724.11.2接口地址724.11.3参数说明734.11.4返回参数734.11.5请求示例734.11.6返回示例744.11.7状态码74附录75状态码列表75第1章 素材包规范本文档中的所涉及的接口的主要是提供对于的云端处理服务，为了更好的实现统一管理和调度，荔枝云平台遵照全台网 2.0 的要求对于格式进行了统一的规范，本文档中所涉及到云的服务都将遵从素材包规范的内容来实现。请在进行服务对接前，先需要了解素材包的定义规范，以免影响您的工作进行。1.1 素材包1.1.1 属性说明素材包属性含义对象、集合、属性。一个素材包在进行构造时，必须根据“是否必填属性”说明进行构造；一个素

7、材包必须指定加入一个 baseInfo 属性；其他属性字段，根据具体业务参数进行构造即可。素材包构造时，对应的属性需要根据属性类型和属性说明进行构造。属性含义类型说明必填materialPackage对象无素材内容信息是baseInfo对象baseInfoType素材包基本信息是copyrightInfo对象copyrightInfoType信息否contentFiles对象无多文件信息否Files集合FileType文件信息否audioFiles集合audioFileType音频文件信息否1.1.2 属性格式#素材包格式“baseInfo”: 素材包基本信息 , “copyrightInfo

8、”: 信息 , “contentFiles”: “Files”: 文件集合, “audioFiles”: 音频文件集合, “imageFiles”: 图片文件集合, “graphFiles”: 图形文件集合, “scriptFiles”: 文稿集合, “otherFiles”: 其他文件集合“extendAttributes”: 扩展属性集合imageFiles集合imageFileType图片文件信息否graphFiles集合graphFileType图形文件信息否scriptFiles集合scriptFileType文稿对象信息否otherFiles集合otherFileType其他文件信

9、息否extendAttributes集合extentionAttributeType扩展属性信息否1.2 基本信息1.2.1 属性说明属性含义类型说明必填baseInfo对象无素材包基本信息是pkGUID属性string素材包唯一标识否title属性string标题是origin属性string来源否owner属性string所有者是creator属性string创建者是useRange属性string使用范围否language属性string语种否version属性string版本否createTime属性string创建时间否revisionTime属性string修订时间否status属

10、性string素材包的状态否mainFileGUID属性string素材包中的主文件标识否mainFileType属性string素材包中的主文件类型：、Audio、Image、Graph、Script、Other否description属性string素材包整体描述否tagItems属性stringTag。多个之间以英文”,”逗号分隔否keywords属性string。多个之间以英文”,”逗号分隔否clickRate属性string点击率否1.2.2 属性格式#素材包基本信息“pkGUID”：”string”, “title”: “string”,“origin”: “string”,“ow

11、ner”: “string”,“creator”: “string”, “useRange”: “string”, “language”: “string”, “version”: “string”, “createTime”: “string”, “revisionTime”: “string”, “status”: “string”, “mainFileGUID”: “string”, “mainFileType”: “string”, “description”: “string” “tagItems”:”string” “keywords”:”string”1.3信息类型1.3.1 属

12、性说明1.3.2 属性格式#信息格式“materialOrigin”: “string”, “property”: “string”, “class”: “string”,属性含义类型说明必填copyrightInfo对象无信息类型是materialOrigin属性string素材来源：、委托制作、制作、国内采购、海外引进、交流播出、其他否property属性string属性：、合作、仅有播出权、衍生否copyrightGrade属性string等级：一级：可播出可作素材可开发：可播出可作素材、三级：播出否broadcastRights属性string播出权：地面频道（有线、无线）、频道、数字

13、频道、宽频、电视、移动电视、航空、其他否distributionRight s属性string权：国内模拟频道（有线、无线、）、国内新、国际模拟频道、国际新否period属性string年限否1.4文件类型1.4.1 属性说明属性含义类型说明必填FileType对象无文件类型是relationCode属性string标识（AndAudio、KeyFrame、HighLowBit 等）否relationType属性string类型（/音频、/关键帧、高码/低码等）否md5属性string文件 MD5 值是terminalType属性string终端类型（包含 pc、mb、ott）等否GUID属性

14、string文件唯一标识否Name属性string文件名称是URL属性string文件地址是Format属性string文件格式否mediaType属性string格式否Type集合string类型：高码、低码否column属性string所属栏目否compression属性string压缩格式否“broadcastRights”: “string”,“distributionRights”: “string”, “period”: “string”bitRate属性string压缩码率(Kbps)否frameWidth属性string画面宽度否frameHeight属性string画面高度否

15、resolution属性string画面宽高比（分辨率）否size属性string素材大小(字节)否frames属性string素材长度(帧)否frameRate属性string帧率(fps)否startPoint属性string有效内容的起始时间否duration属性string持续时间（时长）否Quality属性string画面质量，如：标清、否samplesFormat属性string采样格式否bitsPerPixel属性string每像素位数否pixelFormat属性string像素格式否dataRate属性string数据码率否scanMode属性string扫描模式否gopSiz

16、e属性stringIBP 素材的 GOP 长度否bFrameCount属性stringB 帧个数否pFrameCount属性stringP 帧个数否natureSound属性string同期声否status属性string文件状态否dataContent属性string内容描述否isRelatedAudio属性boolean是否有强关联的音频文件否isRelatedFrame属性boolean是否有关键帧否markInfo集合markInfoType出入点集合否extendAttribute s集合extentionAttrib uteType扩展属性集合否1.4.2 属性格式#文件格式“re

17、lationCode”：”string”, “relationType”：”string”, “md5”：”string”, “terminalType”：“string”, “GUID”: “string”,“Name”: “string”,“URI”: “string”,“Format”: “string”, “mediaType”: “string”, “Type”： “string”,“column”: “string”, “compression”: “string”, “bitRate”: “string”, “frameWidth”: “string”, “frameHeight

18、”: “string”, “resolution”: “string”, “size”: “string”,“frames”: “string”, “frameRate”: “string”,“startPoint”: “string”,“duration”: “string”,“Quality”: “string”, “samplesFormat”: “string”, “bitsPerPixel”: “string”, “pixelFormat”: “string”, “dataRate”: “string”, “scanMode”: “string”, “gopSize”: “strin

19、g”, “bFrameCount”: “string”, “pFrameCount”: “string”, “natureSound”: “string”, “status”: “string”, “dataContent”: “string”, “isRelatedAudio”: boolean, “isRelatedFrame”: boolean, “markInfo”: 出入点集合, “extendAttributes”: 扩展属性集合1.5 音频文件类型1.5.1 属性说明属性含义类型说明必填audioFileType对象无音频文件类型是relationCode属性string标识（A

20、ndAudio、KeyFrame、HighLowBit 等）否relationType属性string类型（/音频、/关键帧、高码/低码/转码等）否md5属性string文件 MD5 值是audioGUID属性string音频文件唯一标识否audioName属性string音频文件名称是audioURL属性string音频文件地址是audioFormat属性string音频文件格式否mediaType属性string格式否column属性string所属栏目否size属性string素材大小(字节)否startPoint属性string有效内容起始时间否duration属性string持续时间

21、（时长）否channelNumber属性string声道数否samplesRate属性string音频采样率否bitsPerSample属性string量化位数否status属性string音频文件状态否dataContent属性string内容描述否markInfo集合markInfoType音频出入点集合否1.5.2 属性格式#音频文件格式“relationCode”：”string”, “relationType”：”string”, “md5”：”string”, “audioGUID”: “string”, “audioName”: “string”, “audioURI”: “st

22、ring”, “audioFormat”: “string”, “mediaType”: “string”, “column”: “string”,“size”: “string”, “startPoint”: “string”, “duration”: “string”, “channelNumber”: “string”, “samplesRate”: “string”, “bitsPerSample”: “string”, “status”: “string”, “dataContent”: “string”, “markInfo”: 音频出入点集合,extendAttribute s集

23、合extentionAttributeType扩展属性集合否1.6 图片文件类型1.6.1 属性说明属性含义类型说明必填imageFileType对象无图片文件类型是relationCode属性string标识（AndAudio、KeyFrame、HighLowBit 等）否relationType属性string类型（/音频、/关键帧、高码/低码/转码等）否md5属性string文件 MD5 值是imageGUID属性string图片文件唯一标识否imageName属性string图片文件名称是imageURL属性string图片文件地址是imageFormat属性string图片文件格式否

24、mediaType属性string格式否imageWidth属性string画面宽度否imageHeight属性string画面高度否resolution属性string分辨率否size属性string图片大小(字节)否DPI属性string打印分辨率否bitDepth属性string位深度否“extendAttributes”: 扩展属性集合1.6.2 属性格式#图片文件格式“relationCode”：”string”, “relationType”：”string”, “md5”：”string”, “imageGUID”: “string”, “imageName”: “string”

25、, “imageURI”: “string”, “imageFormat”: “string”, “mediaType”: “string”, “imageWidth”: “string”, “imageHeight”: “string”, “resolution”: “string”, “size”: “string”,“DPI”: “string”, “bitDepth”: “string”, “dataContent”: “string”,“extendAttributes”: 扩展属性集合dataContent属性string内容描述否extendAttributes集合Extenti

26、onAttributeType扩展属性集合否1.7 图形文件类型1.7.1 属性说明1.7.2 属性格式#图形文件格式“relationCode”：”string”,属性含义类型说明必填graphFileType对象无图形文件类型是relationCode属性string标识（AndAudio、KeyFrame、HighLowBit 等）否relationType属性string类型（/音频、/关键帧、高码/低码/转码等）否md5属性string文件 MD5 值是graphGUID属性string图形文件唯一标识否graphName属性string图形文件名称是graphURL属性string

27、图形文件地址是graphFormat属性string图形文件格式否mediaType属性string格式否size属性string图片大小(字节)否dataContent属性string内容描述否extendAttribute s集合extentionAttributeTyp e扩展属性集合否1.8 文稿类型1.8.1 属性说明属性含义类型说明必填scriptFileType对象无文稿类型是relationCode属性string标识（AndAudio、KeyFrame、HighLowBit等）否relationType属性string类型（/音频、/关键帧、高码/低码/转码等）否md5属性s

28、tring文件 MD5 值否scriptGUID属性string稿件的唯一标识，可用 GUID 表示否“relationType”：”string”,“md5”：”string”, “graphGUID”: “string”, “graphName”: “string”, “graphURI”: “string”, “graphFormat”: “string”, “mediaType”: “string”, “size”: “string”, “dataContent”: “string”, “extendAttributes”: 扩展属性集合1.8.2 属性格式#文稿格式“relation

29、Code”：”string”, “relationType”：”string”, “md5”：”string”,scriptTitle属性string稿件标题是scriptName属性string稿件名称是scriptURL属性string稿件地址否scriptFormat属性string稿件格式否mediaType属性string格式否size属性long稿件大小(字节)否version属性string稿件版本否type属性string稿件类型：选题稿件、通稿、栏目稿件、空标题否source属性string稿件来源：路透稿件、回传稿件等否author属性string发稿人否publishTi

30、me属性string发稿时间否broadcastTime属性string播出时间否wordCount属性string字数否content属性string稿件内容是extendAttribute s集合extentionAttribute Type扩展属性集合否1.9 其他文件类型1.9.1 属性说明属性含义类型说明必填“scriptGUID”: “string”,“scriptTitle”: “string”, “scriptName”: “string”, “scriptURI”: “string”, “scriptFormat”: “string”, “mediaType”: “strin

31、g”, “size”: long,“version”: “string”,“type”: “string”,“source”: “string”,“author”: “string”, “publishTime”: “string”, “broadcastTime”: “string”, “wordCount”: “string”, “content”: “string”,“tagItems”: 集合, “extendAttributes”: 扩展属性集合1.9.2 属性格式#其他文件格式“relationCode”：”string”, “relationType”：”string”, “md

32、5”：”string”, “fileGUID”: “string”, “fileName”: “string”, “fileURI”: “string”, “fileFormat”: “string”,otherFileType对象无其他文件类型是relationCod e属性string标识（AndAudio、KeyFrame、HighLowBit 等）否relationType属性string类型（/音频/关键帧、高码/低码/转码等）否md5属性string文件 MD5 值是fileGUID属性string文件唯一标识否fileName属性string文件名称是fileURL属性strin

33、g文件地址是fileFormat属性string文件格式否size属性string文件大小(字节)否dataContent属性string内容描述否extendAttrib utes集合extentionAttribute Type扩展属性集合否1.10 视音频出入点类型1.10.1 属性说明1.10.2 属性格式#出入点信息格式“markIn”: “string”,“markOut”: “string”, “markContent”: “string”属性含义类型说明必填markInfoType对象无出入点信息类型是markIn属性string入点否markOut属性string出点否mar

34、kConten t属性string标记内容否“size”: “string”,“dataContent”: “string”, “extendAttributes”: 扩展属性集合1.11 扩展属性类型1.11.1 属性说明1.11.2 属性格式第2章 调用说明2.1 概述欢迎使用荔枝云-PaaS平台云服务。用户可以使用本文档的 API 对荔枝云-PaaS 平台云服务进行相关操作。对于接口的首先要获取令牌，每次请求都需要令牌信息，如果超#扩展属性格式“itemCode”: “string”, “itemName”: “string”, “value”: “string”属性含义类型说明必填ex

35、tentionAttributeType对象无扩展属性类型是itemCode属性string扩展项标识否itemName属性string扩展项名称否value属性string扩展项取值否过两个小时没有使用，令牌信息将过期，需要重新申领令牌。对荔枝云-PaaS 平台接口调用是通过向荔枝云-PaaS 平台的服务端地址HTTPPOST 请求，并按照接口说明在请求中加入相应请求参数；根据请求的处理情况，系统会返回处理结果。2.2 请求结构说明2.2.1 请求地址荔枝云-PaaS 平台的服务接入地址规则：http:/公共参数接口地址地址由三部分组成：服务所提供的内容。公共参数：参考公共参数说明中的内容说

36、明，进行分配，用户调用接口时按分配的内容进行填写。接口地址：服务提供的内容。注：所有参数项必须传递，非必填项的值可为空，所有参数区分大小写。请求及返回结果都使用 UTF-8 字符集进行编码。2.2.2 公共参数2.2.3 地址示例获取令牌的接口地址。http:/appCode/versionId/companyId/userId/serviceCode/auth/token/getAccessToken/【第一部分】【第二部分】接口地址分为两个部分，第一部分是公共请求参数，必含项。第二部分是具体服务的接口地址。2.3 返回结果“code”:”,#状态码, 参照附录“message”:”,#描述

37、信息“data”:“key”:”value”,“key”:”value”#结果数据，详情查看各接口返回参数属性含义类型说明必填appCode应用标识String应用唯一标识（由荔枝云平台提供）是versionId版本号String接口版本号，当前版本号为 V1是companyId企业标识String企业唯一标识（由荔枝云平台提供）是userId用户标识String用户唯一标识（用户填充）是serviceCode服务类型标识String服务类型唯一标识（由荔枝云平台提供）是第3章 接口认证3.1 获取令牌3.1.1 功能描述荔枝云-PaaS 平台的服务会对每个的请求进行，需要在请求中带上令牌信息

38、。此接口是以 OAuth2.0 模式实现认证和。令牌的获取方式：用户传递的应用标识、版本号、企业标识、服务标识、密钥和时间戳生成相应的令牌，该令牌有效时长为 2 小时。3.1.2 接口地址auth/token/getAccessToken/3.1.3 请求参数参数含义格式说明是否必填AccessId应用标识String应用唯一标识（此标识由荔枝云平台提供）是AccessKey秘钥String秘钥（此秘钥由荔枝云平台提供）是VersionId版本号String版本号（默认为 V1）是CompanyId标识String唯一标识（此标识由荔枝云平台提供）是BusinessCode业务标识String

39、接口业务唯一标识（此标识由荔枝云平台提供）是TimeStamp时间戳String请求接口时，请求方当前时间毫秒数是3.1.4 返回参数3.1.5 请求示例3.1.6 返回示例“code”:“0”,POST/auth/token/getAccessToken/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-fo

40、rm-urlencoded Content-Length:XAccessId=paasapi&AccessKey=123456&VersionId=vms3.0&Co mpanyId=558bc0e50cf23f9d2e823060&BusinessCode=paasapi&TimeStamp= 2015-06-26 00:33:00属性含义类型说明AccessToken令牌String有时效性的令牌“message”:“”, “data”：“AccessToken”:”05784E32D86340D976677714905E6D53B2E041F124A3D1603BAAD66E21880EE5”第4章 媒资服务4.1 内容上传4.1.1 FTP 上传1)功能描述向用户提供 ftp 服务，供用户执行上传多文件。ftp 服务信息由荔枝云平台提供。用户首先将、音频、图片、文稿等类型通过 ftp 方式上传到指定目录；在进行时，对应的地址填写相对路径。例子一：上传 ftp 根目录下“文件.jsp”，时对于的地址填写：文件.jsp例子二：上传子目录 test 下子目录 test1 中的“文件.jsp”，在源地址填写：test/test1/文件.jsp2)接口地址ftp:/用户名:ip3