PHP 后端协议规范
1 修改记录
1.0版本
|
No |
版本号 |
修改内容 |
修改日期 |
修改人 |
|
1 |
1.0 |
初稿 |
2016.04.13 |
伍文华 |
注意：仍然待完善部分
l 消息
l 分享
l 版本升级
l 优化：刷新当前用户信息
l 优化：查询指定某个直播、点播的信息
2 基本规则
2.1 通信协议
http + json
2.2 数据压缩
要求客户端上报数据、服务器返回结果都支持GZIP压缩
1. 客户端POST上报时，Content-Encoding等于gzip，指定上报压缩数据；
2. 客户端GET查询时，Accept-Encoding等于gzip，指定支持服务器返回压缩数据；
3. 服务器返回数据时，Content-Encoding等于gzip，指定返回压缩数据；
2.3 公共参数
约定每一条查询，不管是GET方式还是POST方式，都需要带上以下公共参数。
对于GET方式，公共参数出现在url里，对于POST方式，公共参数出现在content里（json字段）。
|
字段 |
引入版本 |
描述 |
|
应用属性 |
||
|
version |
1.0 |
APP版本号，如1.0.0.100 |
|
versionCode |
1.0 |
APP版本Build号，如100 |
|
channelID |
1.0 |
APP渠道号，针对Android，官网包固定填0 |
|
手机属性 |
||
|
deviceID |
1.0 |
手机deviceID，用于后台统计 （1）android取MAC地址 （2）ios取idfa |
|
os |
1.0 |
手机操作系统，取值android、ios |
|
osVersion |
1.0 |
手机操作系统的版本号 |
|
随机数 |
||
|
random |
1.0 |
随机数，本地unix时间戳，单位ms， 用于避免ping包攻击 |
|
帐号属性（仅在用户已登录时才带上该字段） |
||
|
userID |
1.0 |
用户ID |
|
accessToken |
1.0 |
登录态token，为防止冒充别人登录操作。数据来自于登录后返回的accessToken |
2.4 校验签名
为了防止恶意偷爬数据，对于有GET和POST请求，都需要添加校验签名。
计算签名的公式为
sign = GET_SIGN(param) = MD5(MD5(param) + MD5(salt))
其中：
1. MD5统一采用大写字母输出；
2. salt为签名的“盐”，固定字符串“dooboo_123456”；
3. param为前面的参数，
1) GET方式
假设，请求url为http://domain?aa=A&bb=BB&cc=CC
那么，签名参数为aa=A&bb=BB&cc=CC
2) POST方式
签名的参数为post的content
最终，签名通过自定义http header传给服务器，字段名Custom-Sign
2.5 返回格式
约定服务器返回的数据，统一按照以下格式。
|
{ "rtn":"0", "msg":"success", "data": { // ... } } |
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码（整形数），取值 0：成功 1~999：业务错误码，具体见接口定义 1000~：系统错误码（预留），定义见下 ------------------------------------------------------- 1000：系统错误码，参数异常 1001：系统错误码，参数签名错误 1002：系统错误码，登录态超时 1003：系统错误码，登录态错误（被踢） |
|
msg |
1.0 |
提示信息 |
|
数据data |
||
|
data |
1.0 |
具体内容，当rtn=0时有效 |
举例：以接口 5.1获取直播banner（live/getLiveBanner）为例，返回以下结果
|
{ "rtn":"0", "msg":"success", "data": { "bannerList": [ { "bannerID":"12345", "imageUrl":"http://www.dobo.com/1.jpg", "type":"1", "jumpUrl":"http://www.hello.com",
}, {...}, ], } } |
2.6 数据格式
1. MD5：统一采用MD5后按大写字母输出
2. 布尔型：协议中布尔型统一按0、1返回 （PS：考虑到ios和android）
3. 性别：统一取值0男，1女
4. 时间戳：统一采用毫秒ms为单位，避免用秒产生冲突
5. 密码：不直接使用和保存用户的密码明文，而是使用密码的MD5，防止被拖库后攻击者使用用户账号登录
2.7 链接格式
1. 为了配合yii框架，链接统一采用小写字母（参数仍然保持大小写）
2.8 请求方式
1 非特殊情况，所有请求一概用POST方式
2 基本类型
2.1 用户信息（UserInfo）
|
字段 |
引入版本 |
描述 |
|
基本信息 |
||
|
userID |
1.0 |
用户ID |
|
nickname |
1.0 |
昵称 |
|
sex |
1.0 |
性别，取值0男，1女 |
|
headUrl |
1.0 |
头像url |
|
isCompany |
1.0 |
是否企业用户，取值0、1，默认0 |
|
companyID |
1.0 |
可选，对于企业用户，对应企业ID，当isCompany=1时有效 |
|
可选信息（按照具体业务确定是否需要返回） |
||
|
mobileNum |
1.0 |
电话号码，用户登录自己账号（user/mobileLogin）的时候返回 |
|
vodVideoCnt |
1.0 |
用户发布的点播文件数目，在搜索点播（vod/searchUser）的时候返回 |
2.2 企业信息（CompanyInfo）
|
字段 |
引入版本 |
描述 |
|
companyID |
1.0 |
企业ID |
|
name |
1.0 |
企业名称 |
|
logoUrl |
1.0 |
商标url |
2.3 直播视频信息（LiveVideoInfo）
|
字段 |
引入版本 |
描述 |
|
基本信息 |
||
|
liveVideoID |
1.0 |
直播视频ID |
|
imageUrl |
1.0 |
封面url |
|
title |
1.0 |
标题 |
|
location |
1.0 |
地理位置，创建者屏蔽地理位置则填空 |
|
isEnd |
1.0 |
是否已经结束，取值0、1，默认0 |
|
码流信息 |
||
|
rtmpUrl |
1.0 |
推流地址（可选字段，仅对自己可见） |
|
playUrl |
1.0 |
播放地址 |
|
用户信息 |
||
|
userInfo |
1.0 |
创建直播的用户信息，为UserInfo结构 |
|
运营信息 |
||
|
isRecommend |
1.0 |
是否推荐，取值0、1，默认0 |
|
isHot |
1.0 |
是否热门，取值0、1，默认0 |
|
统计信息 |
||
|
watchCnt |
1.0 |
观看次数 |
|
likeCnt |
1.0 |
点赞次数 |
2.4 点播视频信息（VodVideoInfo）
|
字段 |
引入版本 |
描述 |
|
基本信息 |
||
|
vodVideoID |
1.0 |
点播视频ID |
|
imageUrl |
1.0 |
封面url |
|
title |
1.0 |
标题 |
|
summary |
1.0 |
介绍 |
|
duration |
1.0 |
视频时长，单位ms |
|
码流信息 |
||
|
playUrl |
1.0 |
播放地址 |
|
用户信息 |
||
|
userInfo |
1.0 |
创建点播的用户信息，为UserInfo结构 |
|
运营信息 |
||
|
isRecommend |
1.0 |
是否推荐，取值0、1，默认0 |
|
isHot |
1.0 |
是否热门，取值0、1，默认0 |
|
统计信息 |
||
|
watchCnt |
1.0 |
观看次数 |
|
likeCnt |
1.0 |
点赞次数 |
2.5 Banner信息（BannerInfo）
|
字段 |
引入版本 |
描述 |
|
bannerID |
1.0 |
banner的ID |
|
title |
1.0 |
banner的标题，显示在新开窗口的标题栏 |
|
imageUrl |
1.0 |
图片url |
|
type |
1.0 |
banner类型，取值 1：跳到h5页面 其他：暂不支持（预留） |
|
jumpUrl |
1.0 |
跳转Url，格式如下 type=1，http://url 其他：暂不支持（预留） |
3 接口：账号相关（user/）
3.1 获取注册验证码（user/getRegisterSmsCode）
功能
获取验证码，用于注册，验证码的有效期为5分钟（待定）。
权限
全部用户（不需要登录）
方式
POST
域名
http://.../user/getRegisterSmsCode
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
mobileNum |
1.0 |
手机号码， 格式为+8613000000000，+86为客户端自动插入前缀，为了预留将来做国外手机号码注册 |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 1：手机号错误 2：发送短信过多（短信平台提示过多） 3：发送失信失败（短信平台提示出错） 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
无 |
|
|
3.2 获取重置密码验证码（user/getResetPswSmsCode）
功能
用户忘记密码时，获取验证码，用于重置密码，验证码的有效期为5分钟（待定）。
权限
全部用户（不需要登录）
方式
POST
域名
http://.../user/getResetPswSmsCode
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
mobileNum |
1.0 |
手机号码， 格式为+8613000000000，+86为客户端自动插入前缀，为了预留将来做国外手机号码注册 |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 1：手机号错误 2：发送短信过多（短信平台提示过多） 3：发送失信失败（短信平台提示出错） 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
无 |
|
|
3.3 手机号注册（user/mobileRegister）
功能
获取手动态验证码后，进行注册。
权限
全部用户（不需要登录）
方式
POST
域名
http://.../user/mobileRegister
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
mobileNum |
1.0 |
手机号码， 格式为+8613000000000，+86为客户端自动插入，为了预留将来做国外手机号码注册 |
|
smsCode |
1.0 |
校验码 |
|
pswMD5 |
1.0 |
登录密码的MD5 |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：注册成功 1：手机号格式错误 2：验证码错误 3：验证码超时 4：手机号可能已注册 其他：其他错误 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
userID |
1.0 |
当rtn=0时， 返回用户ID |
3.4 手机号登录（user/mobileLogin）
功能
通过手机号和密码登录。
权限
全部用户（不需要登录）
方式
POST
域名
http://.../user/mobileLogin
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
mobileNum |
1.0 |
手机号码， 格式为+8613000000000，+86为客户端自动插入，为了预留将来做国外手机号码注册 |
|
pswMD5 |
1.0 |
登录密码的MD5 |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：登录成功 1：手机号格式错误 2：手机号或则密码不匹配 3：账号被封，客户端应提示“账号被封，请于客服联系” |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
userInfo |
1.0 |
当rtn=0时，返回用户信息，对应结构UserInfo PS：UserInfo需要返回可选字段mobileNum |
|
accessToken |
1.0 |
登录态token，用作后续请求的公共参数 |
|
editProfile |
1.0 |
表示用户之前是否提交过个人信息，取值0、1 PS：用户注册了，但是没有提交个人信息，下次启动的时候客户端仍然要提示其修改个人信息 |
3.5 手机号重置密码（user/mobileResetPsw）
功能
用户忘记密码时，获取到验证码后，用于重置密码
权限
全部用户（不需要登录）
方式
POST
域名
http://.../user/mobileResetPsw
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
mobileNum |
1.0 |
手机号码， 格式为+8613000000000，+86为客户端自动插入，为了预留将来做国外手机号码注册 |
|
smsCode |
1.0 |
校验码 |
|
pswMD5 |
1.0 |
登录密码的MD5 |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：重置成功 1：手机号格式错误 2：验证码错误 3：验证码超时 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
无 |
|
|
3.6 登录后修改密码（user/mobileChangePsw）
功能
手机号登录用户，在登陆后，进行密码修改
权限
登录用户
方式
POST
域名
http://.../user/mobileChangePsw
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
oldPswMD5 |
1.0 |
旧的密码MD5 |
|
newPswMD5 |
1.0 |
新的密码MD5 |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：修改成功 1：旧的密码错误 其他：其他错误 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
无 |
|
|
3.7 注销登录（user/logout）
功能
注销帐号，通知服务器清空登录态session
权限
登录用户
方式
POST
域名
http://.../user/logout
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
无 |
|
|
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
无 |
|
|
3.8 修改用户信息（user/editProfile）
功能
修改个人信息，如头像、昵称。
PS：用户一旦提交过个人信息，下次登录的时候返回的editProfile=1
权限
登录用户
方式
POST
域名
http://.../user/editProfile
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
nickname |
1.0 |
昵称 |
|
sex |
1.0 |
性别，取值0男，1女 |
|
headUrl |
1.0 |
头像图url |
PS：以上定制参数均为可选参数，需要修改才填
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
无 |
|
|
3.9 关注/取消关注（user/followUser）
功能
关注或则取消关注指定某人
权限
登录用户
方式
POST
域名
http://.../user/followUser
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
followUserID |
1.0 |
对方userID |
|
set |
1.0 |
操作方式，取值 0：取消关注 1：关注 |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
无 |
|
|
3.10 拉取关注人（user/listFollowUser）
功能
拉取当前账号关注的所有人，按关注时间倒叙返回。
PS：目前不考虑分页，一次过全部拉完所有记录
PS：由于一次过返回所有记录，存在性能风险，服务器暂定最多返回300条
权限
登录用户
方式
POST
域名
http://.../user/listFollowUser
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
无 |
|
|
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
userList |
1.0 |
关注用户列表，item为UserInfo结构 |
3.11 搜索用户（user/searchUser）
功能
通过ID、昵称，搜索用户，分页返回
权限
全部用户（不需要登录）
方式
POST
域名
http://.../user/searchUser
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
keyword |
1.0 |
搜索关键字 |
|
baseOffset |
1.0 |
分页起始偏移，上一次查询返回的offset，没有则填0 |
|
requestCnt |
1.0 |
请求记录条数，产品定义（暂定10条） |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
userList |
1.0 |
用户列表，item为UserInfo结构 PS：UserInfo需要返回可选字段followStatus |
|
offset |
1.0 |
当前列表的最后一条，用于下次查询的起始偏移baseOffset |
|
isEnd |
1.0 |
当前结果之后没有更多，取值0、1 |
4 接口：直播相关（live/）
4.1 获取合作媒体（live/getLiveCompany）
功能
获取直播页面的合作企业
权限
全部用户（不需要登录）
方式
POST
域名
http://.../live/getLiveCompany
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
无 |
|
|
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
companyList |
1.0 |
企业列表，item为CompanyInfo结构 |
4.2 获取首页直播（live/getHpLiveVideo）
功能
获取VR直播首页的直播，包括推荐和热门
权限
全部用户（不需要登录）
方式
POST
域名
http://.../live/getHpLiveVideo
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
无 |
|
|
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
recommendList |
1.0 |
推荐直播列表，item为LiveVideoInfo结构 |
4.3 分页拉取直播列表（live/listLiveVideo）
功能
分页拉取直播列表，用于直播首页拉取更多
权限
全部用户（不需要登录）
方式
POST
域名
http://.../live/listLiveVideo
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
type |
1.0 |
直播类型，取值 1：推荐直播 其他：不支持 |
|
baseOffset |
1.0 |
分页起始偏移，上一次查询返回的offset，没有则填0 |
|
requestCnt |
1.0 |
请求记录条数，产品定义（暂定10条） |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
liveVideoList |
1.0 |
直播列表，item为LiveVideoInfo结构 |
|
offset |
1.0 |
当前列表的最后一条，用于下次查询的起始偏移baseOffset |
|
isEnd |
1.0 |
当前结果之后没有更多，取值0、1 |
4.4 分页拉取合作媒体直播列表 (live/listCompanyLiveVideo）
功能
分页拉取指定合作媒体的直播列表
权限
全部用户（不需要登录）
方式
POST
域名
http://.../live/listCompanyLiveVideo
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
companyID |
1.0 |
合作媒体ID |
|
baseOffset |
1.0 |
分页起始偏移，上一次查询返回的offset，没有则填0 |
|
requestCnt |
1.0 |
请求记录条数，产品定义（暂定10条） |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
liveVideoList |
1.0 |
直播列表，item为LiveVideoInfo结构 |
|
offset |
1.0 |
当前列表的最后一条，用于下次查询的起始偏移baseOffset |
|
isEnd |
1.0 |
当前结果之后没有更多，取值0、1 |
4.5 创建直播（live/createLiveVideo）
功能
创建直播
权限
登录用户
方式
POST
域名
http://.../live/createLiveVideo
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
title |
1.0 |
直播标题 |
|
imageUrl |
1.0 |
封面url |
|
location |
1.0 |
直播地址位置，用户屏蔽则填空 |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
liveVideoID |
1.0 |
直播视频ID |
|
rtmpUrl |
1.0 |
推流地址 |
|
playUrl |
1.0 |
播放地址 |
4.6 关闭直播（live/closeLiveVideo）
功能
关闭直播
权限
登录用户
方式
POST
域名
http://.../live/closeLiveVideo
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
liveVideoID |
1.0 |
直播ID |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 1：失败，非自己创建的直播 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
无 |
|
|
4.7 观看/退出观看直播（live/watchLiveVideo）
功能
观众观看或则退出观看直播，用于上报状态给服务器
权限
全部用户（不需要登录）
方式
POST
域名
http://.../live/watchLiveVideo
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
liveVideoID |
1.0 |
直播ID |
|
set |
1.0 |
操作方式，取值 0：退出观看直播 1：进入观看直播 |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
无 |
|
|
4.8 点赞直播（live/likeLiveVideo）
功能
观众观看直播时点赞
权限
登录用户
方式
POST
域名
http://.../live/likeLiveVideo
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
liveVideoID |
1.0 |
直播ID |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
newLikeCnt |
1.0 |
点赞后新的点赞总数 |
5 接口：点播相关（vod/）
5.1 获取首页点播（vod/getHpVodVideo）
功能
获取点播首页的点播，包括推荐和热门
权限
全部用户（不需要登录）
方式
POST
域名
http://.../vod/getHpVodVideo
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
无 |
|
|
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
recommendList |
1.0 |
推荐点播列表，item为VodVideoInfo结构 |
|
newList |
1.0 |
最新点播列表，item为VodVideoInfo结构 |
5.2 分页拉取点播列表（vod/listVodVideo）
功能
分页拉取点播列表
权限
全部用户（不需要登录）
方式
POST
域名
http://.../vod/listVodVideo
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
type |
1.0 |
点播类型，取值 1：推荐点播 2：最新点播 其他：不支持 |
|
baseOffset |
1.0 |
分页起始偏移，上一次查询返回的offset，没有则填0 |
|
requestCnt |
1.0 |
请求记录条数，产品定义（暂定10条） |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
vodVideoList |
1.0 |
点播列表，item为VodVideoInfo结构 |
|
offset |
1.0 |
当前列表的最后一条，用于下次查询的起始偏移baseOffset |
|
isEnd |
1.0 |
当前结果之后没有更多，取值0、1 |
5.3 搜索点播（vod/searchVodVideo）
功能
通过标题，搜索点播，分页返回
权限
全部用户（不需要登录）
方式
POST
域名
http://.../vod/searchVodVideo
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
keyword |
1.0 |
搜索关键字 |
|
baseOffset |
1.0 |
分页起始偏移，上一次查询返回的offset，没有则填0 |
|
requestCnt |
1.0 |
请求记录条数，产品定义（暂定10条） |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
vodVideoList |
1.0 |
点播列表，item为VodVideoInfo结构 |
|
offset |
1.0 |
当前列表的最后一条，用于下次查询的起始偏移baseOffset |
|
isEnd |
1.0 |
当前结果之后没有更多，取值0、1 |
5.4 联想推荐点播（vod/suggestVodVideo）
功能
当用户正在看某一个点播的时候，播放页面会有一个推荐列表（猜你喜欢），系统推荐相关的点播，暂定10条记录一次过全部返回，不分页。推荐算法，产品来定。
权限
全部用户（不需要登录）
方式
POST
域名
http://.../vod/suggestVodVideo
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
vodVideoID |
1.0 |
用户正在看的点播 |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
vodVideoList |
1.0 |
点播列表，item为VodVideoInfo结构 |
5.5 拉取某人的点播（vod/listUserVodVideo）
功能
进入某用户的profile页，拉取他发布的点播列表，分页拉取
权限
全部用户（不需要登录）
方式
POST
域名
http://.../vod/listUserVodVideo
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
ownerUserID |
1.0 |
点播属于的用户ID |
|
baseOffset |
1.0 |
分页起始偏移，上一次查询返回的offset，没有则填0 |
|
requestCnt |
1.0 |
请求记录条数，产品定义（暂定10条） |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
vodVideoList |
1.0 |
点播列表，item为VodVideoInfo结构 |
|
offset |
1.0 |
当前列表的最后一条，用于下次查询的起始偏移baseOffset |
|
isEnd |
1.0 |
当前结果之后没有更多，取值0、1 |
5.6 点赞点播（vod/likeVodVideo）
功能
点赞点播
权限
登录用户
方式
POST
域名
http://.../live/likeLiveVideo
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
vodVideoID |
1.0 |
点播ID |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
newLikeCnt |
1.0 |
点赞后新的点赞总数 |
6 接口：消息相关（message/）
...待定
7 接口：七牛相关（qiniu/）
7.1 获取上传文件名（qiniu/getQiniuSign）
功能
用户上传文件到七牛前，通过业务服务器获得七牛的签名和上传文件名
说明：不同类型的文件，如用户头像、封面图，需要放到七牛不同的空间
参考：
http://developer.qiniu.com/code/v7/sdk/android.html
http://developer.qiniu.com/code/v7/sdk/objc.html
http://developer.qiniu.com/code/v7/sdk/php.html
权限
登录用户
方式
POST
域名
http://.../qiniu/getQiniuSign
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
type |
1.0 |
资源类型，用于控制不同类型的文件放到七牛不同的空间，取值 1：用户头像 2：直播封面图 3：点播封面图 4：点播视频文件（待定：点播文件可能不会用手机上传？） |
|
fileSize |
1.0 |
上传文件大小（单位字节） |
|
suffix |
1.0 |
文件类型的后缀，如png、jpg、mp4 |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 1：失败，文件太大 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
bucket |
1.0 |
上传空间的名称 |
|
uploadToken |
1.0 |
上传的token |
|
uploadName |
1.0 |
上传文件名 |
|
url |
1.0 |
最终文件上传完后，外网下载的链接，有后台服务器去拼url |
8 接口：公共模块（public/）
8.1 获取banner（public/getBanner）
功能
获得不同页面的banner
权限
全部用户（不需要登录）
方式
POST
域名
http://.../public/getBanner
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
type |
1.0 |
获取banner位置，取值 live：直播首页 vod：点播首页 company：合作媒体 |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
bannerList |
1.0 |
Banner列表，item为BannerInfo结构 |
8.2 搜索关键词推荐（public/suggestSearchKeyword）
功能
搜索的时候，在输入框输入关键字的时候，推荐联想词，暂定最多返回10条
举例：如输入苹果，推荐联想词“苹果派”、“吃苹果美女”，词库来源由产品定义
权限
全部用户（不需要登录）
方式
POST
域名
http://.../public/suggestSearchKeyword
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
keyword |
1.0 |
搜索关键字 |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
suggestList |
1.0 |
联想词列表，item为字符串 |
8.3 举报（public/reportIllegal）
功能
举报非法内容
权限
全部用户（不需要登录）
方式
POST
域名
http://.../public/reportIllegal
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
type |
1.0 |
举报类型，取值 user：举报用户 liveVideo：直播视频 vodVideo：点播视频 |
|
targetID |
1.0 |
对应举报目标的ID type=user时，对应userID type= liveVideo时，对应liveVideoID type=vodVideo时，对应vodVideoID |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
无 |
|
|
8.4 反馈（public/feedback）
功能
用户上报反馈意见
权限
全部用户（不需要登录）
方式
POST
域名
http://.../public/feedback
参数
|
字段 |
引入版本 |
描述 |
|
公共参数 |
||
|
… |
1.0 |
见上 |
|
定制参数 |
||
|
content |
1.0 |
反馈意见 |
|
contact |
1.0 |
联系方式 |
响应
|
字段 |
引入版本 |
描述 |
|
结果rtn |
||
|
rtn |
1.0 |
结果码，取值 0：成功 其他：失败 |
|
msg |
1.0 |
见上 |
|
结果data |
||
|
无 |
|
|
发表评论