火星接口文档

火星接口文档


视频检测

<p>[TOC]</p> <h2>简要描述 视频上传步骤</h2> <ol> <li>通过接口<code>{BaseUrl}/Mind/VideoBill/Create</code>创建订单:<code>VideoBillCreate</code> =&gt; <code>VideoBillRsp</code></li> <li>使用返回数据<code>VideoBillRsp</code>中的[videoFile,VideoToken]和[avatarFile,avatarToken]的值分别上传视频文件和头像文件,其中,头像文件可以不上传。 <ul> <li>平台使用七牛云存储暂存视频及头像,具体上传方法可参阅 [七牛云表单上传](<a href="https://developer.qiniu.com/kodo/1272/form-upload">https://developer.qiniu.com/kodo/1272/form-upload</a> &quot;七牛云表单上传&quot;)</li> <li>上传完成后,如果七牛云返回的Http状态码为200,则返回<code>IdRsp</code>类型的数据,其全局包装形式与火星全局Api一致。</li> <li>如果七牛返回的Http状态码不为200,其错误信息为七牛云返回的默认错误信息。</li> </ul></li> <li>视频上传成功后,系统将自动进行检测分析,正常需要5-10分钟,客户端可以通过<code>{BaseUrl}/Mind/VideoBill/Read</code>接口读取订单状态。</li> <li>当Status状态为6时,表明报告已经生成成功,可以通过<code>{BaseUrl}/Mind/VideoBill/ReadReport</code>接口获取。</li> </ol> <h2>接口列表</h2> <ul> <li><code>{BaseUrl}/Mind/VideoBill/Create</code> 添加订单 <code>VideoBillCreate</code> =&gt; <code>VideoBillRsp</code></li> <li><code>{BaseUrl}/Mind/VideoBill/Cancel</code> 取消订单 <code>IdReq</code> =&gt; <code>VideoBillRsp</code></li> <li><code>{BaseUrl}/Mind/VideoBill/Read</code> 读取订单 <code>IdReq</code> =&gt; <code>VideoBillRsp</code></li> <li><code>{BaseUrl}/Mind/VideoBill/ReadReport</code> 读取报告详细信息 <code>IdReq</code> =&gt; <code>VideoBillReportRsp</code></li> <li><code>{BaseUrl}/Mind/VideoBill/ReadPdf</code> 根据订单id获取pdf报告的url <code>idReq</code> =&gt; <code>idReq</code> <ul> <li>ReadPdf 返回的是 {“id”:&quot;pdf的下载地址Url&quot;},此下载地址24小时内有效,超时后需重新获取。</li> </ul></li> </ul> <h5>请求与响应类</h5> <h5>VideoBillCreate 创建订单的请求类</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>客户姓名 -用于pdf生成</td> </tr> <tr> <td style="text-align: left;">age</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>年龄</td> </tr> <tr> <td style="text-align: left;">sex</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>性别 0 男 1 女</td> </tr> <tr> <td style="text-align: left;">agentName</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>机构名称 -用于pdf生成</td> </tr> <tr> <td style="text-align: left;">agentAddr</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>机构地址 -用于pdf生成</td> </tr> </tbody> </table> <h5>VideoBillRsp 视频订单的响应类</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">id</td> <td style="text-align: left;">string</td> <td>唯一id</td> </tr> <tr> <td style="text-align: left;">createdOn</td> <td style="text-align: left;">datetime</td> <td>创建时间</td> </tr> <tr> <td style="text-align: left;">modifiedOn</td> <td style="text-align: left;">datetime</td> <td>最后修改时间</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">string</td> <td>客户姓名</td> </tr> <tr> <td style="text-align: left;">age</td> <td style="text-align: left;">string</td> <td>年龄</td> </tr> <tr> <td style="text-align: left;">sex</td> <td style="text-align: left;">int</td> <td>性别 0男1女</td> </tr> <tr> <td style="text-align: left;">agentName</td> <td style="text-align: left;">string</td> <td>机构名称</td> </tr> <tr> <td style="text-align: left;">agentAddr</td> <td style="text-align: left;">string</td> <td>机构地址</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">int</td> <td>订单状态 <code>0</code>:<code>已创建</code> <code>2</code>:<code>已暂存</code>[视频文件已暂存至七牛] <code>3</code>:<code>正在转码</code> <code>4</code>:<code>正在分析视频</code> <code>6</code>:<code>报告已生成</code> <code>8</code>:<code>已完成</code>[当pdf报告文件读取过一次就认为已完成] <code>12</code>:<code>订单已关闭</code></td> </tr> <tr> <td style="text-align: left;">videoFile</td> <td style="text-align: left;">string</td> <td>视频文件名称 对应七牛云中的<code>resource_key</code>值。</td> </tr> <tr> <td style="text-align: left;">videoToken</td> <td style="text-align: left;">string</td> <td>视频上传token,对应七牛云中的<code>upload_token</code>值。如果视频已上传,则本字段返回空字串。<strong>此token自返回时间起2小时内有效</strong>,如果超时,请通过<code>Read</code>接口重新读取订单。</td> </tr> <tr> <td style="text-align: left;">avatarFile</td> <td style="text-align: left;">string</td> <td>头像图片文件名称 对应七牛云中的<code>resource_key</code>值。</td> </tr> <tr> <td style="text-align: left;">videoToken</td> <td style="text-align: left;">string</td> <td>头像文件上传token,对应七牛云中的<code>upload_token</code>值。如果图版已上传,则本字段返回空字串。<strong>此token自返回时间起2小时内有效</strong>,如果超时,请通过<code>Read</code>接口重新读取订单。</td> </tr> <tr> <td style="text-align: left;">uploadUrl</td> <td style="text-align: left;">string</td> <td>七牛云上传url,如果video和avatar均已创建完成,则返回空字串</td> </tr> </tbody> </table> <h5>VideoBillReportRsp 视频订单的响应类,继承自<code>VideoBillRsp</code></h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">mindLevel</td> <td style="text-align: left;">int</td> <td>心理状态等级,<code>0</code>:<code>优秀</code> <code>1</code>:<code>良好</code> <code>2</code>:<code>一般</code> <code>3</code>:<code>欠佳</code> <code>9</code>:<code>未知</code></td> </tr> <tr> <td style="text-align: left;">mindEvaluation</td> <td style="text-align: left;">string</td> <td>心理状态评价,一段对当前心理状态的简单评价</td> </tr> <tr> <td style="text-align: left;">reportFile</td> <td style="text-align: left;">string</td> <td>PDF检测报告的文件URL,这里的URL无法直接获取报告,如果要获取pdf报告的实际URL,请通过 <code>ReadPdf</code> 接口获取</td> </tr> <tr> <td style="text-align: left;">reportDetail</td> <td style="text-align: left;">ReportDetail 对象</td> <td>检测结果详细信息 与<code>企业订单</code>中的ReportDetail一样。[ReportDetail](<a href="https://www.showdoc.com.cn/hx008/11112362773644744">https://www.showdoc.com.cn/hx008/11112362773644744</a> &quot;企业订单的ReportDetail&quot;)</td> </tr> </tbody> </table>

页面列表

ITEM_HTML