Commit 114a45b4a356906b517764de1f4e63327325977c

Authored by 张奎
1 parent f658443f

定义入库接口

12.内容库云/1.0 内容云入库接口.md 0 → 100644
  1 +/*
  2 +Title: 1.1 内容云入库接口
  3 +*/
  4 +
  5 +### 接口描述 ###
  6 +
  7 +
  8 +### 接口地址 ###
  9 +http://api.cnlive.com/open/api2/nry/add
  10 +
  11 +### 接口协议 ###
  12 +HTTP POST
  13 +
  14 +### 接口请求参数 ###
  15 +|参数名| 参数类型 | 必选 | 参数说明 |
  16 +|:----- | :------: | :------: | :------: |
  17 +|appId| string | true | 应用ID |
  18 +|source| string | true | 来源:mam、live、cms、ring7、chinaorg等 |
  19 +| uuid | string | true | 内容标识, 确保唯一来源下,此内容ID唯一,视讯云点播云用globalId,cms可用contentId。 |
  20 +| subUuid | string | false | 附属内容标识, 主要用于富文本的vtxt而言,即用此参数来区别,发布云为uuid,点播云为globalId |
  21 +| groupType | string | true | 组类型:program、richtxt等 |
  22 +| contentType | string | true | 内容类型:video、live、audio、pics、article等 |
  23 +| spId | string | true | |
  24 +| spName | string | false | |
  25 +| cpId | string | true | cp标识 |
  26 +| cpName | string | false | |
  27 +| status | string | true | 上线状态, 1=上线,0下线,-1为删除。(0和-1是支持内部生产的查询) |
  28 +| title | string | true | 内容标题 |
  29 +| subTitle | string | true | 内容副标题 |
  30 +| categoryId | string | true | 分类标识,全路径,用’\‘隔开 |
  31 +| categoryName | string | true | 全路径,用’\‘隔开 |
  32 +| editorId | string | false | 编辑标识 |
  33 +| editorName | string | false | 编辑名称 |
  34 +| keywords | string | false | 关键词 |
  35 +| pageUrl | string | false | 内容的页面地址 |
  36 +| description | string | false | 描述 |
  37 +| bodyContent | string | false | 文本内容,含html代码,传输时注意编码 |
  38 +| copyrightId | string | true | 版权标识,唯一标示,来自 统一的 内容版权管理系统(建议暂时editorid来标示) |
  39 +| imgJson | string | true | 图片:json格式 |
  40 +| director | string | false | 导演 |
  41 +| actors | string | false | 演员 |
  42 +| albumName | string | false | 专辑名称 |
  43 +| area | string | true | 地区 |
  44 +| year | string | true | 年代 |
  45 +| createTime | string | true | 创建时间 |
  46 +| publishTime | string | true | 发布时间 |
  47 +| verTimestamp | string | true | 时间戳版本 |
  48 +| weight | string | true | 权重, 取值:0 ~ 100 |
  49 +| extensions | string | true | 扩展字段:json格式 |
  50 +
  51 +
  52 +### 返回值 ###
  53 +
  54 +| 参数名 | 参数类型 | 必选 | 参数说明 |
  55 +| :-----------| :------: | :------: | :------: |
  56 +| errorCode| int | true | 错误类型号 |
  57 +| errorMessage| string | true | 错误类型 |
  58 +
  59 +请求JSON格式的节目元数据信息,json示例如下:
  60 +
  61 +``` json
  62 +{
  63 + "source":"mam",
  64 + "uuid":"82_17cbfede6f074db18d06fdeb170e41c4",
  65 + "subUuid":"82_17cbfede6f074db18d06fdeb170e41c4",
  66 + "groupType":"program",
  67 + "contentType":"video",
  68 + "spId":"82",
  69 + "spName":"视讯中国",
  70 + "cpId":"1",
  71 + "cpName":"",
  72 + "status":"1",
  73 + "title":"李雨桐风波后首度亮相心情好",
  74 + "subTitle":"李雨桐风波后心情好",
  75 + "categoryId":"001/123",
  76 + "categoryName":"娱乐/港台",
  77 + "editorId":"123",
  78 + "editorName":"李四",
  79 + "keywords":"刘德华/关之琳",
  80 + "pageUrl":"http://www.cnlive.com/yule/1234.html",
  81 + "description":"李雨桐风波后首度亮相心情好,风波后首度亮相心情好。",
  82 + "bodyContent":"",
  83 + "copyrightId":"1",
  84 + "director":"冯小刚",
  85 + "actors":"葛优",
  86 + "albumName":"专题1",
  87 + "area":"大陆",
  88 + "year":"90",
  89 + "createTime":"2017-10-12 11:12:01",
  90 + "publishTime":"1998-05-12 09:16:20",
  91 + "verTimestamp":"2017-10-12 11:12:01",
  92 + "weight":"60",
  93 + "extensions":{
  94 + "albumPrgCounts":"20",
  95 + "albumPrgSeqNo":"1",
  96 + "durationBySec":"209",
  97 + "language":"汉语"
  98 + },
  99 + "imgJson":[
  100 + {
  101 + "type":"titleImage",
  102 + "format":"316*506",
  103 + "url":"http://test.qnvod.cnlive.com/60/img/2017/0809/ff8080815dc0be57015dc4c1fe380061/000002.jpg?imageView2/1/w/316/h/506",
  104 + "desc":"图片介绍"
  105 + },
  106 + {
  107 + "type":"contentImage",
  108 + "format":"485*303",
  109 + "url":"http://test.qnvod.cnlive.com/60/img/2017/0809/ff8080815dc0be57015dc4c1fe380061/000002.jpg?imageView2/1/w/224/h/398",
  110 + "desc":"图片介绍"
  111 + }
  112 + ]
  113 +}
  114 +```
  115 +
  116 +返回JSON格式的节目元数据信息,json示例如下:
  117 +
  118 +``` json
  119 +{
  120 + "data":{
  121 + "uuid":"17cbfede6f074db18d06fdeb170e41c4",
  122 + "title":"一带一路特别节目"
  123 + },
  124 + "errorCode":0,
  125 + "errorMessage":"sucess"
  126 +}
  127 +```
0 128 \ No newline at end of file
... ...
12.内容库云/1.0 内容库查询接口.md renamed to 12.内容库云/1.1 内容云查询接口.md