一、文档说明

1、写在前面2、错误代码表

二、用户接口

1、发送邮箱验证码接口2、用户登录接口3、获取我的个人信息接口4、修改我的资料接口5、临时用户相关说明6、获取指定用户个人资料接口7、禁言用户接口8、禁止用户点歌接口9、取消用户的禁言和禁歌10、摸一摸用户接口11、第三方登录接口

三、房间接口

1、获取热门房间接口2、获取房间详情接口3、获取房间在线人员列表4、修改房间信息接口5、获取指定房间当前正在播放音乐接口6、获取聊天室指定房间的历史记录7、撤回消息接口

四、歌曲接口

1、歌曲搜索接口2、获取LRC歌词接口3、歌曲播放地址跳转地址4、管理员或房主切歌接口5、用户点歌接口6、指定房间当前的已点歌曲列表7、将已点歌曲列表中指定歌曲置顶8、管理或房主移除已点歌曲接口9、获取我点过的歌列表接口10、从我的歌单删除歌曲接口

五、Websocket

1、获取Websocket连接地址2、发送文字消息接口3、发送图片消息接口4、WebSocket消息解析说明文档

六、图片接口

1、搜索图片表情包2、上传图片接口

七、第三方合作接口

1、第三方接入聊天室使用手册与帮助文档2、聊天室绑定第三方独立域名

八、下载相关

1、Windows客户端下载

九、部署相关

0、写在最前面1、部署API端步骤说明2、部署Websocket服务端步骤3、部署最后的前端部分
3、获取我的个人信息接口
手机阅读

扫描二维码阅读文章

本文档由 Tester 自动生成,最后修改时间 2020-09-04 00:36:19

一、接口说明

你可以在这里对接口进行一些简单的描述

二、请求方式

POST https://api.bbbug.com/api/user/getMyInfo

三、请求参数

字段 类型 必填 示例 说明
access_token string abedefghijkl 登录后的身份凭证
plat string pc -
version number 10000 -

示例JSON:

{
    "access_token": "abedefghijkl",
    "plat": "pc",
    "version": 10000
}

四、更多参数

Headers:

Content-Type:application/json;

五、返回数据

字段 类型 固定 示例值 说明
code number 200 -
msg string -
data object {} -
data.user_id number 10000 用户ID
data.user_parent number 0 邀请人ID
data.user_sex number 1 性别(1男0女)
data.user_account string admin@hamm.cn 邮箱
data.user_touchtip string 帅气的脸庞 摸一摸文案
data.user_name string Hamm 昵称
data.user_head string 头像URL 头像URL
data.user_remark string 用户签名 用户签名
data.user_group number 5 用户组1管理组5普通组
data.user_song number 37 点歌数量
data.user_img number 40 发图数量
data.user_chat number 342 聊天数量
data.user_gamesongscore number 0 猜歌得分
data.user_app number 1 所属应用1为内部应用
data.user_device string MacOS 登录设备
data.app_id number 1 所属应用
data.app_name string BBBUG 应用名称
data.app_url string https://bbbug.com 应用主页
data.app_user number 1 应用所有人
data.app_scope string 应用权限
data.app_status number 0 状态1禁用
data.myRoom object {} 我的房间,null为未创建
data.myRoom.room_id number 888 房间ID
data.myRoom.room_user number 10000 房间所有人
data.myRoom.room_online number 3 在线人数
data.myRoom.room_name string BBBUG点歌音乐房 房间名称
data.myRoom.room_type number 1 房间类型,见房间类型说明
data.myRoom.room_password string 房间是否需要密码
data.myRoom.room_notice string 房间公告 房间公告
data.myRoom.room_order number 1000 排序
data.myRoom.room_reason string 封禁原因 封禁原因
data.myRoom.room_status number 0 状态1被封禁
data.user_admin boolean false 是否管理员
data.user_needmotify boolean false 是否需要提示修改信息

示例返回结果:


{
    "code": 200,
    "msg": "",
    "data": {
        "user_id": 10000,
        "user_parent": 0,
        "user_sex": 1,
        "user_account": "admin@hamm.cn",
        "user_name": "Hamm",
        "user_touchtip": "帅气的脸庞",
        "user_head": "https://api.bbbug.com/uploads",
        "user_remark": "欢迎来BBBUG聊天听歌划水呀~",
        "user_group": 5,
        "user_song": 37,
        "user_img": 40,
        "user_chat": 342,
        "user_gamesongscore": 0,
        "user_app": 1,
        "user_device": "MacOS",
        "app_id": 1,
        "app_name": "BBBUG",
        "app_url": "https://bbbug.com",
        "app_user": 1,
        "app_scope": "",
        "app_status": 0,
        "myRoom": {
            "room_id": 888,
            "room_user": 10000,
            "room_online": 3,
            "room_name": "BBBUG点歌音乐房",
            "room_type": 1,
            "room_password": "",
            "room_notice": "欢迎来到BBBUG,点歌系统升级完成,欢迎来点歌呀",
            "room_order": 10000000,
            "room_reason": "",
            "room_status": 0
        },
        "user_admin": false,
        "user_needmotify": false
    }
}

六、测试用例

https://tester.hamm.cn/#/20200904/4ad229addc934c6ed5aed1f99ef19faffd09d693