IT项目管理接口文档

接口文档

修改记录

接口

登录注册

登录

前端发送

{
    func:"login"
    usn:"",
    password:""
}

后台回复
成功时：

{
    status:1,
    accessToken:""
}

不成功时：

{
    status:0,
    error:""//错误信息，比如用户不存在或者密码错误
}

注册

前端发送：

{
    func:'signin',
    usn:'',
    password:'',
}

后台回复
成功时：

{
    status:1,
    accessToken:"",
    user_id:''
}

不成功时：

{
    status:0,
    error:""//错误信息，比如用户名重复
}

聊天室

进入聊天室

前端发送

{
    func:'getRoomUser',//获取聊天室用户列表
    user:'',
    accessToken:''
}

后台回复

{
        status:0/1,//成功或失败
        type:'roomUserResponse',//信息类型为返回聊天室用户列表
        userList:[],//用户列表
        error:''//如果失败，这里保存错误信息
}

上面的接口中用户列表的元素的格式是

{
    name:'',
    id:''
}

新的用户进入聊天室

后台发送

{
    type:'newRoomUser',
    userList:[]//当前的用户列表
}

上面的接口中用户列表的元素的格式是

{
    name:'',
    id:''
}

发送信息

前端发送

{
    func:'send',
    type:'room',//聊天室类型
    time:'',//具体日期格式需要商量
    accessToken:'',
    user:''//user_id,独立唯一的用户标识,
    content:''//发送的信息内容,
    id:''//标志信息的id,后台无需处理，在反馈时原样回复
}

后台回复

{
    status:0/1,//成功或失败
    type:'sendResponse'//信息类型为发送回执
    id:''//对应信息的id，包含在前端的请求中的,
    error:''//如果失败，这里保存错误信息
}

接受信息

每当有新用户发言时，后台要向每个websocket链接推送新的消息
后台向前端推送：

{
    type:'newRoomData'//信息类型为新的聊天室记录
    data:[]//一个数据，每一个元素是一条聊天记录
}

上面列出来的聊天记录的结构如下：

{
    user_id:'',//用户的唯一标识
    user_name:'',//用户名
    text:'',//信息的内容
    time:''//发送信息的时间
}

好友管理

添加好友

前端发送

{
    func:'addFriend',
    user:""//这里传的是user name不是user id,
    accessToken:""
}

后台回复

{
    type:'addFriendReponse'
    status:1/0,
    error:出错时的错误原因,
    friendList:[]//当前的用户列表
}

删除好友

前端发送

{
    func:'deleteFriend',
    user://这里传的是user_id,
    accessToken:""
}

后台回复

{
    type:'deleteFriendReponse'
    status:1/0,
    error:出错时的错误原因,
    friendList:[]//当前的用户列表
}

一对一聊天

发送信息

{  
    func:"sendMessageTo",
    to_user:""//接收方的user_id,
    from_user:""//发送方的user_id,
    text:""//发送的内容，
    accessToken:""
}

收到信息

{
    type:"receiveMessageFrom",
    to_user:""//接收方的user_id,
    from_user:""//发送方的user_id,
    text:""//发送的内容，
}

获取好友列表

前端发送

{
    func:"getFriendList",
    user:""//user_id,
    accessToken:""
}

后台回复

{
    type:'getFriendReponse'
    status:1/0,
    error:出错时的错误原因,
    friendList:[]//用户列表
}