本文档由小幺鸡编辑

http请求要求:

http请求头里要携带app_v和Cookie信息。

app_v代表app版本号。

Cookie是会话凭证(基于现有的webapi模式)。


===========================================================我是分割线========================================


录音文件格式要求:

单轨/双轨的WAV格式,

8000Hz或者16000Hz的采样率;

录音文件时长不要太长(目前不要超过1小时),多的话裁剪分文件;

目录文件大小不要太大(不要超过512mb),多的话同样要裁剪分文件;

ps:此录音文件参数目前是针对讯飞和阿里语音识别的参数要求定制的(后期可能用到语音转换所以音频编码格式要正确,由app客户端完成编码转换和上传操作),并且需要保证转换后的录音质量,以后可能会有变动。


===========================================================我是分割线========================================


基于我们这边的web api的步骤:

1进入app先获取用户登录状态--------》如果返回401表示登录过期或者失效了------》过期或者失效要静默登录(app端存账户和密码,密码目前先md5加密)调用登录接口登录。

2如果app停留一段时间不操作,此时仍会有session会话过期问题,此时如果请求后端方法返回401说明过期了,同样客户端要实行静默登录(用户无感知)再执行往下请求操作,可能涉及到请求队列阻塞方式(或者其他解决方案)

3目前暂不考虑设备唯一性问题,以后有需要再兼容调整

===========================================================我是分割线========================================


https请求结果和请求过期问题和返回为false和code的数字说明问题。

{
"code": 0,
"success": true,
"serverTime": 1550738780952
}


{errorCode: 401, errorMsg: "未登录", success: false, serverTime: 1550216861054}
errorCode:401
errorMsg:"未登录"
serverTime:1550216861054
success:false
}

401未登录或者登录失效session过期,需要系统静默登录(用户无感知情况下)。
403为后台方法无权限。

500为程序内部错误。




如果返回4001表示当前app版本太落后接口不能用,此时获取不到数据(对应功能不能用),不要求用户升级。

如果返回4002表示当前app版本版本与线上接口不对应,数据结构发生重大升级导致接口不能用,需要弹窗强制让用户升级到最新版本。


一般success为true时,存在code不存在errorCode,一般success为false时,存在errorCode不存在code

===========================================================我是分割线========================================


请求错误时接口返回列子:

{"data":{"traceId":"9RBCBIXEBDT48L0W"},"errorCode":500,"errorMsg":"NullPointerException","success":false,"serverTime":1550472874316}

请求成功是接口返回例子:

{"data":"6f05c052-6287-460b-ba2c-be4ca333e853","code":0,"success":true,"serverTime":1550729476627}