OPEN-API / WIKI · Commits

Commit 095feef60b5c5b464a5bdf8f5c449537c80c56a5

Authored by javazhengchao@163.com
2 parents 4e8d3aaa 851ae07a

Merge remote-tracking branch 'origin/master'

Inline Side-by-side
Showing 7 changed files with 381 additions and 1 deletions
01.点播云/1.01 播放器获取EPG信息接口.md 0 → 100644
  View file @095feef
  1 +/*
  2 +Title: 1.01 播放器获取点播信息接口
  3 +*/
  4 +
  5 +### 接口描述 ###
  6 +
  7 +
  8 +### 接口地址 ###
  9 +http://api.cnlive.com/open/api2/vod_epg/getVodInfo4Player
  10 +
  11 +### 接口协议 ###
  12 +HTTP GET
  13 +
  14 +### 接口请求参数 ###
  15 +|参数名| 参数类型 | 必选 | 参数说明 |
  16 +|:----- | :------: | :------: | :------: |
  17 +|appId| string | true | 应用ID |
  18 +|vId| string | true | 点播节目标识(直播回放的vId就是创建直播活动时的activityId) |
  19 +|uid| string | false | 用户标识（uuid_时间戳) |
  20 +|sid| String | false | 用户ID |
  21 +|retry| int | false | 重试次数，在0~4之间累加 |
  22 +|isHLS| int | false | 0：mp4流，1：hls流(默认1) |
  23 +
  24 +### 返回值 ###
  25 +
  26 +| 参数名 | 参数类型 | 必选 | 参数说明 |
  27 +| :-----------| :------: | :------: | :------: |
  28 +| errorCode| int | true | 错误类型号 |
  29 +| errorMessage| string | true | 错误信息 |
  30 +| title| string | true | 节目标题 |
  31 +| subTitle| string | false | 节目副标题 |
  32 +| status| string | true | 节目状态，1：上线，2：下线 |
  33 +| vId| string | true | 节目的唯一标识 |
  34 +| videoUrl_1 | string | false |播放地址 流畅版 |
  35 +| videoUrl_2 | string | true |播放地址 清晰版 |
  36 +| videoUrl_3 | string | false |播放地址 高清版 |
  37 +| videoUrl_4 | string | false |播放地址 超高清 |
  38 +
  39 +返回JSON格式的节目元数据信息，json示例如下：
  40 +
  41 +``` json
  42 +{
  43 + "errorMessage":"请求成功",
  44 + "data":{
  45 + "status":"1",
  46 + "vId":"174e6c5f3d9e4ddeb739feed1906fa11",
  47 + "subTitle":"BTOB对粉丝甜喊：我想你们了",
  48 + "title":"BTOB甜喊：我想你们了",
  49 + "videoUrl_1":"*****",
  50 + "videoUrl_2":"*****",
  51 + "videoUrl_3":"*****",
  52 + "videoUrl_4":"*****"
  53 + },
  54 + "errorCode":"0"
  55 +}
  56 +```
0 57 \ No newline at end of file
... ...
02.直播云/1.01 播放器获取EPG信息接口.md 0 → 100644
  View file @095feef
  1 +/*
  2 +Title: 1.01 播放器获取直播信息接口
  3 +*/
  4 +
  5 +### 接口描述 ###
  6 +
  7 +
  8 +### 接口地址 ###
  9 +http://api.cnlive.com/open/api2/live_epg/getChannelInfo4Player
  10 +
  11 +### 接口协议 ###
  12 +HTTP GET
  13 +
  14 +### 接口请求参数 ###
  15 +|参数名| 参数类型 | 必选 | 参数说明 |
  16 +|:----- | :------: | :------: | :------: |
  17 +|appId| string | true | 应用ID |
  18 +|channelId| string | true | 直播频道（主播）ID |
  19 +|activityId| string | false | 直播活动ID（活动ID channelId 至少有一个） |
  20 +|uid| string | false | 用户标识（uuid_时间戳) |
  21 +|sid| String | false | 用户ID |
  22 +|retry| int | false | 重试次数，在0~4之间累加 |
  23 +|isHLS| int | false | 0：rtmp流，1：hls流（ 默认 1 H5 使用 ） |
  24 +
  25 +### 返回值 ###
  26 +
  27 +| 参数名 | 参数类型 | 必选 | 参数说明 |
  28 +| :-----------| :------: | :------: | :------: |
  29 +| errorCode| int | true | 错误类型号 |
  30 +| errorMessage| string | true | 错误信息 |
  31 +| title| string | true | 频道名称 |
  32 +| channelId| string | true | 直播频道（主播）ID |
  33 +| activityId| string | false | 活动ID |
  34 +|liveStatus|int|true|0：直播前；1：直播中；2：直播结束；3：直播回放；-2：直播异常|
  35 +| videoUrl_1 | string | false |播放地址 流畅版 |
  36 +| videoUrl_2 | string | true |播放地址 清晰版 |
  37 +| videoUrl_3 | string | false |播放地址 高清版 |
  38 +| videoUrl_4 | string | false |播放地址 超高清 |
  39 +
  40 +返回JSON格式的节目元数据信息，json示例如下：
  41 +
  42 +``` json
  43 +{
  44 + "errorMessage":"请求成功",
  45 + "data":{
  46 + "channelId":"*********",
  47 + "title":"BTOB甜喊：我想你们了",
  48 + "videoUrl_1":"*****",
  49 + "videoUrl_2":"*****",
  50 + "videoUrl_3":"*****",
  51 + "videoUrl_4":"*****",
  52 + "liveStatus":2
  53 + },
  54 + "errorCode":"0"
  55 +}
  56 +```
0 57 \ No newline at end of file
... ...
04.用户云/1.1 第三方登录.md
  View file @095feef
... ... @@ -22,7 +22,7 @@
22 22 <td>thirdPartyId</td>
23 23 <td>true</td>
24 24 <td>string</td>
25   - <td>第三方用户ID</td>
  25 + <td>第三方用户ID[qq: 建议使用openid, wx: 建议使用unionid, sina: 建议使用idstr</td>
26 26 </tr>
27 27 <tr>
28 28 <td>nickName</td>
... ...
04.用户云/2.9 找回或修改密码前校验手机验证码.md 0 → 100644
  View file @095feef
  1 +#### 请求参数说明:
  2 +<table class="table table-bordered table-striped table-condensed">
  3 + <tr>
  4 + <th>参数</th>
  5 + <th>必选</th>
  6 + <th>类型</th>
  7 + <th>说明</th>
  8 + </tr>
  9 + <tr>
  10 + <td>appId</td>
  11 + <td>true</td>
  12 + <td>string</td>
  13 + <td>应用ID</td>
  14 + </tr>
  15 + <tr>
  16 + <td>mobile</td>
  17 + <td>true</td>
  18 + <td>string</td>
  19 + <td>手机号</td>
  20 + </tr>
  21 + <tr>
  22 + <td>verificationCode</td>
  23 + <td>true</td>
  24 + <td>string</td>
  25 + <td>手机验证码</td>
  26 + </tr>
  27 + <tr>
  28 + <td>clientPlat</td>
  29 + <td>true</td>
  30 + <td>string</td>
  31 + <td>客户端平台[i：IOS客户端，a：Android客户端, w: 网页]</td>
  32 + </tr>
  33 + <tr>
  34 + <td>sign</td>
  35 + <td>true</td>
  36 + <td>string</td>
  37 + <td>签名</td>
  38 + </tr>
  39 +</table>
  40 +
  41 +-----
  42 +#### 返回格式说明:
  43 +```
  44 +{
  45 + "errorCode": "0",
  46 + "errorMessage": "成功"
  47 +}
  48 +{
  49 + "errorCode": "1",
  50 + "errorMessage": "请求参数无效"
  51 +}
  52 +
  53 +{
  54 + "errorCode": "41010",
  55 + "errorMessage": "手机号无效"
  56 +}
  57 +{
  58 + "errorCode": "41002",
  59 + "errorMessage": "验证码为6位数字"
  60 +}
  61 +{
  62 + "errorCode": "41005",
  63 + "errorMessage": "ClientPlat无效"
  64 +}
  65 +{
  66 + "errorCode": "41009",
  67 + "errorMessage": "验证码错误"
  68 +}
  69 +{
  70 + "errorCode": "40005",
  71 + "errorMessage": "其他错误"
  72 +}
  73 +```
0 74 \ No newline at end of file
... ...
04.用户云/3.2 找回或修改密码前发激活邮件.md 0 → 100644
  View file @095feef
  1 +#### 请求参数说明:
  2 +<table class="table table-bordered table-striped table-condensed">
  3 + <tr>
  4 + <th>参数</th>
  5 + <th>必选</th>
  6 + <th>类型</th>
  7 + <th>说明</th>
  8 + </tr>
  9 + <tr>
  10 + <td>appId</td>
  11 + <td>true</td>
  12 + <td>string</td>
  13 + <td>应用ID</td>
  14 + </tr>
  15 + <tr>
  16 + <td>emailAddr</td>
  17 + <td>true</td>
  18 + <td>string</td>
  19 + <td>收件人地址</td>
  20 + </tr>
  21 + <tr>
  22 + <td>content</td>
  23 + <td>true</td>
  24 + <td>string</td>
  25 + <td>激活链接</td>
  26 + </tr>
  27 + <tr>
  28 + <td>clientPlat</td>
  29 + <td>true</td>
  30 + <td>string</td>
  31 + <td>客户端平台[i：IOS客户端，a：Android客户端, w: 网页]</td>
  32 + </tr>
  33 + <tr>
  34 + <td>sign</td>
  35 + <td>true</td>
  36 + <td>string</td>
  37 + <td>签名</td>
  38 + </tr>
  39 +</table>
  40 +
  41 +-----
  42 +#### 返回格式说明:
  43 +```
  44 +{
  45 + "errorCode":"0",
  46 + "errorMessage":"成功"
  47 +}
  48 +{
  49 + "errorCode":"1",
  50 + "errorMessage":"请求参数无效"
  51 +}
  52 +{
  53 + "errorCode":"41017",
  54 + "errorMessage":"邮箱格式错误"
  55 +}
  56 +{
  57 + "errorCode": "41005",
  58 + "errorMessage": "ClientPlat无效"
  59 +}
  60 +{
  61 + "errorCode": "41054",
  62 + "errorMessage": "邮箱未注册"
  63 +}
  64 +{
  65 + "errorCode": "41055",
  66 + "errorMessage": "邮件发送失败"
  67 +}
  68 +{
  69 + "errorCode":"40005",
  70 + "errorMessage":"其他错误"
  71 +}
  72 +```
0 73 \ No newline at end of file
... ...
04.用户云/3.3 通过邮箱修改密码.md 0 → 100644
  View file @095feef
  1 +#### 请求参数说明:
  2 +<table class="table table-bordered table-striped table-condensed">
  3 + <tr>
  4 + <th>参数</th>
  5 + <th>必选</th>
  6 + <th>类型</th>
  7 + <th>说明</th>
  8 + </tr>
  9 + <tr>
  10 + <td>appId</td>
  11 + <td>true</td>
  12 + <td>string</td>
  13 + <td>应用ID</td>
  14 + </tr>
  15 + <tr>
  16 + <td>email</td>
  17 + <td>true</td>
  18 + <td>string</td>
  19 + <td>邮箱</td>
  20 + </tr>
  21 + <tr>
  22 + <td>newPwd</td>
  23 + <td>true</td>
  24 + <td>string</td>
  25 + <td>新密码</td>
  26 + </tr>
  27 + <tr>
  28 + <td>clientPlat</td>
  29 + <td>true</td>
  30 + <td>string</td>
  31 + <td>客户端平台[i：IOS客户端，a：Android客户端；w:网页]</td>
  32 + </tr>
  33 + <tr>
  34 + <td>sign</td>
  35 + <td>true</td>
  36 + <td>string</td>
  37 + <td>签名</td>
  38 + </tr>
  39 +</table>
  40 +
  41 +-----
  42 +#### 返回格式说明:
  43 +```
  44 +{
  45 + "errorCode": "0",
  46 + "errorMessage": "成功"
  47 +}
  48 +{
  49 + "errorCode": "1",
  50 + "errorMessage": "请求参数无效"
  51 +}
  52 +
  53 +{
  54 + "errorCode": "41017",
  55 + "errorMessage": "邮箱格式错误"
  56 +}
  57 +{
  58 + "errorCode": "41004",
  59 + "errorMessage": "密码为6-20位字母或数字"
  60 +}
  61 +{
  62 + "errorCode": "41051",
  63 + "errorMessage": "密码不可与账号相同"
  64 +}
  65 +{
  66 + "errorCode": "41052",
  67 + "errorMessage": "密码不可为连续的字符串"
  68 +}
  69 +{
  70 + "errorCode": "41053",
  71 + "errorMessage": "密码不可为连续相同的字符串"
  72 +}
  73 +{
  74 + "errorCode": "41005",
  75 + "errorMessage": "ClientPlat无效"
  76 +}
  77 +{
  78 + "errorCode": "41054",
  79 + "errorMessage": "该邮箱未注册"
  80 +}
  81 +{
  82 + "errorCode": "42004",
  83 + "errorMessage": "操作失败"
  84 +}
  85 +{
  86 + "errorCode": "40005",
  87 + "errorMessage": "其他错误"
  88 +}
  89 +```
0 90 \ No newline at end of file
... ...
04.用户云/3.4 获取App注册协议.md 0 → 100644
  View file @095feef
  1 +#### 请求参数说明:
  2 +<table class="table table-bordered table-striped table-condensed">
  3 + <tr>
  4 + <th>参数</th>
  5 + <th>必选</th>
  6 + <th>类型</th>
  7 + <th>说明</th>
  8 + </tr>
  9 + <tr>
  10 + <td>appId</td>
  11 + <td>true</td>
  12 + <td>string</td>
  13 + <td>应用ID</td>
  14 + </tr>
  15 + <tr>
  16 + <td>sign</td>
  17 + <td>true</td>
  18 + <td>string</td>
  19 + <td>签名</td>
  20 + </tr>
  21 +</table>
  22 +
  23 +-----
  24 +#### 返回格式说明:
  25 +```
  26 +{
  27 + "errorCode": "0",
  28 + "errorMessage": "成功",
  29 + "data": {
  30 + "logo": "http://images.china.cn/images1/ch/2015china/images/logo.gif",
  31 + "protocol": "<html>xxxx</html>"
  32 + }
  33 +}
  34 +```
0 35 \ No newline at end of file
... ...