接口入参返回值说明文档

环境地址

日常环境： https://www-daily.youngget.com
预发环境：https://www-pre.youngget.com

参数格式说明

  1. {
  2.     name: string       // 参数名：name ; 类型：string;   必填参数
  3.     age?: number       // 参数名：age  ; 类型：number;   可选参数 
  4. }

返回格式：

success：请求是否成功
content：返回结果（预期返回值or错误信息）
errorLevel: 错误级别
errorCode：错误类型
errorMsg：错误信息

请求成功：

{
“success”: true,
“content”: {
“room_info”: [
{
“id”: “1ec81b1fd79011e89fd50506ce178f4d”,
“room_id”: “12e1a5d4d79011e89fd50506ce178f4d”,
“room_img”: “https://yg-basedata.oss-cn-hangzhou.aliyuncs.com/onlinePicture/1542182318491-6“,
“room_no”: “1006”,
“name”: “房间名称1006”
}
]
}
}

请求失败：

示例：
{
“success”: false,
“content”: {
“errors”: {
“id”: [
“The id field is required.”
]
}
},
“errorLevel”: “error”,
“errorCode”: “ERR$PARAM”,
“errorMsg”: “参数错误”
}

发送短信sdk

sdkNum:
0:阿里云SMS
1：网易

音视频接口

1、初始化房间

请求路径：/rest/room/init

  1. interface IN {
  2.     uid: string                 // 用户ID
  3.     roomid: string              // 房间ID
  4. }
  6. interface OUT {
  7.     code: number                 // 状态码
  8.     member: string[]             // 房间内成员
  9.     online: string[]             // 连麦列表
  10.     option: {
  11.         account: string          // 房间账号
  12.         appkey: string           // key值
  13.         token: string            // token值
  14.     }
  15.     queue: string[]              // 排麦数组
  16.     role: number                 // 用户在房内的角色
  17.     roomKine: string             // 房间类型
  18.     room_no: string              // 房间账号
  19.     self: {                      // 有关自己的信息
  20.         account_no: string       // 账号
  21.         avatar: string           // 头像
  22.         id: string               // ID
  23.         nick_name: string        // 昵称
  24.         role: string             // 用户在房内的角色
  25.         roomid: string           // 房间ID
  26.     }
  27. }

2、获取连麦列表

请求路径：/rest/room/linkMicrophoneList

  1. interface IN {
  2.     roomid: string             // 房间ID
  3. }
  5. interface OUT {
  6.     sucess:boolean             // 请求状态
  7.     code: number               // 状态码
  8.     online:{
  9.         uid: string            // 用户id
  10.         SN: number             // 麦号
  11.         avatar: string         // 用户头像
  12.         account_no: string     // 用户账号
  13.         nick_name: string      // 用户昵称
  14.         role: number           // 角色
  15.     }[]
  16. }

3、上麦

请求路径：/rest/room/openMicrophone

  1. interface IN {
  2.     uid: string             // 用户ID
  3.     roomid: string          // 房间ID
  4.     room_no: string         // 房间账号
  5.     SN: string              // 麦序号
  6. }
  8. interface OUT {
  9.     success: boolean        // 请求的处理状态
  10.     code: number            // 返回的是麦序号
  11. }

4、下麦

请求路径：/rest/room/closeMicrophone

  1. interface IN {
  2.     uid: string          // 用户ID
  3.     roomid: string       // 房间ID
  4. }
  6. interface OUT {
  7.     sucess: boolean      // 请求状态
  8.     code: number         // 状态码
  9. }

5、从连麦列表中删除

请求路径：/rest/room/deleteFromList

  1. interface IN {
  2.     uid: string              // 用户ID
  3.     roomid: string           // 房间ID
  4.     targetUid: string        // 被删除的用户ID
  5. }
  7. interface OUT {
  8.     sucess: boolean          // 请求状态
  9.     code: number             // 状态码
  10. }

6、踢麦

请求路径：/rest/room/forceDisconnect

  1. interface IN {
  2.     uid: string           // 用户ID
  3.     roomid: string        // 房间ID
  4.     room_no: string       // 房间账号
  5.     SN: string            // 麦序号
  6.     kickedid: string      // 被踢麦者ID
  7. }
  9. interface OUT {
  10.     sucess: boolean       // 请求状态
  11.     code: number          // 状态码
  12. }

7、抱麦

请求路径：/rest/room/inviteLinkMicrophone

  1. interface IN {
  2.     uid: string       // 用户ID
  3.     roomid: string    // 房间ID
  4.     sm_uid: string    // 上麦用户ID
  5.     xm_uid: string    // 下麦用户ID
  6.     sm_SN: string     // 上麦麦序号
  7. }
  9. interface OUT {
  10.     sucess: boolean   // 请求状态
  11.     code: number      // 状态码
  12. }

8、邀请抱麦结果

请求路径：/rest/room/inviteAnswer

  1. interface IN {
  2.     uid: string          // 用户ID
  3.     roomid: string       // 房间ID
  4.     isAgree: boolean     // 是否同意
  5.     SN: string           // 麦序号
  6.     bmuid: string        // 被抱麦的用户
  7. }
  9. interface OUT {
  10.     sucess: boolean       // 请求状态
  11.     code: number          // 状态码
  12. }

9、上/排麦

请求路径：/rest/room/openOrWaitMicrophone

  1. interface IN {
  2.     uid: string          // 用户ID
  3.     roomid: string       // 房间ID
  4. }
  6. interface OUT {
  7.     sucess: boolean      // 请求状态
  8.     code: number         // 状态码
  9. }

10、房间公告

请求路径：/rest/room/roomNotice

  1. interface IN {
  2.     uid: string         // userid
  3.     roomid: string      // 房间ID
  4. }
  6. interface OUT {
  7.     sucess: boolean     // 请求处理是否成功
  8.     code: number        //
  9.     data: {             // 请求返回的内容
  10.         notice: string  // 房间公告
  11.         notice_url      // 房间公告链接
  12.     }
  13. }

首页接口

1、推荐教练

请求路径：/rest/home/recommendCoach

  1. interface IN {   
  2.     id: string          // 推荐表自增id
  3. }
  5. interface OUT {
  6.     room_id: string       // 房间id
  7.     room_img: string      // 房间图片
  8.     nick_name: string     // 用户（教练）昵称
  9.     avatar: string        // 教练头像
  10.     user_account: number  // 教练账号
  11.     desc: string          // 推荐介绍
  12. }

2、推荐课程

请求路径：/rest/home/recommendCourse

  1. interface IN {
  2.     id: string              // 推荐表自增id
  3. }
  5. interface OUT {
  6.     room_id: string         // 房间id
  7.     room_no: number         // 房间账号
  8.     room_name: string       // 房间名称
  9.     room_img: string        // 房间图片
  10.     desc: string            // 推荐介绍
  11. }

3、推荐房间（待定）

请求路径：/rest/home/recommendRoom

个人中心接口

1、个人中心（获取个人资料）

请求路径：/rest/ucenter/userCenter/userCenter

  1. interface IN {
  2.     id: string              // 用户ID
  3. }
  5. interface OUT {
  6.     avatar: string          // 头像图片url
  7.     account_no: number      // 用户账号,
  8.     nick_name: string       // 昵称
  9.     mobile: string          // 手机号
  10.     birthday: string        // 生日
  11.     sex: number             // 性别
  12.     area_code: string       // 地区国标编码
  13.     sign: string            // 签名
  14.     type: number            // 用户类型
  15. }

2、保存个人资料（更新）

请求路径：/rest/ucenter/userCenter/savePersonalInfo

  1. interface IN {
  2.     id: string                // 用户ID
  3.     account_no: number        // 用户账号
  4.     nick_name: string         // 昵称
  5.     birthday: string          // 生日
  6.     sex: number               // 性别
  7.     area_code: string         // 地区国标编码
  8.     detailed_address: string  // 详细地址
  9. }

3、修改密码

请求路径：/rest/ucenter/userCenter/changePassword

  1. interface IN {
  2.     id: string              // 用户ID
  3.     code: string            // 验证码
  4.     firstPassword: string   // 第一个密码
  5.     secondPassword: string  // 第二个密码
  6. }

4、修改手机号

请求路径：/rest/ucenter/userCenter/changePhone

  1. interface IN {
  2.     id: string                // 用户ID
  3.     newMobile: string         // 新手机
  4.     newMobileCode: string     // 新手机验证码
  5. }

5、获取手机号

请求路径：/rest/ucenter/userCenter/getPhone

  1. interface IN {
  2.     id: string    // 用户ID
  3. }
  5. interface OUT {
  6.     mobile: string  // 手机号
  7. }

6、修改头像

请求路径：/rest/ucenter/userCenter/user/headerPortrait

  1. interface IN {
  2.     id: string               // 用户ID
  3.     account_no: number       // 用户账号
  4.     avatar: string           // 头像地址
  5. }

7、生成oss密钥

请求路径：/rest/ucenter/userCenter/ossGet

  1. interface IN {
  2. }
  4. interface OUT {
  5.     OSSAccessKeyId: string    // key值
  6.     host: string              // host
  7.     policy: string            // 生效时段
  8.     signature: string         // 秘钥
  9.     saveName: number          // 上传文件名
  10.     startsWith: string        // 上传路径
  11. }

登录注册接口

1、注册

请求路径：/rest/ucenter/identity/register

  1. // 输入定义
  2. interface IN {
  3.     phone: string      // 手机号
  4.     code: string       // 验证码
  5.     password: string   // 密码
  6. }
  8. // 输出定义
  9. interface OUT {
  10.     id: string         // 用户ID
  11.     account_no: number // 用户账号
  12.     avatar: string     // 头像
  13. }

2、账号/手机号密码登录

请求路径：/rest/ucenter/identity/loginByPassword

  1. interface IN {
  2.     account: number     // 账号
  3.     password: string    // 密码
  4. }
  7. interface OUT {
  8.     account_no: number   // 用户账号
  9.     avatar: string       // 头像图片url
  10. }

3、手机号验证码登录

请求路径：/rest/ucenter/identity/loginByCode

  1. interface IN {
  2.     mobile: string     // 手机号
  3.     code: string       // 验证码
  4. }
  6. interface OUT {
  7.     account_no: number // 用户账号
  8.     avatar: string     // 头像图片url
  9. }

4、登出

请求路径：/rest/ucenter/identity/logOut

  1. type IN = void

5、忘记密码

请求路径：/rest/ucenter/identity/forgetPassword

  1. interface IN {
  2.     mobile: string           // 手机号
  3.     code: string             // 验证码
  4.     firstPassword: string    // 密码
  5.     secondPassword: string   // 确认密码
  6. }
  8. type OUT = void

6、注册获取验证码

请求路径：/rest/ucenter/identity/registerGetCode

  1. interface IN {
  2.     phone: string     // 手机号
  3.     sdkNum: number    // 第几次发送
  4. }
  6. type OUT = void

7、登录获取验证码

请求路径：/rest/ucenter/identity/loginGetCode

  1. interface IN {
  2.     phone: string   // 手机号
  3.     sdkNum?: number // 选择sdk
  4. }
  6. type OUT = void

8、修改手机号获取验证码

请求路径：/rest/ucenter/identity/changePhoneGetCode

  1. interface IN {
  2.     sdkNum: number  // 选择sdk
  3. }
  5. type OUT = void

9、修改密码获取验证码

请求路径：/rest/ucenter/identity/changePasswordGetCode

  1. interface IN {
  2.     sdkNum: number         // 选择sdk
  4. }
  6. type OUT = void

�

CODE整理：

  1. SUCCESS: 1,                         // 执行成功
  2. FAILED: -1,                         // 执行失败
  3. OPENWAIT_VISITOR: -662,             // 上排麦-用户为游客
  4. OPENWAIT_NOT_ALLOW: -1,             // 上排麦-不允许上排麦
  5. ANSWER_NOT_AGREE: -22,              // 抱麦答复-不同意被抱上麦
  6. FORCE_NOT_ON: -2,                   // 提麦-用户当前不在麦上
  7. INIT_NOT_PRIVATE: -262,             // 房间初始化-非教学房间，不予处理
  8. INIT_NOT_EXIST: -162,               // 房间初始化-redis缓存中无此房间
  9. CLOSE_ON_LINK_LIST: 1,              // 下麦-在连麦队列
  10. CLOSE_REMOVE: 2,                    // 下麦-从列表移除
  11. CLOSE_ON_WAIT_LIST: 3,              // 下麦-在排麦队列
  12. OPEN_ALREADY: -123,                 // 上麦-用户已在麦上
  13. OPEN_REDIS_EXCEPTION: -1234         // 上麦-redis操作异常

枚举值：

用户类型（0 普通用户 1 教练） 状态（0有效 1无效）:包括用户、房间、课程、教练、推荐房间、推荐课程、推荐教练，用于假删除 性别（0 男 1女 2 其他） 房间付费标志（ 0 普通 1 VIP）： 房间类型（0活动房间 1教学房间） 视频的分辨率 （可能值：‘480P’，‘720P’）
配置类型（0 推荐房间 1 明星教练 2精品课程）

全局变量：

  1. /**
  2.  * 全局常量定义
  3.  */
  4. export const GCONST = Object.freeze({
  5.     invalidRoomid:101, //roomid对应的房间不存在
  6.     noPrivilegeOfCreateRoom:102,//uid用户无权创建roomid房间
  7.     hasPrivilegeOfCreateRoom:103,//uid用户有权创建roomid房间
  8.     noPrivilegeOfJoinRoom:104,//uid用户无权加入roomid房间
  9.     hasPrivilegeOfJoinRoom:105,//uid用户有权加入roomid房间
  11.     noPrivilegeOfSM:106, //uid用户无权在roomid房间上 连麦列表
  12.     snNotEmptyOfSM:107,  //roomid房间的第SN个麦 当前不是空闲状态
  13.     canSM:108, //可以上麦
  15.     roomKindOfTeach:1,//m_room房间表 kind 字段 教学房间
  16.     roomKindOfLive:0, //m_room房间表 kind 字段 活动房间[娱乐直播 带 合流 旁路直播]
  18.     waitingCreated:201,//用于 redis 缓存中 房间状态status；等待被创建[通过第三方SDK]
  19.     hasCreated:202,//用于 redis 缓存中 房间状态status；已经创建[通过第三方SDK]
  21.     roleInRoom_MainTeacher:1,//用户在房间内的角色 - 主教练【房主】
  22.     roleInRoom_Assistant:2,//用户在房间内的角色 - 副教练【副房主】
  23.     roleInRoom_Student:3,//用户在房间内的角色 - 学员[可上麦]
  24.     roleInRoom_Audience:4,//用户在房间内的角色 -一般注册用户【非学员】
  25.     roleInRoom_Visitor:5, //用户在房间内的角色 -游客[不可上麦]
  28.     eventPMDel:1, //排麦列表删除 srv->cli
  29.     eventLMDel:2, //连麦列表删除 srv->cli
  30.     eventPMAdd:3, //排麦列表添加 srv->cli
  31.     eventLMAdd:4, //连麦列表添加 srv->cli
  32.     cmdKick:5,    //踢麦命令    srv->cli
  33.     cmdBM:6,      // srv->cli 被抱麦 
  34.     cmdKickOfBm:7,  //srv->cli 通知由于抱麦命令而被踢麦的用户下麦
  35.     eventNewNotice:8, //房间公告刷新
  37.     eventMemberDel:11, //成员列表删除 srv->cli
  38.     eventMemberAdd:12, //成员列表添加 srv->cli
  40.     lm_max:3, //最大连麦数量
  42.     rCodeSmOkOne:1,
  43.     rCodeSmOkTwo:2,
  44.     rCodeSmOkThree:3,
  45.     rCodeSmFailure:-1,
  46.     rCodeSmOkFour:4,
  48.     theEnd:62,
  50.     shouldIN:1,   //应接收登录消息抄送
  51.     shouldOUT:2,  //应接收登出消息抄送
  52.     shouldNONE:3, //不应接收任何消息抄送
  53. });