no message (c66c3a34) | Commits | OPEN-API / WIKI

Browse Code »

Commit c66c3a34ef3f68ce23cdeb4a96e21315ee09d46c

Authored by 刘炯 2018-03-07 15:20:54 +0800

1 parent 6d938685

no message

Inline Side-by-side

Showing 1 changed file with 101 additions and 0 deletions

13.内容分发云/2.1 获取内容列表接口.md 0 → 100644

View file @c66c3a3

	1	+;/*
	2	+Title: 1.1 获取内容信息接口
	3	+*/
	4	+
	5	+### 接口描述 ###
	6	+
	7	+### 接口协议 ###
	8	+HTTP GET
	9	+
	10	+### 接口请求参数###
	11	+\|参数名\| 参数类型 \| 必选 \| 参数说明 \|
	12	+\|:----- \| :------: \| :------: \| :------: \|
	13	+\|appId\| string \| true \| 应用ID \|
	14	+\|page\| int \| false \| 页号，如为空，默认值：1 \|
	15	+\|pageSize\| int \| false \| 每页返回条数，如为空，默认值：20 \|
	16	+\|verTimestamp\| long \| false \| 时间戳时间毫秒值，返回最后修改时间在此时间之后的所有内容 \|
	17	+\| groupType \| string \| false \| 内容分组：program（视音频）、richtxt（非视音频）等；\|
	18	+\| categoryName \| string \| false \| 分类名称 \|
	19	+\|timestamp\| int \| true \| 精确到秒，当前Unix时间戳，请保证请求服务器时间正确，该时间用于签名\|
	20	+\|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) \|
	21	+
	22	+### 返回值 ###
	23	+
	24	+\| 参数名 \| 参数类型 \| 必选 \| 参数说明 \|
	25	+\| :-----------\| :------: \| :------: \| :------: \|
	26	+\| errorCode\| int \| true \| 错误类型号 \|
	27	+\| errorMessage\| string \| true \| 错误类型 \|
	28	+\| totalNum\| long \| true \| 总条数 \|
	29	+\| nextCursor\| long \| true \| 下一页 \|
	30	+\| previousCursor\| long \| true \| 上一页 \|
	31	+\| uuid\| string \| true \| 内容的唯一标识 \|
	32	+\| title\| string \| true \| 内容标题 \|
	33	+\| subTitle\| string \| false \| 内容副标题 \|
	34	+\| desc\| string \| false \| 内容描述 \|
	35	+\| categoryId\| string \| true \| 分类Id \|
	36	+\| categoryName\| string \| false \| 分类名称 \|
	37	+\| tag\| string \| false \| 标签，多个以逗号分隔 \|
	38	+\| rates\| string \| true \| 仅对视频码率格式，多种码率用逗号隔开，码率分别定义为：1：流畅；2：清晰；3：高清；4：超清 \|
	39	+\| cpName\| string \| true \| 所属cp, 没有所属CP的，用SPName代替 \|
	40	+\| createDate\| string \| true \| 内容创建时间 \|
	41	+\| verTimestamp\| long \| true \| 最后修改时间,时间戳时间毫秒值 \|
	42	+\| img\| map \| false \| 内容图片信息\|
	43	+\| groupImg\| map \| false \|组图图片信息，仅对组图内容有效\|
	44	+\| groupType \| string \| true \| 内容分组：program（视音频）、richtxt（非视音频）等； \|
	45	+\| contentType \| string \| true \| program内容类型：video、live、audio;richtxt内容类型pics、article、vtxt、spectxt、picstxt<br/>注意：某节目可能被检索2次，即一个video类型，一个vtxt类型。 \|
	46	+\| bodyContent \| string \| false \| 富文本内容 \|
	47	+
	48	+
	49	+返回JSON格式的节目元数据信息，json示例如下：
	50	+
	51	+``` json
	52	+{
	53	+ "errorCode": 0,
	54	+ "errorMessage": "成功",
	55	+ "data": {
	56	+ "programs": [
	57	+ {
	58	+ "uuid": "60_d57ad6f690cd4d4899cf56eb32512c19",
	59	+ "title": "黄家驹宣传片",
	60	+ "categoryId": "100001/72/73",
	61	+ "categoryName": "电影/喜剧/电影喜剧子分类",
	62	+ "desc": "黄家驹宣传片",
	63	+ "img": [
	64	+ {
	65	+ "format": "485*303",
	66	+ "url": "http://y2017.qn.cnliveimg.com/60/img/2017/0818/ff8080815def9dcb015df428048800e6/000006.jpg?imageView2/1/w/485/h/303",
	67	+ },
	68	+ {
	69	+ "format": "224*126",
	70	+ "url": "http://y2017.qn.cnliveimg.com/60/img/2017/0818/ff8080815def9dcb015df428048800e6/000006.jpg?imageView2/1/w/224/h/126",
	71	+ }
	72	+ ],
	73	+ "groupImg":[
	74	+ {
	75	+ "imgInfo":[
	76	+ {
	77	+ "format": "224*126",
	78	+ "url": "http://y2017.qn.cnliveimg.com/60/img/2017/0818/ff8080815def9dcb015df428048800e6/000006.jpg?imageView2/1/w/224/h/126"
	79	+ },
	80	+ {
	81	+ "format": "640*320",
	82	+ "url": "http://y2017.qn.cnliveimg.com/60/img/2017/0818/ff8080815def9dcb015df428048800e6/000006.jpg?imageView2/1/w/224/h/126"
	83	+ }
	84	+ ]
	85	+ "desc": ""
	86	+ }
	87	+ ]
	88	+ "rates": "2",
	89	+ "cpName": "测试账号",
	90	+ "subTitle": "",
	91	+ "tag": "黄家驹宣传片",
	92	+ "createDate": "2017-08-18",
	93	+ "verTimestamp": 1508320723191
	94	+ }
	95	+ ],
	96	+ "totalNum": 1,
	97	+ "nextCursor": 0,
	98	+ "previousCursor": 0
	99	+ }
	100	+}
	101	+```
0	102	\ No newline at end of file
...	...

OPEN-API / WIKI · Commits

GitLab

no message