Merge remote-tracking branch 'origin/master'

javazhengchao@163.com
2 parents 4e8d3aaa 851ae07a
Showing 7 changed files with 381 additions and 1 deletions
01.点播云/1.01 播放器获取EPG信息接口.md
02.直播云/1.01 播放器获取EPG信息接口.md
04.用户云/1.1 第三方登录.md
04.用户云/2.9 找回或修改密码前校验手机验证码.md
04.用户云/3.2 找回或修改密码前发激活邮件.md
04.用户云/3.3 通过邮箱修改密码.md
04.用户云/3.4 获取App注册协议.md
+/*
+Title: 1.01 播放器获取点播信息接口
+*/
+
+### 接口描述 ###
+
+
+### 接口地址 ###
+http://api.cnlive.com/open/api2/vod_epg/getVodInfo4Player
+
+### 接口协议 ###
+HTTP GET
+
+### 接口请求参数 ###
+|参数名| 参数类型 | 必选 | 参数说明 |  
+|:----- | :------: | :------: | :------: |  
+|appId| string | true | 应用ID   |  
+|vId| string | true | 点播节目标识(直播回放的vId就是创建直播活动时的activityId) |
+|uid| string | false   | 用户标识（uuid_时间戳)   |  
+|sid| String | false | 用户ID  |
+|retry| int | false | 重试次数，在0~4之间累加  |
+|isHLS| int | false | 0：mp4流，1：hls流(默认1)  |
+
+### 返回值  ###
+
+| 参数名 | 参数类型 | 必选 | 参数说明 |  
+| :-----------| :------: | :------: | :------: |  
+| errorCode| int | true   | 错误类型号   |  
+| errorMessage| string | true   | 错误信息 |
+| title| string | true   | 节目标题 |
+| subTitle| string | false   | 节目副标题 |
+| status| string | true   | 节目状态，1：上线，2：下线 |
+| vId| string | true   | 节目的唯一标识 |
+| videoUrl_1 | string | false   |播放地址 流畅版 |
+| videoUrl_2 | string | true   |播放地址  清晰版 |
+| videoUrl_3 | string | false   |播放地址 高清版 |
+| videoUrl_4 | string | false   |播放地址 超高清 |
+
+返回JSON格式的节目元数据信息，json示例如下：
+
+``` json
+{
+    "errorMessage":"请求成功",
+    "data":{
+        "status":"1",
+        "vId":"174e6c5f3d9e4ddeb739feed1906fa11",
+        "subTitle":"BTOB对粉丝甜喊：我想你们了",
+        "title":"BTOB甜喊：我想你们了",
+        "videoUrl_1":"*****",
+        "videoUrl_2":"*****",
+        "videoUrl_3":"*****",
+        "videoUrl_4":"*****"
+    },
+    "errorCode":"0"
+}
+```
 \ No newline at end of file
+/*
+Title: 1.01 播放器获取直播信息接口
+*/
+
+### 接口描述 ###
+
+
+### 接口地址 ###
+http://api.cnlive.com/open/api2/live_epg/getChannelInfo4Player
+
+### 接口协议 ###
+HTTP GET
+
+### 接口请求参数 ###
+|参数名| 参数类型 | 必选 | 参数说明 |  
+|:----- | :------: | :------: | :------: |  
+|appId| string | true | 应用ID   |  
+|channelId| string | true | 直播频道（主播）ID |
+|activityId| string | false | 直播活动ID（活动ID channelId 至少有一个） |
+|uid| string | false   | 用户标识（uuid_时间戳)   |  
+|sid| String | false | 用户ID  |
+|retry| int | false | 重试次数，在0~4之间累加  |
+|isHLS| int | false | 0：rtmp流，1：hls流（ 默认 1  H5 使用 ）  |
+
+### 返回值  ###
+
+| 参数名 | 参数类型 | 必选 | 参数说明 |  
+| :-----------| :------: | :------: | :------: |  
+| errorCode| int | true   | 错误类型号   |  
+| errorMessage| string | true   | 错误信息 |
+| title| string | true   | 频道名称 |
+| channelId| string | true   | 直播频道（主播）ID |
+| activityId| string | false   | 活动ID |
+|liveStatus|int|true|0：直播前；1：直播中；2：直播结束；3：直播回放；-2：直播异常|
+| videoUrl_1 | string | false   |播放地址 流畅版 |
+| videoUrl_2 | string | true   |播放地址  清晰版 |
+| videoUrl_3 | string | false   |播放地址 高清版 |
+| videoUrl_4 | string | false   |播放地址 超高清 |
+
+返回JSON格式的节目元数据信息，json示例如下：
+
+``` json
+{
+    "errorMessage":"请求成功",
+    "data":{
+        "channelId":"*********",
+        "title":"BTOB甜喊：我想你们了",
+        "videoUrl_1":"*****",
+        "videoUrl_2":"*****",
+        "videoUrl_3":"*****",
+        "videoUrl_4":"*****",
+        "liveStatus":2
+    },
+    "errorCode":"0"
+}
+```
 \ No newline at end of file
@@ -22,7 +22,7 @@
 	    <td>thirdPartyId</td>
 	    <td>true</td>
 	    <td>string</td>
-	    <td>第三方用户ID</td>  
+	    <td>第三方用户ID[qq: 建议使用openid, wx: 建议使用unionid, sina: 建议使用idstr</td>  
 	</tr>
 	<tr>
 	    <td>nickName</td>
+#### 请求参数说明: 
+<table class="table table-bordered table-striped table-condensed">
+	<tr>
+	    <th>参数</th>
+	    <th>必选</th>
+	    <th>类型</th>
+	    <th>说明</th>     
+	</tr>
+	<tr>
+	    <td>appId</td>
+	    <td>true</td>
+	    <td>string</td>
+	    <td>应用ID</td>   
+	</tr>
+	<tr>
+	    <td>mobile</td>
+	    <td>true</td>
+	    <td>string</td>
+	    <td>手机号</td>  
+	</tr>
+	<tr>
+	    <td>verificationCode</td>
+	    <td>true</td>
+	    <td>string</td>
+	    <td>手机验证码</td>
+	</tr>
+	<tr>
+	    <td>clientPlat</td>
+	    <td>true</td>
+	    <td>string</td>
+	    <td>客户端平台[i：IOS客户端，a：Android客户端, w: 网页]</td>  
+	</tr>
+	<tr>
+	    <td>sign</td>
+	    <td>true</td>
+	    <td>string</td>
+	    <td>签名</td>  
+	</tr>
+</table>
+
+-----
+#### 返回格式说明:
+```
+{
+    "errorCode": "0",
+    "errorMessage": "成功"
+}
+{
+    "errorCode": "1",
+    "errorMessage": "请求参数无效"
+}
+
+{
+    "errorCode": "41010",
+    "errorMessage": "手机号无效"
+}
+{
+    "errorCode": "41002",
+    "errorMessage": "验证码为6位数字"
+}
+{
+    "errorCode": "41005",
+    "errorMessage": "ClientPlat无效"
+}
+{
+    "errorCode": "41009",
+    "errorMessage": "验证码错误"
+}
+{
+    "errorCode": "40005",
+    "errorMessage": "其他错误"
+}
+```
 \ No newline at end of file
+#### 请求参数说明: 
+<table class="table table-bordered table-striped table-condensed">
+	<tr>
+	    <th>参数</th>
+	    <th>必选</th>
+	    <th>类型</th>
+	    <th>说明</th>     
+	</tr>
+    <tr>
+	    <td>appId</td>
+	    <td>true</td>
+	    <td>string</td>
+	    <td>应用ID</td>   
+	</tr>
+	<tr>
+	    <td>emailAddr</td>
+	    <td>true</td>
+	    <td>string</td>
+	    <td>收件人地址</td>  
+	</tr>
+	<tr>
+	    <td>content</td>
+	    <td>true</td>
+	    <td>string</td>
+	    <td>激活链接</td>
+	</tr>
+	<tr>
+	    <td>clientPlat</td>
+	    <td>true</td>
+	    <td>string</td>
+	    <td>客户端平台[i：IOS客户端，a：Android客户端, w: 网页]</td>  
+	</tr>
+	<tr>
+        <td>sign</td>
+        <td>true</td>
+        <td>string</td>
+        <td>签名</td>
+    </tr>
+</table>
+
+-----
+#### 返回格式说明:
+```
+{
+	"errorCode":"0",
+	"errorMessage":"成功"
+}
+{
+	"errorCode":"1",
+	"errorMessage":"请求参数无效"
+}
+{
+	"errorCode":"41017",
+	"errorMessage":"邮箱格式错误"
+}
+{
+    "errorCode": "41005",
+    "errorMessage": "ClientPlat无效"
+}
+{
+    "errorCode": "41054",
+    "errorMessage": "邮箱未注册"
+}
+{
+    "errorCode": "41055",
+    "errorMessage": "邮件发送失败"
+}
+{
+	"errorCode":"40005",
+	"errorMessage":"其他错误"
+}
+```
 \ No newline at end of file
+#### 请求参数说明: 
+<table class="table table-bordered table-striped table-condensed">
+	<tr>
+	    <th>参数</th>
+	    <th>必选</th>
+	    <th>类型</th>
+	    <th>说明</th>     
+	</tr>
+	<tr>
+	    <td>appId</td>
+	    <td>true</td>
+	    <td>string</td>
+	    <td>应用ID</td>   
+	</tr>
+	<tr>
+	    <td>email</td>
+	    <td>true</td>
+	    <td>string</td>
+	    <td>邮箱</td>  
+	</tr>
+	<tr>
+	    <td>newPwd</td>
+	    <td>true</td>
+	    <td>string</td>
+	    <td>新密码</td>  
+	</tr>
+	<tr>
+	    <td>clientPlat</td>
+	    <td>true</td>
+	    <td>string</td>
+	    <td>客户端平台[i：IOS客户端，a：Android客户端；w:网页]</td>  
+	</tr>
+    <tr>
+        <td>sign</td>
+        <td>true</td>
+        <td>string</td>
+        <td>签名</td>  
+    </tr>
+</table>
+
+-----
+#### 返回格式说明:
+```
+{
+    "errorCode": "0",
+    "errorMessage": "成功"
+}
+{
+    "errorCode": "1",
+    "errorMessage": "请求参数无效"
+}
+
+{
+    "errorCode": "41017",
+    "errorMessage": "邮箱格式错误"
+}
+{
+    "errorCode": "41004",
+    "errorMessage": "密码为6-20位字母或数字"
+}
+{
+    "errorCode": "41051",
+    "errorMessage": "密码不可与账号相同"
+}
+{
+    "errorCode": "41052",
+    "errorMessage": "密码不可为连续的字符串"
+}
+{
+    "errorCode": "41053",
+    "errorMessage": "密码不可为连续相同的字符串"
+}
+{
+    "errorCode": "41005",
+    "errorMessage": "ClientPlat无效"
+}
+{
+    "errorCode": "41054",
+    "errorMessage": "该邮箱未注册"
+}
+{
+    "errorCode": "42004",
+    "errorMessage": "操作失败"
+}
+{
+    "errorCode": "40005",
+    "errorMessage": "其他错误"
+}
+```
 \ No newline at end of file
+#### 请求参数说明: 
+<table class="table table-bordered table-striped table-condensed">
+	<tr>
+	    <th>参数</th>
+	    <th>必选</th>
+	    <th>类型</th>
+	    <th>说明</th>     
+	</tr>
+	<tr>
+	    <td>appId</td>
+	    <td>true</td>
+	    <td>string</td>
+	    <td>应用ID</td>   
+	</tr>
+	<tr>
+        <td>sign</td>
+        <td>true</td>
+        <td>string</td>
+        <td>签名</td>  
+    </tr>
+</table>
+
+-----
+#### 返回格式说明:
+```
+{
+    "errorCode": "0",
+    "errorMessage": "成功",
+    "data": {
+        "logo": "http://images.china.cn/images1/ch/2015china/images/logo.gif",
+        "protocol": "<html>xxxx</html>"
+    }
+}
+```
 \ No newline at end of file