@cfygaoyang 2018-02-02T05:39:59.000000Z 字数 25430 阅读 1311

APP 接口文档

小多格

说明：

所有接口header附带 Content-type: application/json（图片上传除外）
当前手机或邮箱测试验证码为 1234
回调信息成功失败校验根据code，0 代表成功

获取 token

请求接口

POST /api/get_token

请求参数

{
    "account": "18656660930",
    "verify_code": "1234",
    "device_name": "jerry",
    "device_type": "ios"
}

参数	类型	必须	说明
account	字符串	是	手机或邮箱
verify_code	字符串	是	验证码

{
    "account": "18656660930",
    "password": "123456"
}

参数	类型	必须	说明
account	字符串	是	手机或邮箱
password	字符串	是	密码

* 请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "token": "eyJ0eXAiOiJKV1QifQ.eyJ1c2VyX2lkIjoxLCJpYXQiOjE1MTEwNjM3NDYsImV4cCI6MTUxMTY2ODU0Nn0.JDJ5JDEwJDhPRmwwTjVyLlBuN1k1bFJzbEFaOC44dE9qaUpia2kzZTNxMzltNkFNeVZFaFZWaGQwR3lx",
        "expire_in": 604800
    }
}

参数	类型	说明
token	字符串	Authorization : jwt {token}
expire_in	整型	token有效期,单位（秒）

刷新 token

请求接口

PUT /api/refresh_token

请求参数

{
    "token": "1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "token": "eyJ0eXAiOiJKV1QifQ.eyJ1c2VyX2lkIjoxLCJpYXQiOjE1MTEwNjM3NDYsImV4cCI6MTUxMTY2ODU0Nn0.JDJ5JDEwJDhPRmwwTjVyLlBuN1k1bFJzbEFaOC44dE9qaUpia2kzZTNxMzltNkFNeVZFaFZWaGQwR3lx",
        "expire_in": 604800
    }
}

参数	类型	说明
token	字符串	Authorization : jwt {token}
expire_in	整型	token有效期,单位（秒）

获取验证码

请求接口

GET /api/get_verify_code?account={18656660930}

请求参数

参数	类型	必须	说明
account	字符串	是	手机或邮箱

* 请求回调

{
    "code": 0,
    "message": "success! 验证码已发送到您的手机",
    "data": ""
}

设置或修改密码

请求接口

PUT /api/reset_password

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "user_password": "1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

获取个人信息

请求接口

GET /api/user/message/{user_id}

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

参数	类型	必须	说明
user_id	整型	可选	用户id，若无该参数，则获取自己的信息

* 请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "user_message_id": 1,
        "user_name": "可爱的小格多",
        "user_avatar": null,
        "user_sex": 1,
        "user_address": null,
        "user_school": null,
        "user_grade": null,
        "user_class": null,
        "user_studentid": null,
        "user_identity": "0",
        "user_id": 1,
        "created_at": "2017-11-19 11:06:20",
        "updated_at": "2017-11-19 11:06:20",
        "user_telephone": "18656660930",
        "user_email": null,
        "user_password": null
    }
}

编辑个人信息

请求接口

PUT /api/user/message

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "user_name": "可爱的小多格"
}

参数	类型	必须	说明
user_name	字符串	可选	昵称
user_avatar	字符串	可选	头像地址
user_sex	整型（字符串）	可选	性别：0女1男
user_address	字符串	可选	地址
user_school	字符串	可选	学校
user_grade	字符串	可选	班级
user_class	字符串	可选	年级
user_studentid	字符串	可选	学号
user_identity	整型（字符串）	可选	身份：0普通1学生

* 请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "user_message_id": 1,
        "user_name": "可爱的小格多",
        "user_avatar": null,
        "user_sex": 1,
        "user_address": null,
        "user_school": null,
        "user_grade": null,
        "user_class": null,
        "user_studentid": null,
        "user_identity": "0",
        "user_id": 1,
        "created_at": "2017-11-19 11:06:20",
        "updated_at": "2017-11-19 11:06:20",
        "user_telephone": "18656660930",
        "user_email": null,
        "user_password": null
    }
}

手机或邮箱绑定以及更改

请求接口

PUT /api/user/account

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "account": "18656660930",
    "verify_code": "1234"
}

参数	类型	必须	说明
account	字符串	是	手机或邮箱
verify_code	字符串	是	验证码

请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

通过通讯录手机号批量获取用户基础信息列表

请求接口

POST /api/telephone/user/message

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "telephones": "18656660930,18656660931,18656660932"
}

参数	类型	必须	说明
telephones	字符串	是	多个手机号用英文逗号（,）拼接

请求回调

{
    "code": 0,
    "message": "success",
    "data": [用户信息列表，参考个人信息（不包含手机邮箱）]
}

获取关心的人用户信息列表

请求接口

GET /api/user/care

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "care_id": 7,
            "care_user_id": 5,
            "user_id": 5,
            "created_at": "2017-12-09 20:38:30",
            "updated_at": "2017-12-19 16:22:48",
            "care_user_status": 1,
            "care_user_remark_name": null,
            "remark_message": null,
            "is_read": 1,
            "push_switch": 1,
            "user_message_id": 8,
            "user_name": "罗雷",
            "user_avatar": "http://120.78.218.49/img/20171218171820.jpg",
            "user_sex": 0,
            "user_address": null,
            "user_school": "重庆市鲁能巴蜀中学",
            "user_grade": "初一",
            "user_class": "四十五班",
            "user_studentid": "300045",
            "user_identity": "2",
            "identity_change": 1
        },
        {
            "care_id": 38,
            "care_user_id": 9,
            "user_id": 9,
            "created_at": "2017-12-10 14:53:43",
            "updated_at": "2017-12-17 21:05:10",
            "care_user_status": 1,
            "care_user_remark_name": null,
            "remark_message": null,
            "is_read": 1,
            "push_switch": 0,
            "user_message_id": 13,
            "user_name": "余雅琪",
            "user_avatar": "http://120.78.218.49/img/20171212143746.jpg",
            "user_sex": 0,
            "user_address": null,
            "user_school": null,
            "user_grade": null,
            "user_class": null,
            "user_studentid": null,
            "user_identity": "1",
            "identity_change": 1
        },
        {
            "care_id": 100,
            "care_user_id": 13,
            "user_id": 13,
            "created_at": "2017-12-12 20:22:01",
            "updated_at": "2018-01-20 17:50:28",
            "care_user_status": 1,
            "care_user_remark_name": null,
            "remark_message": null,
            "is_read": 1,
            "push_switch": 1,
            "user_message_id": 17,
            "user_name": "duoge_13",
            "user_avatar": "http://120.78.218.49/img/20180109162006.jpg",
            "user_sex": 0,
            "user_address": null,
            "user_school": null,
            "user_grade": null,
            "user_class": null,
            "user_studentid": null,
            "user_identity": "1",
            "identity_change": 1
        },
        {
            "care_id": 72,
            "care_user_id": 18,
            "user_id": 18,
            "created_at": "2018-01-02 22:31:40",
            "updated_at": "2018-01-03 20:47:38",
            "care_user_status": 1,
            "care_user_remark_name": null,
            "remark_message": "方伊雯",
            "is_read": 1,
            "push_switch": 0,
            "user_message_id": 23,
            "user_name": "方伊雯",
            "user_avatar": "http://120.78.218.49/img/20180102224016.jpg",
            "user_sex": 0,
            "user_address": null,
            "user_school": null,
            "user_grade": null,
            "user_class": null,
            "user_studentid": null,
            "user_identity": "1",
            "identity_change": 0
        },
        {
            "care_id": 79,
            "care_user_id": 20,
            "user_id": 20,
            "created_at": "2018-01-04 18:59:18",
            "updated_at": "2018-01-18 16:35:36",
            "care_user_status": 1,
            "care_user_remark_name": null,
            "remark_message": "hello",
            "is_read": 1,
            "push_switch": 0,
            "user_message_id": 25,
            "user_name": "陈幸武",
            "user_avatar": "http://120.78.218.49/img/avatar.png",
            "user_sex": 1,
            "user_address": null,
            "user_school": null,
            "user_grade": null,
            "user_class": null,
            "user_studentid": null,
            "user_identity": "0",
            "identity_change": 0
        }
    ],
    "new_data": [
        {
            "user_message": {
                "care_id": 7,
                "care_user_id": 5,
                "user_id": 5,
                "created_at": "2017-12-09 20:38:30",
                "updated_at": "2017-12-19 16:22:48",
                "care_user_status": 1,
                "care_user_remark_name": null,
                "remark_message": null,
                "is_read": 1,
                "push_switch": 1,
                "user_message_id": 8,
                "user_name": "罗雷",
                "user_avatar": "http://120.78.218.49/img/20171218171820.jpg",
                "user_sex": 0,
                "user_address": null,
                "user_school": "重庆市鲁能巴蜀中学",
                "user_grade": "初一",
                "user_class": "四十五班",
                "user_studentid": "300045",
                "user_identity": "2",
                "identity_change": 1
            },
            "notice": [
                {
                    "count": 1,
                    "notice_type": "a"
                }
            ]
        },
        {
            "user_message": {
                "care_id": 38,
                "care_user_id": 9,
                "user_id": 9,
                "created_at": "2017-12-10 14:53:43",
                "updated_at": "2017-12-17 21:05:10",
                "care_user_status": 1,
                "care_user_remark_name": null,
                "remark_message": null,
                "is_read": 1,
                "push_switch": 0,
                "user_message_id": 13,
                "user_name": "余雅琪",
                "user_avatar": "http://120.78.218.49/img/20171212143746.jpg",
                "user_sex": 0,
                "user_address": null,
                "user_school": null,
                "user_grade": null,
                "user_class": null,
                "user_studentid": null,
                "user_identity": "1",
                "identity_change": 1
            },
            "notice": []
        },
        {
            "user_message": {
                "care_id": 100,
                "care_user_id": 13,
                "user_id": 13,
                "created_at": "2017-12-12 20:22:01",
                "updated_at": "2018-01-20 17:50:28",
                "care_user_status": 1,
                "care_user_remark_name": null,
                "remark_message": null,
                "is_read": 1,
                "push_switch": 1,
                "user_message_id": 17,
                "user_name": "duoge_13",
                "user_avatar": "http://120.78.218.49/img/20180109162006.jpg",
                "user_sex": 0,
                "user_address": null,
                "user_school": null,
                "user_grade": null,
                "user_class": null,
                "user_studentid": null,
                "user_identity": "1",
                "identity_change": 1
            },
            "notice": []
        },
        {
            "user_message": {
                "care_id": 72,
                "care_user_id": 18,
                "user_id": 18,
                "created_at": "2018-01-02 22:31:40",
                "updated_at": "2018-01-03 20:47:38",
                "care_user_status": 1,
                "care_user_remark_name": null,
                "remark_message": "方伊雯",
                "is_read": 1,
                "push_switch": 0,
                "user_message_id": 23,
                "user_name": "方伊雯",
                "user_avatar": "http://120.78.218.49/img/20180102224016.jpg",
                "user_sex": 0,
                "user_address": null,
                "user_school": null,
                "user_grade": null,
                "user_class": null,
                "user_studentid": null,
                "user_identity": "1",
                "identity_change": 0
            },
            "notice": []
        },
        {
            "user_message": {
                "care_id": 79,
                "care_user_id": 20,
                "user_id": 20,
                "created_at": "2018-01-04 18:59:18",
                "updated_at": "2018-01-18 16:35:36",
                "care_user_status": 1,
                "care_user_remark_name": null,
                "remark_message": "hello",
                "is_read": 1,
                "push_switch": 0,
                "user_message_id": 25,
                "user_name": "陈幸武",
                "user_avatar": "http://120.78.218.49/img/avatar.png",
                "user_sex": 1,
                "user_address": null,
                "user_school": null,
                "user_grade": null,
                "user_class": null,
                "user_studentid": null,
                "user_identity": "0",
                "identity_change": 0
            },
            "notice": []
        }
    ]
}

添加关心的人

请求接口

POST /api/user/care

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "user_id": 1,
    "remark_message": "备注信息"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

删除关心的人

请求接口

DELETE /api/user/care

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "user_id": 1
}

参数	类型	必须	说明
user_id	整型	是	用户id

{
    "user_telephone": "18656660930"
}

参数	类型	必须	说明
user_telephone	字符串	是	用户手机号

* 请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

修改关心的人备注名

请求接口

PUT /api/user/care

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "care_user_id": 1,
    "care_user_remark_name": "小明"
}

参数	类型	必须	说明
care_user_id	整型	是	关心的人id
care_user_remark_name	字符串	是	备注名

请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

添加群组

请求接口

POST /api/group

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "group_name": "群组名称",
    "group_description": "群组简介"
}

参数	类型	必须	说明
group_name	字符串	是	群组名称
group_description	字符串	可选	群组简介

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "group_id": 1,
        "group_name": "群组名称",
        "group_description": "群组简介"
    }
}

获取群组列表

请求接口

GET /api/group

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "group_id": 1,
            "group_name": "群组名称",
            "group_description": "群组简介"
        }
    ]
}

获取指定群组信息

请求接口

GET /api/group/{pk}

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

参数	类型	必须	说明
pk	整型	是	群组 group_id

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "group_id": 1,
        "group_name": "群组名称",
        "group_description": "群组简介",
        "user_id": 2   // 群主user_id
    }
}

编辑指定群组信息

请求接口

PUT /api/group/{pk}

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "group_name": "群组名称",
    "group_description": "群组简介"
}

参数	类型	必须	说明
group_avatar	字符串	可选	群组头像
group_name	字符串	可选	群组名称
group_description	字符串	可选	群组简介
pk	整型	是	群组 group_id

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "group_id": 1,
        "group_name": "群组名称",
        "group_description": "群组简介"
    }
}

删除指定群组

请求接口

DELETE /api/group/{pk}

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

参数	类型	必须	说明
pk	整型	是	群组 group_id

请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

给指定群组添加用户

请求接口

POST /api/group/user/{pk}

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "users": "1,2,3,4,5,6"
}

参数	类型	必须	说明
pk	整型	是	群组 group_id
users	字符串	是	用户user_id英文逗号拼接的字符串

* 请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

获取指定群组下的用户列表

请求接口

GET /api/group/user/{pk}

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

参数	类型	必须	说明
pk	整型	是	群组 group_id

请求回调

{
    "code": 0,
    "message": "success",
    "data": [用户信息列表]
}

删除指定群组下的用户

请求接口

DELETE /api/group/user/{pk}

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "users": "1,2,3,4,5,6"
}

参数	类型	必须	说明
pk	整型	是	群组 group_id
users	字符串	是	用户user_id英文逗号拼接的字符串

* 请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

添加反馈

请求接口

POST /api/feedback

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "feedback_content": "内容",
    "feedback_email": "123456@qq.com"
}

参数	类型	必须	说明
feedback_content	字符串	是	反馈内容
feedback_email	字符串	可选	邮箱

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "feedback_id": 1,
        "feedback_content": "内容",
        "created_at": "2017-11-21 16:00:00",
        "updated_at": "2017-11-21 16:00:00"
    }
}

获取反馈列表

请求接口

GET /api/feedback

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "feedback_id": 1,
            "feedback_content": "内容",
            "created_at": "2017-11-21 16:00:00",
            "updated_at": "2017-11-21 16:00:00"
        }
    ]
}

获取单个反馈信息

请求接口

GET /api/feedback/{pk}

请求 header

{
    "Authorization": "jwt 1234567890"
}

参数	类型	必须	说明
pk	整型	是	反馈信息主键 feedback_id

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "feedback_id": 1,
        "feedback_content": "内容",
        "created_at": "2017-11-21 16:00:00",
        "updated_at": "2017-11-21 16:00:00"
    }
}

删除反馈

请求接口

DELETE /api/feedback/{pk}

请求 header

{
    "Authorization": "jwt 1234567890"
}

参数	类型	必须	说明
pk	整型	是	反馈信息主键 feedback_id

请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

添加防扰模式

请求接口

POST /api/avoid_mode

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "avoid_mode_start_time": "10:00",
    "avoid_mode_end_time": "11:00",
    "avoid_mode_repeat": "1,2,3"
}

参数	类型	必须	说明
avoid_mode_start_time	字符串	是	开始时间
avoid_mode_end_time	字符串	是	结束时间
avoid_mode_repeat	字符串	是	重复（示例："0,1,2,3,4,5,6" 分别代表日一二三四五六）英文逗号拼接

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "avoid_mode_start_time": "10:00",
        "avoid_mode_end_time": "11:00",
        "avoid_mode_repeat": "1,2,3",
        "avoid_mode_status": 0,
        "created_at": "2017-11-21 16:00:00",
        "updated_at": "2017-11-21 16:00:00"
    }
}

获取防扰模式列表

请求接口

GET /api/avoid_mode

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "avoid_mode_start_time": "10:00",
            "avoid_mode_end_time": "11:00",
            "avoid_mode_repeat": "1,2,3",
            "avoid_mode_status": 0,
            "created_at": "2017-11-21 16:00:00",
            "updated_at": "2017-11-21 16:00:00"
        }
}

编辑防扰模式

请求接口

PUT /api/avoid_mode/{pk}

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "avoid_mode_start_time": "10:00",
    "avoid_mode_end_time": "11:00",
    "avoid_mode_status": 0,
    "avoid_mode_repeat": "1,2,3"
}

参数	类型	必须	说明
pk	整型	是	主键avoid_mode_id
avoid_mode_start_time	字符串	是	开始时间
avoid_mode_end_time	字符串	是	结束时间
avoid_mode_status	整型	可选	结束时间
avoid_mode_repeat	字符串	是	重复（示例："0,1,2,3,4,5,6" 分别代表日一二三四五六）英文逗号拼接

请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

删除防扰模式

请求接口

DELETE /api/avoid_mode/{pk}

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

获取单个防扰模式信息

请求接口

GET /api/avoid_mode/{pk}

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "avoid_mode_start_time": "10:00",
            "avoid_mode_end_time": "11:00",
            "avoid_mode_repeat": "1,2,3",
            "created_at": "2017-11-21 16:00:00",
            "updated_at": "2017-11-21 16:00:00"
        }
}

查询发现列表

请求接口

GET /api/discover

请求回调

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "discover_id": 1,
            "discover_title": "标题",
            "discover_content": "内容",
            "discover_url": "h5地址url",
            "discover_thumbnail": "缩略图地址",
            "discover_read": 88,    # 浏览数
            "created_at": "2017-11-21 10:00:00",
            "updated_at": "2017-11-21 10:00:00"
        }
    ]
}

边走边看提醒状态查询

请求接口

GET /api/notice_a

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "notice_a_id": 1,
        "notice_a_status": 0
    }
}

参数	类型	说明
notice_a_status	整型	提醒状态: 0关1开

边走边看提醒状态编辑

请求接口

PUT /api/notice_a

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "notice_a_status": 0
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "notice_a_id": 1,
        "notice_a_status": 0
    }
}

低光提醒状态查询

请求接口

GET /api/notice_b

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "notice_b_id": 1,
        "notice_b_status": 0
    }
}

低光提醒状态编辑

请求接口

PUT /api/notice_b

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "notice_b_status": 0
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "notice_b_id": 1,
        "notice_b_status": 0
    }
}

不当姿势提醒状态查询

请求接口

GET /api/notice_c

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "notice_c_id": 1,
        "notice_c_status": 0
    }
}

不当姿势提醒状态编辑

请求接口

PUT /api/notice_c

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "notice_c_status": 0
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "notice_c_id": 1,
        "notice_c_status": 0
    }
}

长时提醒状态查询

请求接口

GET /api/notice_d

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "notice_d_id": 1,
        "notice_d_status": 0
    }
}

长时提醒状态编辑

请求接口

PUT /api/notice_d

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "notice_d_status": 0
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "notice_d_id": 1,
        "notice_d_status": 0
    }
}

时段规划提醒状态及信息查询

请求接口

GET /api/notice_e

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": [时段列表信息]
}

时段规划提醒状态更改（适用于总开关）

请求接口

PUT /api/notice_e/all

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "notice_e_status": 0
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

时段规划提醒状态及信息添加

请求接口

POST /api/notice_e

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "notice_e_status": 0,
    "notice_e_start": "10:00",
    "notice_e_end": "18:00",
    "notice_e_time": 20
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": {添加的时段信息}
}

时段规划提醒状态及信息编辑

请求接口

PUT /api/notice_e/{notice_e_id}

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "notice_e_status": 0,    //可选
    "notice_e_start": "10:00",   //可选
    "notice_e_end": "18:00",       //可选
    "notice_e_time": 20
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": {更新后的时段信息}
}

时段规划提醒状态及信息删除

请求接口

DELETE /api/notice_e/{notice_e_id}

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

获取系统消息

请求接口

GET /api/system_message

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0, 
    "message": "success",
    "data": [消息列表]
}

发送群组通知

请求接口

POST /api/group_message

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "group_id": 1,
    "group_message_content": "内容"
}

参数	类型	必须	说明
group_id	整型	是	群组ID
group_message_content	字符串	是	内容

请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

获取指定群组信息列表

请求接口

GET /api/group_message/{group_id}

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

参数	类型	必须	说明
group_id	整型	可选	群组ID，没有改参数时，获取所有群组消息

请求回调

{
    "code": 0,
    "message": "success",
    "data": [消息列表]
}

积分奖惩操作

请求接口

POST /api/integration

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "integration_reason": "不当姿势",
    "integration_num": -1,
    "integration_type": "a",
    "timer": 30
}

参数	类型	必须	说明
integration_reason	字符串	是	奖惩原因
integration_num	整型	是	奖励积分正数，惩罚负数
integration_type	字符串	可选	a: 边走边看提醒 b: 低光提醒 c:不当姿势提醒 d: 长时提醒 e: 时段规划 f:分享
timer	整型	可选	时长

* 请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

积分奖惩列表

请求接口

GET /api/integration/{type}/{timestamp}

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

参数	类型	必须	说明
timestamp	整型	可选	日期时间戳
type	字符串	可选	积分类型：收获2，惩罚1，边走边看提醒a，低光提醒b，不当姿势c，长时提醒d，时段规划提醒e，无参数代表全部

* 请求回调

{
    "code": 0,
    "message": "success",
    "data": [奖惩列表]
}

获取当前总积分

请求接口

GET /api/integration_sum

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "integration_sum": 0,
        "integration_del": 0,
        "integration_add": 0
    }
}

消息数量统计接口

请求接口

GET /api/message

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "system_message_num": 0,    //系统消息数量
        "group_message_num": 0,     //群组消息数量
        "relate_message_num": 0,    //关系消息数量
        "apply_message_num": 0      //群组通知消息数量
        "message_all": 0
    }
}

日志统计

请求接口

GET /api/log?timestamp={时间戳}&user_id={要查看的用户ID}

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

参数	类型	必须	说明
timestamp	字符串	可选	日期时间戳（默认当天）
user_id	整型	可选	要查看的用户ID（默认自己）

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "log_a": 0,
        "log_b": 0,
        "log_c": 0,
        "log_d": 0,
        "log_e": 0,
        "log_g": 0,
        "log_sum": 0,
        "device_today_use": 0,
        "device_yesterday_use": 0,
        "device_use_subtraction": 0,
        "device_use_pass": 0
    }
}

参数	类型	说明
log_a	整型	边走边看提醒
log_b	整型	低光提醒
log_c	整型	不当姿势提醒
log_d	整型	长时提醒
log_e	整型	时段规划
log_g	整型	防扰数量
log_sum	整型	提醒总数
device_today_use	整型	设备今日使用时间（分钟）
device_yesterday_use	整型	设备昨天使用时间（分钟）
device_use_subtraction	整型	设备比昨天多使用时间（分钟）
device_use_pass	整型	超越用户数

获取关心消息

请求接口

GET /api/care_user_message

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": [消息列表]
}

处理关心消息

请求接口

PUT /api/care_user_handle

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "care_user_id": 1,
    "care_user_status": 1
}

参数	类型	必须	说明
care_user_id	整型	是	关心的用户Id
care_user_status	整型	是	0：待处理，1：添加，2：忽略

* 请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

操作驾驶模式

请求接口

PUT /api/drive_mode

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "drive_mode_status": 1
}

参数	类型	必须	说明
drive_mode_status	整型	是	驾驶模式状态 0：关闭，1：开启

* 请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

获取驾驶模式

请求接口

GET /api/drive_mode

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "drive_mode_status": 1
    }
}

参数	类型	说明
drive_mode_status	整型	驾驶模式状态 0：关闭，1：开启

图片上传

请求接口

POST /api/upload/img

说明

form-data上传，文件对应的 key 为 img
文件格式只支持 jpg , png , git
请求header额外添加 form-data

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "img_url": "http://xxx.xx/img/xxx.jpp"
    }
}

关心的人积分排行榜

请求接口

GET /api/ranking

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": [排行榜信息列表]
}

群组积分排行榜

请求接口

GET /api/ranking/{group_id}

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

参数	类型	必须	说明
group_id	整型	是	群组id

* 请求回调

{
    "code": 0,
    "message": "success",
    "data": [排行榜信息列表]
}

设备使用时间同步

请求接口

POST /api/device

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "device_use_minute": 100
}

参数	类型	必须	说明
device_use_status	整型	是	设备使用时间（分钟）

* 请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

设备使用统计

请求接口

GET /api/device

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "device_today_use": 0,
        "device_yesterday_use": 0,
        "device_use_subtraction": 0,
        "device_use_pass": 0
    }
}

参数	类型	说明
device_today_use	整型	设备今日使用时间（分钟）
device_yesterday_use	整型	设备昨天使用时间（分钟）
device_use_subtraction	整型	设备比昨天多使用时间（分钟）
device_use_pass	整型	超越用户数

判断用户是否为关心的人

请求接口

GET /api/care_user_status/{user_id}

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

参数	类型	必须	说明
user_id	整型	是	要查的用户Id

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "care_user_status": 1,
        "push_switch": 0
    }
}

参数	类型	说明
care_user_status	整型	0: 无关系 1：关心的人
push_switch	整型	接收该好友推送开关 0：关闭 1：开启

绑定第三方账号

请求接口

POST /api/bind_open

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "open_id": "qwertyuiopsdfghjkl",
    "open_type": 1
}

参数	类型	必须	说明
open_id	字符串	是	第三方账号唯一ID
open_type	整型	是	第三方账号类型： 1.微信 2.QQ 3.微博

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "open_account_id": 1,
        "open_id": "qwertyuiopdfghjk",
        "open_type": 1,
        "user_id": 20
    }
}

根据第三方账号获取 token

请求接口

POST /api/get_token_by_open

请求参数

{
    "open_id": "qwertyuiopsdfghjkl",
    "open_type": 1
}

参数	类型	必须	说明
open_id	字符串	是	第三方账号唯一ID
open_type	整型	是	第三方账号类型： 1.微信 2.QQ 3.微博

* 请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "token": "eyJ0eXAiOiJKV1QifQ.eyJ1c2VyX2lkIjoxLCJpYXQiOjE1MTEwNjM3NDYsImV4cCI6MTUxMTY2ODU0Nn0.JDJ5JDEwJDhPRmwwTjVyLlBuN1k1bFJzbEFaOC44dE9qaUpia2kzZTNxMzltNkFNeVZFaFZWaGQwR3lx",
        "expire_in": 604800
    }
}

参数	类型	说明
token	字符串	Authorization : jwt {token}
expire_in	整型	token有效期,单位（秒）

日志权限设置

请求接口

POST /api/log

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "log_permission": "1,2,3,4,5"
}

参数	类型	必须	说明
log_permission	字符串	是	公开：a 私密：b 指定关心的人 user_id和英文逗号拼接

请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

日志权限获取

请求接口

GET /api/log/permission

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": {权限信息}
}

系统参数配置信息

请求接口

GET /api/config

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "notice":{
            "a":{"time":1800},
            "b":{"time":1800,"light":0.6},
            "c":{"time":1800,"pitch":0.6},
            "d":{"time":1800},
            "space":{"time":1800},
            "drive":{"time":120,"pitch":10},
        },
        "agreement":"http://localhost/agreement",
        "convention": "http://localhost/agreement",
        "tagline": "宣传语",
        "email": "1234567890@qq.com",
        "telephone": "18888888888"
    }
}

备注

a: 边走边看提醒 b: 低光提醒 c:不当姿势提醒 d: 长时提醒
agreement: 用户协议地址 convention:多格公约地址

根据群组编号查询群组

请求接口

GET /api/get_by_group_number/{group_number}

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

参数	类型	必须	说明
group_number	字符串	是	群组编号

* 请求回调

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "group": {
                "group_id": 20,
                "group_avatar": "http://120.78.218.49/img/qun_admin.png",
                "group_name": "群_23800083",
                "group_description": null,
                "user_id": 3,
                "created_at": "2017-12-10 20:58:35",
                "updated_at": "2017-12-10 20:58:35",
                "group_number": "23800083"
            },
            "status": 1
        }
    ]
}

查询推荐群组

请求接口

GET /api/get_recommend_group

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": [群组列表信息]
}

附带选择用户添加群组

请求接口

POST /api/group/create_by_select_user

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "group_name": "群组名称",
    "group_description": "群组简介",
    "users": "1,2,3,4,5,6"
}

参数	类型	必须	说明
group_name	字符串	可选	群组名称
group_description	字符串	可选	群组简介
users	字符串	是	用户id英文逗号拼接字符串

* 请求回调

{
    "code": 0,
    "message": "success",
    "data": {群组信息}
}

根据包名获取app类型和名称

请求接口

GET /api/appstore/{package}

参数说明

参数	类型	必须	说明
package	字符串	是	包名：如 com.UCMobile

* 请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "app_type":"系统工具",
        "app_name":"UC浏览器"
    }
}

申请加群

请求接口

POST /api/apply_group

请求参数

{
    "group_id": 1,      //群组id
    "apply_message": "我是jerry"        // 备注信息
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "group_id":1,
        "apply_message":"我是jerry",
        "user_id":4,
        "updated_at":"2017-12-10 13:01:51",
        "created_at":"2017-12-10 13:01:51",
        "apply_id":2
    }
}

加群消息处理

请求接口

PUT /api/apply_group

请求参数

{
    "group_id": 1,      //群组id
    "user_id": 2,        // 请求用户user_id
    "apply_status": 1    //0：默认待处理 1：添加2：拒绝
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

加群消息列表

请求接口

GET /api/apply_group

请求回调

{
    "code": 0,
    "message": "success",
    "data": [消息列表]
}

转移群主

请求接口

POST /api/give_group

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "group_id": 1,      //群组id
    "user_id": 2        // 授予该用户user_id
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

群主获取群成员日志统计

请求接口

GET /api/log?timestamp={时间戳}&group_user_id={要查看的用户ID}&group_id={群组ID}

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

参数	类型	必须	说明
timestamp	字符串	可选	日期时间戳（默认当天）
user_id	整型	可选	要查看的用户ID（默认自己）

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "log_a": 0,
        "log_b": 0,
        "log_c": 0,
        "log_d": 0,
        "log_e": 0,
        "log_g": 0,
        "log_sum": 0,
        "device_today_use": 0,
        "device_yesterday_use": 0,
        "device_use_subtraction": 0,
        "device_use_pass": 0
    }
}

参数	类型	说明
log_a	整型	边走边看提醒
log_b	整型	低光提醒
log_c	整型	不当姿势提醒
log_d	整型	长时提醒
log_e	整型	时段规划
log_g	整型	防扰数量
log_sum	整型	提醒总数
device_today_use	整型	设备今日使用时间（分钟）
device_yesterday_use	整型	设备昨天使用时间（分钟）
device_use_subtraction	整型	设备比昨天多使用时间（分钟）
device_use_pass	整型	超越用户数

退群

请求接口

DELETE /api/exit_group/{group_id}

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

修改群成员备注名称

请求接口

PUT /api/group/user/remark

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "group_id": 1,
    "group_user_remark_name": "备注名称",
    "group_user_id": 1
}

参数	类型	必须	说明
group_id	整型	是	群组主键
group_user_id	字符串	可选	群成员id,无该参数则为自己修改在自己
group_user_remark_name	整型	是	备注名称

请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

获取日志分享链接

请求接口

GET /api/log/share?user_id=1&timestamp=12324

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "url": "http://xxx.xx/xx?xxx"
    }
}

推送设备(device) 与用户(user_id) 建立绑定关系

请求接口

POST /api/device_client

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "device": "xxxxxxxxxxxxxxxxxxxxxxxxx"
}

参数	类型	必须	说明
device	字符串	是	阿里推送分配给APP的 device

* 请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "id": 1,
        "device": "xxxxxxxxxxxxxxxxxxxx",
        "user_id": 1
    }
}

动态记录

请求接口

GET /api/dynamic?user_id=1&timestamp=1234567890

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "id": 1,
            "title": null,
            "body": "登录了多格应用(设备名为)",
            "user_id": 8,
            "created_at": "2017-12-28 16:11:58",
            "updated_at": "2017-12-28 16:11:58"
        }
    ]
}

接收某个关心的人推送开关

请求接口

PUT /api/push_switch

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
    "care_user_id": 2,      //关心的人 id
    "push_switch": 1        //接收推送开关
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

退出登录

请求接口

POST /api/logout

请求 header

{
    "Authorization": "jwt 1234567890"
}

请求参数

{
     "device_name": "jerry",
     "device_type": "ios"
}

请求回调

{
    "code": 0,
    "message": "success",
    "data": ""
}

日报统计接口

请求接口

GET /api/log/notice/compute?user_id=20&days=30&notice_type=d

请求参数

参数	类型	必须	说明
user_id	整型	是	用户主键ID
days	整型	是	最近多少天数据
notice_type	字符串	是	a: 边走边看提醒 b: 低光提醒 c:不当姿势提醒 d: 长时提醒 e: 时段规划 f:分享

* 请求回调

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "count": 10,
            "scores": "-10",
            "date": "2018-01-04"
        },
        {
            "count": 5,
            "scores": "-5",
            "date": "2018-01-07"
        },
        {
            "count": 2,
            "scores": "-2",
            "date": "2018-01-10"
        },
        {
            "count": 1,
            "scores": "-1",
            "date": "2018-01-13"
        },
        {
            "count": 4,
            "scores": "-4",
            "date": "2018-01-18"
        },
        {
            "count": 2,
            "scores": "-2",
            "date": "2018-01-19"
        },
        {
            "count": 32,
            "scores": "-32",
            "date": "2018-01-20"
        },
        {
            "count": 3,
            "scores": "-3",
            "date": "2018-01-21"
        },
        {
            "count": 10,
            "scores": "-10",
            "date": "2018-01-22"
        },
        {
            "count": 5,
            "scores": "-5",
            "date": "2018-01-23"
        }
    ]
}

游客登录

请求接口

GET /api/visitor

请求回调

{
    "code": 0,
    "message": "success",
    "data": {
        "token": "eyJ0eXAiOiJKV1QifQ.eyJ1c2VyX2lkIjoyOCwiaWF0IjoxNTE2Nzg2MTIxLCJleHAiOjE1MTczOTA5MjF9.JDJ5JDEwJHlubm5odWV2enFTRDI3ZWVVcEZ6Ty5rNHI1dmdRL2U3ZTV0WC81UG93LmFOTW55a3dGc0dH",
        "expire_in": 604800,
        "client_id": "qrgHDGEmMVpnQP1S1NnistpiywrYbeaM"
    }
}