OPEN-API / WIKI · Commits

Commit bef0627639584c95549ea137d0e94e6f31b6fbdf

Authored by 范晓春
1 parent 8abb5722

update

Inline Side-by-side
Showing 2 changed files with 266 additions and 0 deletions
01.点播云/3.6 转码业务回调数据结构说明.md 0 → 100644
  View file @bef0627
  1 +### 转码业务回调数据结构说明
  2 +-----
  3 +#### URL: http://transcode.cnlive.com/api/request
  4 +-----
  5 +#### 接口说明: 针对视讯云平台上传内容的转码服务
  6 +-----
  7 +#### 请求方式: HTTP POST
  8 +-----
  9 +#### 返回格式: JSON
  10 +-----
  11 +#### 请求参数说明:
  12 +| 参数名 | 参数类型 | 必选 | 参数说明 |
  13 +| :----------- | :------: | :------: | :------: |
  14 +| appId | string | true | 应用ID |
  15 +| params| json | true | 请求json数据 |
  16 +|sign| String | true | 签名规则见 [签名详情] (http://help.open.cnlive.com/common.html) |
  17 +
  18 +-----
  19 +
  20 +#### params参数说明:
  21 +| 参数名 | 参数类型 | 必选 | 参数说明 |
  22 +| :----------- | :------: | :------: | :------: |
  23 +| plat | int | false | 转码平台,根据当前业务所应用的存储平台对应, 0:金山;1:七牛 默认为0|
  24 +| path| string | true | 源文件的相对路径 格式：/{bucket}/{object_name} |
  25 +| dstBucket| string | false | 转码存储bucket,默认同源视频同bucket |
  26 +| dstDir| string | true | 输出文件key的路径、不允许以/开头 |
  27 +| type| string | true | 转码类型，针对该视频转码固定取值,type:avop|
  28 +| rates| string | false | 码率集合、单位K，多个码率以逗号分隔。根据该参数返回指定的码率视频信息。取值范围:(流畅:400;标清:800;高清:1500;超清:3000)|
  29 +| attach| json | false | type相关附带参数 非必填 格式:json|
  30 +| cbUrl| string | true | 回调用户地址,回调请求采用post body形式|
  31 +| extParam| json | false | 附加参数 json|
  32 +
  33 +-----
  34 +
  35 +#### attach(转码加水印任务必填)参数说明:
  36 +
  37 +| 参数名 | 参数类型 | 必选 | 参数说明 |
  38 +| :----------- | :------: | :------: | :------: |
  39 +| path | string | true | logo源文件的相对路径 格式：/{bucket}/{object_name}|
  40 +| position | int | false | 水印方位 默认值：0 取值范围:左上角:0;右上角:1;左下角:2;右下角:3;|
  41 +
  42 +-----
  43 +
  44 +#### extParam参数说明:
  45 +
  46 +| 参数名 | 参数类型 | 必选 | 参数说明 |
  47 +| :----------- | :------: | :------: | :------: |
  48 +| domain | string | false | 音视频源文件外链域名，plat=1时必填|
  49 +| avconcat | string | false | 添加片头、片尾，json字符串|
  50 +| startTime | string | false | 音视频剪辑开始时间点，不填即不计入剪辑范围。格式 HH : mm : ss(目前仅支持plat=0)|
  51 +| endTime | string | false | 音视频剪辑结束时间点，不填即不计入剪辑范围 格式 HH : mm : ss(目前仅支持plat=0)|
  52 +
  53 +-----
  54 +#### avconcat 参数说明:
  55 +| 参数名 | 参数类型 | 必选 | 参数说明 |
  56 +| :----------- | :------: | :------: | :------: |
  57 +| headFile | string | false | 片头 格式:/{bucket}/{object_name}|
  58 +| endFile | string | false | 片尾 格式:/{bucket}/{object_name}|
  59 +
  60 +-----
  61 +
  62 +#### 请求示例:
  63 +```
  64 +{
  65 + "appId":"82_XXX",
  66 + "params":{
  67 + "cbUrl":"http://test.transcode.cnlive.com/ts/defaultNotify",
  68 + "path":"/trans-test/60/1465695/vod/2017/0323/60_527f266385614dd48ad5a0932ffca16a.mp4",
  69 + "cbMethod":"POST",
  70 + "formats":"mp4,hls",
  71 + "extParam":{
  72 + "startTime":"00:00:00",
  73 + "endTime":"10:00:10"
  74 + },
  75 + "dstDir":"60/1465695/vod/2017/0323",
  76 + "rates":"400,800",
  77 + "dstBucket":"trans-test",
  78 + "attach":{
  79 + "path":"/trans-test/82_20170330173100.png",
  80 + "position":0
  81 + },
  82 + "type":"avop"
  83 + }
  84 +}
  85 +
  86 +
  87 +```
  88 +-----
  89 +
  90 +#### 请求任务返回数据结构:
  91 +```
  92 +{
  93 + code:0, //状态码 0：成功 1：失败
  94 + desc:"success",
  95 + taskId:"07e589adf3da4512acaf7864a388e8f6"
  96 +}
  97 +```
0 \ No newline at end of file 98 \ No newline at end of file
03.发布云/5.3 sp内容全文检索.md 0 → 100644
  View file @bef0627
  1 +/* Title: 5.3 sp内容同步全文检索接口 */
  2 +### sp内容全文检索接口
  3 +-----
  4 +#### URL:http://so.cnlive.com/so/searchByQueryStr
  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>spCode</td>
  24 + <td>true</td>
  25 + <td>string</td>
  26 + <td>sp索引标识</td>
  27 + </tr>
  28 + <tr>
  29 + <td>queryStr</td>
  30 + <td>true</td>
  31 + <td>string</td>
  32 + <td>solr语法查询字符串</td>
  33 + </tr>
  34 + <tr>
  35 + <td>page</td>
  36 + <td>false</td>
  37 + <td>int</td>
  38 + <td>页码，默认取值为1</td>
  39 + </tr>
  40 + <tr>
  41 + <td>pageSize</td>
  42 + <td>false</td>
  43 + <td>int</td>
  44 + <td>每页数据数量，默认取值为18</td>
  45 + </tr>
  46 + <tr>
  47 + <td>order</td>
  48 + <td>false</td>
  49 + <td>Array</td>
  50 + <td>排序字段数组 每个元素类型为JSON，{"fileName","order"} 例如:[{"weight":"asc"}</td>
  51 + </tr>
  52 + <tr>
  53 + <td>sign</td>
  54 + <td>true</td>
  55 + <td>string</td>
  56 + <td></td>
  57 + </tr>
  58 +
  59 +</table>
  60 +-----
  61 +#### queryStr 支持的参数说明:
  62 +<table class="table table-bordered table-striped table-condensed">
  63 + <tr>
  64 + <th>参数</th>
  65 + <th>必选</th>
  66 + <th>类型</th>
  67 + <th>说明</th>
  68 + </tr>
  69 + <tr>
  70 + <td>mediaId</td>
  71 + <td>false</td>
  72 + <td>string</td>
  73 + <td>媒体UUID</td>
  74 + </tr>
  75 + <tr>
  76 + <td>CMSChannelID</td>
  77 + <td>false</td>
  78 + <td>string</td>
  79 + <td>频道ID</td>
  80 + </tr>
  81 + <tr>
  82 + <td>CMSColumnID</td>
  83 + <td>false</td>
  84 + <td>string</td>
  85 + <td>栏目ID</td>
  86 + </tr>
  87 + <tr>
  88 + <td>type</td>
  89 + <td>false</td>
  90 + <td>string</td>
  91 + <td>内容类型，取值为 网页:web、节目:program</td>
  92 + </tr>
  93 + <tr>
  94 + <td>keyWords</td>
  95 + <td>false</td>
  96 + <td>string</td>
  97 + <td>关键词</td>
  98 + </tr>
  99 + <tr>
  100 + <td>title</td>
  101 + <td>false</td>
  102 + <td>string</td>
  103 + <td>标题</td>
  104 + </tr>
  105 + <tr>
  106 + <td>docID</td>
  107 + <td>false</td>
  108 + <td>int</td>
  109 + <td>内容ID</td>
  110 + </tr>
  111 + <tr>
  112 + <td>publishDate</td>
  113 + <td>false</td>
  114 + <td>String</td>
  115 + <td>发布日期,格式:yyyy-MM-dd</td>
  116 + </tr>
  117 + <tr>
  118 + <td>desc</td>
  119 + <td>false</td>
  120 + <td>String</td>
  121 + <td>简介描述</td>
  122 + </tr>
  123 +</table>
  124 +
  125 +
  126 +-----
  127 +#### 请求示例参数:
  128 +```
  129 +http://so.cnlive.com/so/searchByQueryStr/xxx?queryStr=text:中国*&order=[{"weight":"asc"},{"publishDate":"asc"}]
  130 +```
  131 +-----
  132 +#### 返回 JSON说明:
  133 +```
  134 +{
  135 +"errorMessage": "成功",
  136 +"data":{
  137 +"programs":[
  138 + {
  139 + "mediaId": "f1b6f998-d0a8-4f84-9f93-76656421c2e8",
  140 + "CMSChannelID": "spzl/",
  141 + "desc": "",
  142 + "weight": "0",
  143 + "CMSColumnID": "spzl/fbhhf/",
  144 + "pageUrl": "http://s.scio.gov.cn/spzl/fbhhf/detail2_2013_11/05/648571.html",
  145 + "img": "",
  146 + "CMSChannelName": "视频专栏",
  147 + "vipFlag": "0",
  148 + "type": "program",
  149 + "subTitle": "中国应对气候变化2013年度报告新闻发布会举行",
  150 + "duration": "00:00:00",
  151 + "title": "中国应对气候变化2013年度报告新闻发布会举行",
  152 + "CMSColumnName": "发布会回放",
  153 + "docID": "648571",
  154 + "keyWords": "",
  155 + "bigImg": "",
  156 + "mamAirTime": "",
  157 + "publishDate": "2013-01-05",
  158 + "sallImg": ""
  159 + }。。。
  160 +],
  161 +"next_cursor": "2",
  162 +"page": "1",
  163 +"previous_cursor": "0",
  164 +"pageSize": "9",
  165 +"total_number": 4056
  166 +},
  167 +"errorCode": "0"
  168 +}
  169 +```
0 \ No newline at end of file 170 \ No newline at end of file