Commit 458392264f1388d951a76d1496976b9a154b1bd2
1 parent
811f8481
w
Showing
1 changed file
with
83 additions
and
26 deletions
02.直播云/1.9 SP对应直播活动列表接口4APP.md
| 1 | -#### 请求参数说明: | |
| 1 | +#### 请求接口 | |
| 2 | + http://api.cnlive.com/open/api2/live_epg/sp/activityList4App | |
| 3 | +#### 请求方式 GET | |
| 2 | 4 | |
| 3 | - > recentPic recentPic2 recentPic3 为文件上传 | |
| 4 | - | |
| 5 | - > 该接口涉及文件上传，请求设置 content-type:multipart/form-data | |
| 5 | +#### 请求参数 | |
| 6 | +|参数名|类型|是否必填|说明| | |
| 7 | +|:--- |:--- |:--- |:--- | | |
| 8 | +|appId|String|true|应用标识| | |
| 9 | +|activityStatus|int|false|活动状态：默认空；0：未开始；1：直播中；2：已结束| | |
| 10 | +|pageNo|int|false|当前页；默认1| | |
| 11 | +|pageSize|int|false|每页个数；默认15| | |
| 12 | +| timestamp | int | true | 精确到秒，当前Unix时间戳，请保证请求服务器时间正确 | | |
| 13 | +| platform_id | String | true | APP bundleID 或 包名，平台做鉴权使用 | | |
| 14 | +| sign | String | true | 签名规则见 [签名详情] (http://help.open.cnlive.com/common.html) | | |
| 6 | 15 | |
| 7 | -| 参数名 | 参数类型 | 必选 | 参数说明 | | |
| 8 | -| :-----------: | :------: | :------: | :------: | | |
| 9 | -| appId | String | true | 应用ID | | |
| 10 | -| channelId | String | true | 主播标识（业务系统确保唯一，不能包含_字符） | | |
| 11 | -| channelName | String | true | 主播昵称 | | |
| 12 | -| face | String | true | 主播头像地址 | | |
| 13 | -| name | String | false | 主播实名 | | |
| 14 | -| idCard | String | false | 主播身份证号 | | |
| 15 | -| recentPic | file | false | 主播对照照片(正)| | |
| 16 | -| recentPic2 | file | false | 主播对照照片(反)| | |
| 17 | -| recentPic3 | file | false | 主播对照照片（手持)| | |
| 18 | -| mobile | String | false | 主播手机号 | | |
| 19 | -| callback | String | false | 主播审核结果通知地址 | | |
| 20 | -| tag | String | false | 分类标签 | | |
| 21 | -| sign | String | true | 签名 | | |
| 22 | ------ | |
| 23 | -#### 返回格式说明: | |
| 24 | -``` | |
| 16 | +#### 返回结果 | |
| 17 | + > data属性说明 | |
| 18 | + | |
| 19 | +|属性名|类型|说明| | |
| 20 | +|:--- |:--- |:--- | | |
| 21 | +|totalCount|int|总个数| | |
| 22 | +|nextCursor|int|下页页码，0表示没有下一页| | |
| 23 | +|preCursor|int|上页页码，0表示没有上一页| | |
| 24 | +| activityId| string | 活动ID，确保SP下的唯一性 | | |
| 25 | +| activityName | string | 活动名称 | | |
| 26 | +| activityStatus | int | 活动状态，-2:活动异常 / 0：未开始 ／1：已开始 ／3：已结束 ／4 已下线，默认为0 | | |
| 27 | +| isHorizontalScreen | int | 屏幕方向，0：垂直即竖屏 ／1：水平即横屏 ，默认为1 ｜ | |
| 28 | +| channelId | string | 播放通道；PGC业务：平台分配／ UGC业务：主播ID生成，确保SP下的唯一性 | | |
| 29 | +| createTime | string | 开始时间，格式yyyyMMddHHmmss | | |
| 30 | +| startTime | string | 开始时间，格式yyyyMMddHHmmss | | |
| 31 | +| endTime | string | 开始时间，格式yyyyMMddHHmmss | | |
| 32 | +| coverImgUrl | string | 活动封面 | | |
| 33 | +| activityCategory | string | 活动分类ID | | |
| 34 | +| extensions | string | false | 扩展字段，参数格式为Map对象的Json字符串 （主播昵称、头像等等） | | |
| 35 | +| rates | string | ture |清晰度标识，多个用逗号隔开： 流畅版=1，清晰版=2，高清版=3，超高清=4 | | |
| 36 | + | |
| 37 | +```json | |
| 25 | 38 | { |
| 26 | - "errorCode": "0", | |
| 27 | - "errorMessage": "成功" | |
| 39 | + "data": { | |
| 40 | + "totalCount": 3, | |
| 41 | + "nextCursor": 0, | |
| 42 | + "activityList": [ | |
| 43 | + { | |
| 44 | + "startTime": "20170318112832", | |
| 45 | + "isHorizontalScreen": 1, | |
| 46 | + "activityId": "60_1212121212", | |
| 47 | + "createTime": "20170318113354", | |
| 48 | + "channelId": "60_wowza1", | |
| 49 | + "activityStatus": 2, | |
| 50 | + "rates": "2", | |
| 51 | + "endTime": "20170318113353", | |
| 52 | + "extensions": "", | |
| 53 | + "activityName": "wowza测试的直播活动" | |
| 54 | + }, | |
| 55 | + { | |
| 56 | + "startTime": "20170313163412", | |
| 57 | + "isHorizontalScreen": 1, | |
| 58 | + "activityId": "60_144535e28dee42669c0454f38446afa5", | |
| 59 | + "createTime": "20170313163536", | |
| 60 | + "coverImgUrl": "http://uimg.cnliveimg.com/image/bk/test2017/03/13/1489394058538_4537.jpg", | |
| 61 | + "channelId": "60_wowza1", | |
| 62 | + "activityStatus": 2, | |
| 63 | + "rates": "2", | |
| 64 | + "activityCategory": "yule/", | |
| 65 | + "endTime": "20170313163535", | |
| 66 | + "extensions": "", | |
| 67 | + "activityName": "test3" | |
| 68 | + }, | |
| 69 | + { | |
| 70 | + "startTime": "20170306190610", | |
| 71 | + "isHorizontalScreen": 1, | |
| 72 | + "activityId": "60_60adfadfasdfadsf", | |
| 73 | + "createTime": "20170306171659", | |
| 74 | + "channelId": "60_wowza1", | |
| 75 | + "activityStatus": 0, | |
| 76 | + "rates": "2", | |
| 77 | + "endTime": "", | |
| 78 | + "extensions": "", | |
| 79 | + "activityName": "wowza活动测试" | |
| 80 | + } | |
| 81 | + ], | |
| 82 | + "preCursor": 0 | |
| 83 | + }, | |
| 84 | + "errorCode": "0", | |
| 85 | + "errorMessage": "获取主播活动列表成功" | |
| 28 | 86 | } |
| 29 | - | |
| 30 | -``` | |
| 31 | 87 | \ No newline at end of file |
| 88 | +``` | ... | ... |