《API需求文档》word版.docx_第1页
《API需求文档》word版.docx_第2页
《API需求文档》word版.docx_第3页
全文预览已结束

下载本文档

版权说明：本文档由用户提供并上传，收益归属内容提供方，若内容存在侵权，请进行举报或认领

文档简介

APP端API需求文档V1.0版 说明，V1.0共设计四类接口，分别包括注册与登录、用户信息相关、直播相关、搜索相关、消息相关。具体如下面所述。一、 注册与登录1. 注册1.1通过手机号注册1.1.1发送验证码？发送参数：手机号返回参数：成功1、失败01.1.2通过手机号注册发送参数：手机号、验证码、昵称、头像、性别等返回参数：成功1、失败02. 登录2.1通过微信登录发送参数：用户openid（用户通过Oauth认证后微信返回的唯一标示）、昵称、头像、性别、国家、省、市等。 返回参数：成功或者失败2.2通过手机号登录发送参数：手机号、密码返回参数：成功1、失败03. 找回密码3.1发送验证码发送参数：手机号返回参数：成功1、失败03.2找回密码发送参数：手机号、验证码、新的密码返回参数：成功1、失败0二、 用户信息说明：用户资料包括ID、头像、昵称、性别、说明、手机号码、个人标签、获得赞数、直播数、粉丝数、关注数，其中不可编辑的是ID、获得赞数、直播数、粉丝数、关注数1. 获取用户资料发送参数：手机号码或者openid返回参数：如上的用户信息参数2. 编辑用户资料头像修改与上传，昵称修改，性别修改，说明修改，手机号码修改，个人标签添加发送参数：头像image、昵称、性别、说明、手机号码、个人标签等返回参数：成功1、失败0 3. 获取与某位用户的关系（是否关注）发送参数：当前用户ID以及目标用户ID返回参数：关注1、未关注04. 关注与取消关注发送参数：当前用户ID以及目标用户ID返回参数：成功1、失败05. 获取某位用户直播回放列表（缩略图、标题、时长、发布时间、观看人数）发送参数：用户ID返回参数：总数、直播列表6. 获取某位用户关注列表（头像、用户名、关注）发送参数：用户ID返回参数：总数、关注的用户列表7. 获取某位用户粉丝列表（头像、用户名、关注）发送参数：用户ID返回参数：总数、粉丝列表三、 直播1. 发布预告发送参数：标题、直播时间、封面、直播分类、私密直播（公开、好友可见、仅自己可见）返回参数：插入之后对应的ID（chat_config）、失败02. 开启直播2.1设置标题及封面，设置成功将创建一个活动发送参数：标题、直播时间、封面、直播分类、私密直播（公开、好友可见、仅自己可见）返回参数：插入或者更新之后对应的ID、失败02.2开始直播（推流），更新流信息发送参数：stream，更新到chat_config表中返回参数：成功1、失败02.3点赞发送参数：对应直播信息的ID返回参数：点赞数2.4获取赞数、观看用户数发送参数：对应直播信息的ID返回参数：点赞总数、观看的用户总数四、 搜索1. 搜索直播标题或者用户名发送参数：关键字（用于搜索活动/直播名称或者用户）返回参数：返回对应的活动/直播或者用户对应的直播五、 消息相关1. 直播内即时消息（发送或者接收，socket）2
人人文库> 全部分类> 应用文书 > 事务文书

温馨提示

  • 1. 本站所有资源如无特殊说明，都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等，如果需要附件，请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸，网页内容里面会有图纸预览，若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间，仅对用户上传内容的表现方式做保护处理，对用户上传分享的文档内容本身不做任何修改或编辑，并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容，请与我们联系，我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

最新文档

评论

0/150

提交评论