《api需求文档》word版

《《api需求文档》word版》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、《APP端》API需求文档V1.0版说明，V1.0共设计四类接口，分别包括注册与登录、用户信息相关、直播相关、搜索相关、消息相关。具体如下面所述。一、注册与登录1.注册1.1通过手机号注册1.1.1发送验证码？发送参数：手机号返回参数：成功1、失败01.1.2通过手机号注册发送参数：手机号、验证码、昵称、头像、性别等返回参数：成功1、失败02.登录2.1通过微信登录发送参数：用户openid（用户通过Oauth认证后微信返回的唯一标示）、昵称、头像、性别、国家、省、市等。返回参数：成功或者失败2.2通过手机号登录发送参

2、数：手机号、密码返回参数：成功1、失败03.找回密码3.1发送验证码发送参数：手机号返回参数：成功1、失败03.2找回密码发送参数：手机号、验证码、新的密码返回参数：成功1、失败0二、用户信息说明：用户资料包括ID、头像、昵称、性别、说明、手机号码、个人标签、获得赞数、直播数、粉丝数、关注数，其中不可编辑的是ID、获得赞数、直播数、粉丝数、关注数1.获取用户资料发送参数：手机号码或者openid返回参数：如上的用户信息参数1.编辑用户资料头像修改与上传，昵称修改，性别修改，说明修改，手机号码修改，个人标签添加发送参数：

3、头像image、昵称、性别、说明、手机号码、个人标签等返回参数：成功1、失败02.获取与某位用户的关系（是否关注）发送参数：当前用户ID以及目标用户ID返回参数：关注1、未关注03.关注与取消关注发送参数：当前用户ID以及目标用户ID返回参数：成功1、失败04.获取某位用户直播回放列表（缩略图、标题、时长、发布时间、观看人数）发送参数：用户ID返回参数：总数、直播列表5.获取某位用户关注列表（头像、用户名、关注）发送参数：用户ID返回参数：总数、关注的用户列表6.获取某位用户粉丝列表（头像、用户名、关注）发送参数：用户

4、ID返回参数：总数、粉丝列表一、直播1.发布预告发送参数：标题、直播时间、封面、直播分类、私密直播（公开、好友可见、仅自己可见）返回参数：插入之后对应的ID（chat_config）、失败02.开启直播2.1设置标题及封面，设置成功将创建一个活动发送参数：标题、直播时间、封面、直播分类、私密直播（公开、好友可见、仅自己可见）返回参数：插入或者更新之后对应的ID、失败02.2开始直播（推流），更新流信息发送参数：stream，更新到chat_config表中返回参数：成功1、失败02.3点赞发送参数：对应直播信息的ID返

5、回参数：点赞数2.4获取赞数、观看用户数发送参数：对应直播信息的ID返回参数：点赞总数、观看的用户总数一、搜索1.搜索直播标题或者用户名发送参数：关键字（用于搜索活动/直播名称或者用户）返回参数：返回对应的活动/直播或者用户对应的直播二、消息相关1.直播内即时消息（发送或者接收，socket）2.系统消息发送参数：返回参数：消息列表如标题、时间、作者等3.意见反馈发送参数：手机号、邮箱、内容返回参数：成功1，失败0