OPEN-API / WIKI · Commits

Commit 49afe806f11c5b792b5a42364b4fd01aea223cdc

Authored by 张奎
1 parent 8e2eced2

修改接口定义

Inline Side-by-side
Showing 6 changed files with 146 additions and 17 deletions
12.内容库云/1.1.1 内容云入库接口_video_mam.md
  View file @49afe80
... ... @@ -14,12 +14,8 @@ HTTP POST
14 14 ### 接口请求参数 ###
15 15 |参数名| 参数类型 | 必选 | 参数说明 |
16 16 |:----- | :------: | :------: | :------: |
17   -|source| string | true | 来源：mam、live、cms、ring7、chinaorg等 |
18 17 | uuid | string | true | 内容标识, 确保唯一来源下，此内容ID唯一，视讯云点播云用globalId，cms可用contentId。 |
19 18 | subUuid | string | false | 附属内容标识, 主要用于富文本的vtxt而言，即用此参数来区别，发布云为uuid，点播云为globalId |
20   -| groupType | string | true | 组类型：program、richtxt等 ，内容分组：节目（来源于媒资库）、富文本（来自CMS或图片库等） |
21   -| contentType | string | true | 内容类型：video、live、audio、pics、article等 ，<br/>内容类型（需要设计6个小的icon，便于内容结果展示的标示）：<br/>节目分下含：video（默认1）、live、audio<br/>富文本含：article（默认0）、vtxt、spectxt、picstxt<br/>注意：某节目可能被检索2次，即一个video类型，一个vtxt类型。 |
22   -| spId | string | true | |
23 19 | spName | string | false | |
24 20 | cpId | string | true | cp标识 |
25 21 | cpName | string | false | |
... ... @@ -61,11 +57,8 @@ HTTP POST
61 57  
62 58 ``` json
63 59 {
64   - "source":"mam",
65 60 "uuid":"82_17cbfede6f074db18d06fdeb170e41c4",
66 61 "subUuid":"82_17cbfede6f074db18d06fdeb170e41c4",
67   - "groupType":"program",
68   - "contentType":"video",
69 62 "spId":"82",
70 63 "spName":"视讯中国",
71 64 "cpId":"1",
... ...
12.内容库云/1.1.2 内容云入库接口_video_live.md
  View file @49afe80
... ... @@ -14,11 +14,8 @@ HTTP POST
14 14 ### 接口请求参数 ###
15 15 |参数名| 参数类型 | 必选 | 参数说明 |
16 16 |:----- | :------: | :------: | :------: |
17   -|source| string | true | 来源：mam、live、cms、ring7、chinaorg等 |
18 17 | uuid | string | true | 内容标识, 确保唯一来源下，此内容ID唯一，视讯云点播云用globalId，cms可用contentId。 |
19 18 | subUuid | string | false | 附属内容标识, 主要用于富文本的vtxt而言，即用此参数来区别，发布云为uuid，点播云为globalId |
20   -| groupType | string | true | 组类型：program、richtxt等 ，内容分组：节目（来源于媒资库）、富文本（来自CMS或图片库等） |
21   -| contentType | string | true | 内容类型：video、live、audio、pics、article等 ，<br/>内容类型（需要设计6个小的icon，便于内容结果展示的标示）：<br/>节目分下含：video（默认1）、live、audio<br/>富文本含：article（默认0）、vtxt、spectxt、picstxt<br/>注意：某节目可能被检索2次，即一个video类型，一个vtxt类型。 |
22 19 | spId | string | true | |
23 20 | spName | string | false | |
24 21 | cpId | string | true | cp标识 |
... ... @@ -61,11 +58,8 @@ HTTP POST
61 58  
62 59 ``` json
63 60 {
64   - "source":"mam",
65 61 "uuid":"82_17cbfede6f074db18d06fdeb170e41c4",
66 62 "subUuid":"82_17cbfede6f074db18d06fdeb170e41c4",
67   - "groupType":"program",
68   - "contentType":"video",
69 63 "spId":"82",
70 64 "spName":"视讯中国",
71 65 "cpId":"1",
... ...
12.内容库云/1.1.3 内容云入库接口_video_cms.md
  View file @49afe80
1 1 /*
2   -Title: 1.1 内容云入库接口
  2 +Title: 1.1 内容云入库接口: 发布云向内容库云同步视频内容接口
3 3 */
4 4  
5 5 ### 接口描述 ###
... ... @@ -14,11 +14,8 @@ HTTP POST
14 14 ### 接口请求参数 ###
15 15 |参数名| 参数类型 | 必选 | 参数说明 |
16 16 |:----- | :------: | :------: | :------: |
17   -|source| string | true | 来源：mam、live、cms、ring7、chinaorg等 |
18 17 | uuid | string | true | 内容标识, 确保唯一来源下，此内容ID唯一，视讯云点播云用globalId，cms可用contentId。 |
19 18 | subUuid | string | false | 附属内容标识, 主要用于富文本的vtxt而言，即用此参数来区别，发布云为uuid，点播云为globalId |
20   -| groupType | string | true | 组类型：program、richtxt等 ，内容分组：节目（来源于媒资库）、富文本（来自CMS或图片库等） |
21   -| contentType | string | true | 内容类型：video、live、audio、pics、article等 ，<br/>内容类型（需要设计6个小的icon，便于内容结果展示的标示）：<br/>节目分下含：video（默认1）、live、audio<br/>富文本含：article（默认0）、vtxt、spectxt、picstxt<br/>注意：某节目可能被检索2次，即一个video类型，一个vtxt类型。 |
22 19 | spId | string | true | |
23 20 | spName | string | false | |
24 21 | cpId | string | true | cp标识 |
... ...
12.内容库云/1.1.5 内容云入库接口_video_ chinaorg.md renamed to 12.内容库云/1.1.5 内容云入库接口_video_chinaorg.md
  View file @49afe80
12.内容库云/3.0 获取分类树接口.md 0 → 100644
  View file @49afe80
  1 +/*
  2 +Title: 3.0 获取分类树接口
  3 +*/
  4 +
  5 +### 接口描述 ###
  6 +
  7 +根分类是常量，共有7个，每个SP都有,分别如下：电影100001电视剧100002;娱乐100004;资讯100008;体育100012;教育100016;其他100026
  8 +
  9 +### 接口地址 ###
  10 +http://api.cnlive.com/open/api2/...
  11 +
  12 +### 接口协议 ###
  13 +HTTP GET
  14 +
  15 +### 接口请求参数 ###
  16 +|参数名| 参数类型 | 必选 | 参数说明 |
  17 +|:----- | :------: | :------: | :------: |
  18 +|appId| string | true | 应用ID |
  19 +|spId| string | true | spId 不为空时返回指定SP下的分类树 |
  20 +|sign| String | true | 签名规则见 [签名详情] (http://help.open.cnlive.com/common.html) |
  21 +
  22 +### 返回值 ###
  23 +
  24 +| 参数名 | 参数类型 | 必选 | 参数说明 |
  25 +| :-----------| :------: | :------: | :------: |
  26 +| errorCode| int | true | 错误类型号 |
  27 +| errorMessage| string | true | 错误类型 |
  28 +| categoryId| int | true | 分类Id |
  29 +| categoryName| string | false | 分类名称 |
  30 +| parentId| int | false | 父分类Id |
  31 +
  32 +
  33 +返回JSON格式的节目元数据信息，json示例如下：
  34 +
  35 +``` json
  36 +{
  37 + "data":{
  38 + "categorys": [
  39 + {
  40 + "categoryId": 1000,
  41 + "categoryName": "娱乐",
  42 + "parentId": 0
  43 + },
  44 + {
  45 + "categoryId": 1234,
  46 + "categoryName": "娱乐",
  47 + "parentId": 1000
  48 + }
  49 + ]
  50 +
  51 + },
  52 + "errorCode":0,
  53 + "errorMessage":"sucess"
  54 +}
  55 +```
0 56 \ No newline at end of file
... ...
12.内容库云/3.1 获取点播列表接口Server.md 0 → 100644
  View file @49afe80
  1 +;/*
  2 +Title: 1.1 获取内容信息接口
  3 +*/
  4 +
  5 +### 接口描述 ###
  6 +
  7 +
  8 +### 接口地址 ###
  9 +http://api.cnlive.com/open/api2/...
  10 +
  11 +### 接口协议 ###
  12 +HTTP GET
  13 +
  14 +### 接口请求参数 ###
  15 +|参数名| 参数类型 | 必选 | 参数说明 |
  16 +|:----- | :------: | :------: | :------: |
  17 +|appId| string | true | 应用ID |
  18 +|categoryId| int | false | 分类Id,从分类树接口中取。 categoryId 和spId 不能同时为空 根分类7个是常量，每个SP都有,分别如下：电影100001电视剧100002;娱乐100004;资讯100008;体育100012;教育100016;其他100026|
  19 +|spIds| string | false | spId,可以传多个，以逗号隔开。 categoryId 和spId 不能同时为空 |
  20 +|page| string | false | 页号，如为空，默认值：1 |
  21 +|pageSize| string | false | 每页返回条数，如为空，默认值：20 |
  22 +|lastModify| long | false | 时间戳，返回最后修改时间在此时间之后的所有内容 |
  23 +|timestamp| int | true | 精确到秒，当前Unix时间戳，请保证请求服务器时间正确 |
  24 +|sign| String | true | 签名规则见 [签名详情] (http://console.open.cnlive.com/open/doc/sys/dianbo/t1/00.%E5%85%AC%E5%85%B1%E7%BB%84%E4%BB%B6/1.1%20SHA1%E7%AD%BE%E5%90%8D) |
  25 +
  26 +### 返回值 ###
  27 +
  28 +| 参数名 | 参数类型 | 必选 | 参数说明 |
  29 +| :-----------| :------: | :------: | :------: |
  30 +| errorCode| int | true | 错误类型号 |
  31 +| errorMessage| string | true | 错误类型 |
  32 +| uuid| string | true | 节目的唯一标识 |
  33 +| title| string | true | 节目标题 |
  34 +| subTitle| string | false | 节目副标题 |
  35 +| desc| string | false | 节目描述 |
  36 +| categoryId| int | true | 分类Id |
  37 +| categoryName| string | false | 分类名称 |
  38 +| tag| string | false | 标签，多个以 逗号分隔 |
  39 +| spId| int | false | 所属sp |
  40 +| createDate| string | true | 内容创建时间 |
  41 +| lastModify| string | true | 最后修改时间 |
  42 +| imgJson| map | false | 图片信息|
  43 +
  44 +返回JSON格式的节目元数据信息，json示例如下：
  45 +
  46 +``` json
  47 +{
  48 + "data":{
  49 + "programs":[ {
  50 + "uuid":"17cbfede6f074db18d06fdeb170e41c4",
  51 + "title":"大道之行一带一路",
  52 + "categoryId":123,
  53 + "categoryName":"资讯",
  54 + "desc":"一带一路特别节目",
  55 + "imgJson":{
  56 + "316*506":"http://test.qnvod.cnlive.com/60/img/2017/0809/ff8080815dc0be57015dc4c1fe380061/000002.jpg?imageView2/1/w/316/h/506",
  57 + "112*63":"http://test.qnvod.cnlive.com/60/img/2017/0809/ff8080815dc0be57015dc4c1fe380061/000002.jpg?imageView2/1/w/112/h/63"
  58 + },
  59 + "rates":"1,2",
  60 + "spId":60,
  61 + "subTitle":"",
  62 + "tag":"丝绸之路,一带一路,文化交流,中华文化",
  63 + "createDate":"2017-09-20 12:30:34",
  64 + "lastModify":"2017-09-21 12:30:34"
  65 + },
  66 + {
  67 + "uuid":"17cbfede6f074db18d06fdeb170e41c4",
  68 + "title":"大道之行一带一路",
  69 + "categoryId":123,
  70 + "categoryName":"资讯",
  71 + "desc":"一带一路特别节目",
  72 + "imgJson":{
  73 + "316*506":"http://test.qnvod.cnlive.com/60/img/2017/0809/ff8080815dc0be57015dc4c1fe380061/000002.jpg?imageView2/1/w/316/h/506",
  74 + "112*63":"http://test.qnvod.cnlive.com/60/img/2017/0809/ff8080815dc0be57015dc4c1fe380061/000002.jpg?imageView2/1/w/112/h/63"
  75 + },
  76 + "rates":"1,2",
  77 + "spid":60,
  78 + "subTitle":"",
  79 + "tag":"丝绸之路,一带一路,文化交流,中华文化",
  80 + "createDate":"2017-09-20 12:30:34",
  81 + "lastModify":"2017-09-21 12:30:34"
  82 + }
  83 +
  84 + ]
  85 +
  86 + },
  87 + "errorCode":0,
  88 + "errorMessage":"sucess"
  89 +}
  90 +```
0 91 \ No newline at end of file
... ...