OPEN-API / WIKI · Commits

Commit de6c3c0f576b4a68693bb155f953944ad92c3ece

Authored by 国亚奇
2 parents f5934271 ea251574

Merge remote-tracking branch 'master/master'

Inline Side-by-side
Showing 12 changed files with 224 additions and 14 deletions
02.直播云/1.0 获取直播活动信息接口Server.md
  View file @de6c3c0
... ... @@ -28,7 +28,7 @@ HTTP GET
28 28 | errorMessage| string | true | 错误类型 |
29 29 | activityId| string | true | 活动ID，确保SP下的唯一性 |
30 30 | activityName | string | true | 活动名称 |
31   -| activityStatus | int | true | 活动状态，0：未开始 ／1：已开始 ／3：已结束 ／4 已下线，默认为0 |
  31 +| activityStatus | int | true | 活动状态，-2：活动异常 / 0：未开始 ／1：已开始 ／3：已结束 ／4 已下线，默认为0 |
32 32 | isHorizontalScreen | int | true | 屏幕方向，0：垂直即竖屏 ／1：水平即横屏 ，默认为1 ｜
33 33 | channelId | string | true | 播放通道；PGC业务：平台分配／ UGC业务：主播ID生成，确保SP下的唯一性 |
34 34 | createTime | string | false | 开始时间，格式yyyyMMddHHmmss |
... ...
02.直播云/1.1 获取直播活动信息接口APP.md
  View file @de6c3c0
... ... @@ -29,7 +29,7 @@ HTTP GET
29 29 | errorMessage| string | true | 错误类型 |
30 30 | activityId| string | true | 活动ID，确保SP下的唯一性 |
31 31 | activityName | string | true | 活动名称 |
32   -| activityStatus | int | true | 活动状态，0：未开始 ／1：已开始 ／3：已结束 ／4 已下线，默认为0 |
  32 +| activityStatus | int | true | 活动状态，-2:活动异常 / 0：未开始 ／1：已开始 ／3：已结束 ／4 已下线，默认为0 |
33 33 | isHorizontalScreen | int | true | 屏幕方向，0：垂直即竖屏 ／1：水平即横屏 ，默认为1 ｜
34 34 | channelId | string | true | 播放通道；PGC业务：平台分配／ UGC业务：主播ID生成，确保SP下的唯一性 |
35 35 | createTime | string | false | 开始时间，格式yyyyMMddHHmmss |
... ...
02.直播云/2.4 回调接口.md
  View file @de6c3c0
... ... @@ -28,7 +28,6 @@
28 28 | coverImgUrl | string(512) | false | 活动封面 |
29 29 | activityCategory | string | false | 活动分类ID，999 -未知/001 发布会／002 婚礼／003 年会 ／004 体育／005 游戏／006 旅游&户外／007 财经／008 演唱会／009 烹饪／010 宠物&动物／011 访谈／012 教育／013 竞技／014 剧场／015 晚会／016 电视节目／017 秀场 |
30 30 | extensions | string(text) | false | 扩展字段，参数格式为Map对象的Json字符串（主播昵称、头像、） |
31   -| columnId | string | false | 栏目ID |
32 31 | showType | int | false | 显示类型，1;//图片2;//预告片3;//直播4;//回放 |
33 32 | vId | String | false | 显示类型2;预告片4;回放 时，点播内容标识 |
34 33  
... ...
02.直播云/2.5 主播认证申请接口.md
  View file @de6c3c0
1 1 #### 请求参数说明:
  2 +
  3 + > recentPic recentPic2 recentPic3 为文件上传
  4 +
  5 + > 该接口涉及文件上传，请求设置 content-type:multipart/form-data
  6 +
2 7 | 参数名 | 参数类型 | 必选 | 参数说明 |
3 8 | :-----------: | :------: | :------: | :------: |
4 9 | appId | String | true | 应用ID |
... ... @@ -7,9 +12,9 @@
7 12 | face | String | true | 主播头像地址 |
8 13 | name | String | false | 主播实名 |
9 14 | idCard | String | false | 主播身份证号 |
10   -| recentPic | String | false | 主播对照照片(正)|
11   -| recentPic2 | String | false | 主播对照照片(反)|
12   -| recentPic3 | String | false | 主播对照照片（手持)|
  15 +| recentPic | file | false | 主播对照照片(正)|
  16 +| recentPic2 | file | false | 主播对照照片(反)|
  17 +| recentPic3 | file | false | 主播对照照片（手持)|
13 18 | mobile | String | false | 主播手机号 |
14 19 | callback | String | false | 主播审核结果通知地址 |
15 20 | tag | String | false | 分类标签 |
... ...
02.直播云/2.6 主播认证申请接口4APP.md 0 → 100644
  View file @de6c3c0
  1 +#### 请求参数说明:
  2 +
  3 + > recentPic recentPic2 recentPic3 为文件上传
  4 +
  5 + > 该接口涉及文件上传，请求设置 content-type:multipart/form-data
  6 +
  7 +| 参数名 | 参数类型 | 必选 | 参数说明 |
  8 +| :-----------: | :------: | :------: | :------: |
  9 +| appId | String | true | 应用ID |
  10 +|platform_id|String|true|APP bundleID 或 包名，平台做鉴权使用|
  11 +| channelId | String | true | 主播标识（业务系统确保唯一，不能包含_字符） |
  12 +| channelName | String | true | 主播昵称 |
  13 +| face | String | true | 主播头像地址 |
  14 +| name | String | false | 主播实名 |
  15 +| idCard | String | false | 主播身份证号 |
  16 +| recentPic | file | false | 主播对照照片(正)|
  17 +| recentPic2 | file | false | 主播对照照片(反)|
  18 +| recentPic3 | file | false | 主播对照照片（手持)|
  19 +| mobile | String | false | 主播手机号 |
  20 +| callback | String | false | 主播审核结果通知地址 |
  21 +| tag | String | false | 分类标签 |
  22 +| sign | String | true | 签名 |
  23 +-----
  24 +#### 返回格式说明:
  25 +```
  26 +{
  27 + "errorCode": "0",
  28 + "errorMessage": "成功"
  29 +}
  30 +
  31 +```
0 32 \ No newline at end of file
... ...
02.直播云/2.6 主播认证通知.md renamed to 02.直播云/2.7 主播认证通知.md
  View file @de6c3c0
03.发布云/5.1 全文检索增量检索接口.md 0 → 100644
  View file @de6c3c0
  1 +/* Title: 5.1 全文检索增量检索接口 */
  2 +### 全文检索增量检索接口
  3 +-----
  4 +#### URL:http://so.cnlive.com/zgw/so/incsearch
  5 +-----
  6 +#### 请求方式: GET
  7 +-----
  8 +#### 参数说明:
  9 +<table class="table table-bordered table-striped table-condensed">
  10 + <tr>
  11 + <th>参数</th>
  12 + <th>必选</th>
  13 + <th>类型</th>
  14 + <th>说明</th>
  15 + </tr>
  16 + <tr>
  17 + <td>spid</td>
  18 + <td>false</td>
  19 + <td>string</td>
  20 + <td>服务商ID</td>
  21 + </tr>
  22 + <tr>
  23 + <td>searchSpid</td>
  24 + <td>false</td>
  25 + <td>string</td>
  26 + <td>内容spid筛选字段</td>
  27 + </tr>
  28 + <tr>
  29 + <td>columnid</td>
  30 + <td>false</td>
  31 + <td>string</td>
  32 + <td>栏目ID</td>
  33 + </tr>
  34 + <tr>
  35 + <td>type</td>
  36 + <td>false</td>
  37 + <td>string</td>
  38 + <td>内容类型 点播视频：program 活动直播:album 网页：web</td>
  39 + </tr>
  40 + <tr>
  41 + <td>page</td>
  42 + <td>false</td>
  43 + <td>int</td>
  44 + <td>页码，默认1</td>
  45 + </tr>
  46 + <tr>
  47 + <td>pagesize</td>
  48 + <td>false</td>
  49 + <td>int</td>
  50 + <td>分页大小 默认18</td>
  51 + </tr>
  52 + <tr>
  53 + <td>timestamp</td>
  54 + <td>true</td>
  55 + <td>string</td>
  56 + <td>上一次请求返回的时间戳(精确到毫秒)</td>
  57 + </tr>
  58 +</table>
  59 +
  60 +-----
  61 +#### 返回格式说明:
  62 +```
  63 +{
  64 + errorCode:"0",
  65 + errorMsg:"成功",
  66 + data:{
  67 + programs:[{
  68 + mediaId: "3_b62b7829cc394cffa04449a651dd42e5",
  69 + subTitle: "",
  70 + title: "闫妮称虐待肖央有快感",
  71 + duration:"123", // 单位毫秒
  72 + description: "@TV娱乐前线：《情圣》18日举行媒体见面会，闫妮黑裙亮相，还自曝虐待肖央有快感。",
  73 + columnID: "movie/dianying/qinggandapian/",
  74 + lastModifyDate: "2016-12-19 10:10:30",
  75 + type: "web",
  76 + posterUrl: "http://y3.cnliveimg.com:8080/image/itv/2016/1219/b62b7829cc394cffa04449a651dd42e5_171185_135.jpg",
  77 + spID: "3",
  78 + contentID: "782094",
  79 + appID: "3_it8a4s3k14"
  80 + },...],
  81 + page: 1,
  82 + pagesize: 18,
  83 + totalRow: 16746,
  84 + latest_timestamp: 1482113431017,
  85 + totalPage: 931
  86 + }
  87 +}
  88 +
  89 +
  90 +```
0 91 \ No newline at end of file
... ...
03.发布云/5.2 sp内容同步推荐接口.md 0 → 100644
  View file @de6c3c0
  1 +/* Title: 5.2 sp内容同步推荐接口 */
  2 +### sp内容同步推荐接口
  3 +-----
  4 +#### URL:http://icms.open.cnlive.com/icms_service/api/syncProgram
  5 +-----
  6 +#### 请求方式: GET/POST
  7 +-----
  8 +#### 参数说明:
  9 +<table class="table table-bordered table-striped table-condensed">
  10 + <tr>
  11 + <th>参数</th>
  12 + <th>必选</th>
  13 + <th>类型</th>
  14 + <th>说明</th>
  15 + </tr>
  16 + <tr>
  17 + <td>appId</td>
  18 + <td>true</td>
  19 + <td>string</td>
  20 + <td>服务商应用 ID</td>
  21 + </tr>
  22 + <tr>
  23 + <td>content</td>
  24 + <td>true</td>
  25 + <td>string</td>
  26 + <td>内容json字符串</td>
  27 + </tr>
  28 + <tr>
  29 + <td>sign</td>
  30 + <td>true</td>
  31 + <td>string</td>
  32 + <td></td>
  33 + </tr>
  34 +
  35 +</table>
  36 +
  37 +-----
  38 +#### 单条内容 content JSON说明:
  39 +```
  40 +content:{
  41 + contentId:"121", //内容id 必填
  42 + title:"我们都是好青年",//标题 必填
  43 + subTitle:"好青年",//副标题 非必填
  44 + contentType:"AL", //内容类型 必填 活动:AL;点播视频:VI;文章:AR;专题:SP
  45 + author:"某某",//作者 非必填
  46 + airTime:"2015",//播放年代 非必填
  47 + status:1, //内容状态 非必填 默认1 上线:1 下线:2
  48 + area:"美国" //地区 非必填 多个地区以顿号分割 非必填
  49 + description:"哈哈哈。。。。",//描述 非必填
  50 + duration:0,播放时长 (内容类型为VI 必填)
  51 + mapperColumn:"ent/", //中国网+栏目id 必填
  52 + pageUrl:"http://www.cnlive.com", //web内容页面链接地址 必填
  53 + tags:"娱乐、前沿",//标签,多个标签以顿号分割 非必填
  54 + posterImg:"http://y2.cnliveimg.com:8080/image/itv/2016/1031/227de2faddc74f5cbb4a775c404e2ce7_158168_100.jpg",//内容封面 必填
  55 + vipFlag:0,//收费表示 非必填 默认免费 免费:0 收费:1
  56 + albumStatus:0,//活动状态 (类型为AL 时 必填) 预告海报:0 预告视频:1 直播:2 回放视频:3
  57 + coordinate:"30.6508298703,104.0757373249", //内容发生地经纬度 非必填 默认sp的办公地点经纬度
  58 + address:"上海",//发生地详细地址 非必填 默认sp公司地址
  59 +}
  60 +```
  61 +-----
  62 +#### 返回 JSON说明:
  63 +```
  64 +{
  65 + errorCode:0,
  66 + errorMsg:"同步成功"
  67 +}
  68 +
  69 +{
  70 + errorCode:1,
  71 + errorMsg:"异常信息"
  72 +}
  73 +```
0 74 \ No newline at end of file
... ...
04.用户云/1.7 设备号登录.md
  View file @de6c3c0
... ... @@ -45,13 +45,13 @@
45 45 "errorCode": "0",
46 46 "errorMessage": "成功",
47 47 "data": {
48   - "uid": "10000000",
49   - "nickName": "lili_241",
  48 + "uid": "10290551",
  49 + "nickName": "游客_8869877099",
50 50 "gender": "n",
51 51 "location": "",
52 52 "faceUrl": "http://120.92.63.41:8080/mobile/images/mobilehead/default/face_60X60.jpg",
53 53 "mobile": "",
54   - "email": "lili@cnlive.com",
  54 + "email": "",
55 55 "extInfo": "",
56 56 "qqUid": "",
57 57 "wxUid": "",
... ... @@ -66,6 +66,10 @@
66 66 "errorMessage": "请求参数无效"
67 67 }
68 68 {
  69 + "errorCode": "41048",
  70 + "errorMessage": "UUID无效"
  71 +}
  72 +{
69 73 "errorCode": "41005",
70 74 "errorMessage": "ClientPlat无效"
71 75 }
... ...
04.用户云/2.3 修改用户单项信息.md
  View file @de6c3c0
... ... @@ -28,7 +28,7 @@
28 28 <td>value</td>
29 29 <td>true</td>
30 30 <td>string</td>
31   - <td>对应的信息</td>
  31 + <td>对应的信息，性别，m：男、f：女、n：未知</td>
32 32 </tr>
33 33 <tr>
34 34 <td>clientPlat</td>
... ...
06.支付云/1.9 支付异步通知.md
  View file @de6c3c0
... ... @@ -146,5 +146,10 @@
146 146 </table>
147 147  
148 148 <p class="text-danger">
149   - 收到通知后，应返回 success
150   - </p>
151 149 \ No newline at end of file
  150 + 收到通知后，应返回 success <br>
  151 +</p>
  152 +
  153 +```java
  154 +//java 示例
  155 +response.getOutputStream().write("success".getBytes());
  156 +```
152 157 \ No newline at end of file
... ...
06.支付云/3.1 预支付-预支付订单.md
  View file @de6c3c0
... ... @@ -179,7 +179,9 @@
179 179 <tr>
180 180 <td>wx_app</td>
181 181 <td>
182   - 微信APP支付时返回<br>
  182 + 微信 APP支付时返回<br>
  183 + <a href="https://pay.weixin.qq.com/wiki/doc/api/app/app.php?chapter=8_5">官方说明</a> <br>
  184 + 安卓关键词package无法解析时可以硬编码 package="Sign=WXPay"<br>
183 185 <pre>{
184 186 "appid":"wxbcb43c2700e6b3",
185 187 "partnerid":"12490201",
... ... @@ -187,7 +189,7 @@
187 189 "package":"Sign=WXPay",
188 190 "noncestr":"1e7b27aa9a05427f86bead84c94d8969",
189 191 "timestamp":"1436237889",
190   - "sign":"319FB3D895474EABB608AC106198AEB6"
  192 + "\s\i\g\n":"319FB3D895474EABB608AC106198AEB6"
191 193 }
192 194 </pre>
193 195 </td>
... ... @@ -196,6 +198,7 @@
196 198 <td>alipay_app</td>
197 199 <td class="nosign">
198 200 支付宝APP支付时返回<br>
  201 + <a href="https://doc.open.alipay.com/docs/doc.htm?spm=a219a.7629140.0.0.hk6vBg&treeId=59&articleId=103663&docType=1">官方说明</a> <br>
199 202 <pre>"
200 203 _input_charset=\"utf-8\"
201 204 &amp;service=\"mobile.securitypay.pay\"
... ...