接口说明 / 管理端 API

门铃后台管理系统API文档

简介:门铃后台管理系统API文档

HOST:https://api.menling.com（管理端；路径以各接口为准）

联系人:yanfw

Version:v1.0

接口路径:/v2/api-docs?group=ALL API

[TOC]

ML-仪表盘管理

获取通话量

接口地址:/panel/get_call_volume

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
panelParam	面板参数	body	false	PanelParam	PanelParam
criteriaMap	赛选条件参数		false	criteriaMap_8	criteriaMap_8
endTimestamp	结束时间错（毫秒）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«CallDataStatistics»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	CallDataStatistics	CallDataStatistics
callRate	通话	number
initiatedCallCount	发起通话次数	integer(int64)
refuseCallCount	拒接通话次数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "callRate": 0,
        "initiatedCallCount": 0,
        "refuseCallCount": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

当日余额充值统计

接口地址:/panel/get_day_balance_recharge

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
panelParam	面板参数	body	false	PanelParam	PanelParam
criteriaMap	赛选条件参数		false	criteriaMap_8	criteriaMap_8
endTimestamp	结束时间错（毫秒）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«List«StatisticsData»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	array	StatisticsData
count	数量	integer(int64)
date	年-月-日	string(date)
day	日	integer(int32)
hourGroup	小时分组	integer(int32)
money	金额	number
month	月	integer(int32)
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer(int32)
year	年	integer(int32)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": [
        {
            "count": 0,
            "date": "",
            "day": 0,
            "hourGroup": 0,
            "money": 0,
            "month": 0,
            "monthName": "",
            "timeRange": "",
            "weekdayName": "",
            "weekdayNum": 0,
            "year": 0
        }
    ],
    "message": "",
    "success": true,
    "timestamp": 0
}

当日余额提现统计

接口地址:/panel/get_day_balance_withdraw

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
panelParam	面板参数	body	false	PanelParam	PanelParam
criteriaMap	赛选条件参数		false	criteriaMap_8	criteriaMap_8
endTimestamp	结束时间错（毫秒）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«List«StatisticsData»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	array	StatisticsData
count	数量	integer(int64)
date	年-月-日	string(date)
day	日	integer(int32)
hourGroup	小时分组	integer(int32)
money	金额	number
month	月	integer(int32)
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer(int32)
year	年	integer(int32)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": [
        {
            "count": 0,
            "date": "",
            "day": 0,
            "hourGroup": 0,
            "money": 0,
            "month": 0,
            "monthName": "",
            "timeRange": "",
            "weekdayName": "",
            "weekdayNum": 0,
            "year": 0
        }
    ],
    "message": "",
    "success": true,
    "timestamp": 0
}

当日风铃充值统计

接口地址:/panel/get_day_wind_chime_recharge

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
panelParam	面板参数	body	false	PanelParam	PanelParam
criteriaMap	赛选条件参数		false	criteriaMap_8	criteriaMap_8
endTimestamp	结束时间错（毫秒）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«List«StatisticsData»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	array	StatisticsData
count	数量	integer(int64)
date	年-月-日	string(date)
day	日	integer(int32)
hourGroup	小时分组	integer(int32)
money	金额	number
month	月	integer(int32)
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer(int32)
year	年	integer(int32)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": [
        {
            "count": 0,
            "date": "",
            "day": 0,
            "hourGroup": 0,
            "money": 0,
            "month": 0,
            "monthName": "",
            "timeRange": "",
            "weekdayName": "",
            "weekdayNum": 0,
            "year": 0
        }
    ],
    "message": "",
    "success": true,
    "timestamp": 0
}

获取设备量

接口地址:/panel/get_device_volume

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
panelParam	面板参数	body	false	PanelParam	PanelParam
criteriaMap	赛选条件参数		false	criteriaMap_8	criteriaMap_8
endTimestamp	结束时间错（毫秒）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«DeviceDataStatistics»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	DeviceDataStatistics	DeviceDataStatistics
deviceTotal	当天活跃用户总数量	integer(int64)
offlineDeviceCount	当天离线设备数量	integer(int64)
onlineDeviceCount	当天活跃用户在线设备数量	integer(int64)
todayDeviceData	统计数据	array	StatisticsData
count	数量	integer
date	年-月-日	string
day	日	integer
hourGroup	小时分组	integer
money	金额	number
month	月	integer
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer
year	年	integer
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "deviceTotal": 0,
        "offlineDeviceCount": 0,
        "onlineDeviceCount": 0,
        "todayDeviceData": [
            {
                "count": 0,
                "date": "",
                "day": 0,
                "hourGroup": 0,
                "money": 0,
                "month": 0,
                "monthName": "",
                "timeRange": "",
                "weekdayName": "",
                "weekdayNum": 0,
                "year": 0
            }
        ]
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

当月余额充值统计

接口地址:/panel/get_month_balance_recharge

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
panelParam	面板参数	body	false	PanelParam	PanelParam
criteriaMap	赛选条件参数		false	criteriaMap_8	criteriaMap_8
endTimestamp	结束时间错（毫秒）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«List«StatisticsData»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	array	StatisticsData
count	数量	integer(int64)
date	年-月-日	string(date)
day	日	integer(int32)
hourGroup	小时分组	integer(int32)
money	金额	number
month	月	integer(int32)
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer(int32)
year	年	integer(int32)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": [
        {
            "count": 0,
            "date": "",
            "day": 0,
            "hourGroup": 0,
            "money": 0,
            "month": 0,
            "monthName": "",
            "timeRange": "",
            "weekdayName": "",
            "weekdayNum": 0,
            "year": 0
        }
    ],
    "message": "",
    "success": true,
    "timestamp": 0
}

当月余额提现统计

接口地址:/panel/get_month_balance_withdraw

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
panelParam	面板参数	body	false	PanelParam	PanelParam
criteriaMap	赛选条件参数		false	criteriaMap_8	criteriaMap_8
endTimestamp	结束时间错（毫秒）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«List«StatisticsData»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	array	StatisticsData
count	数量	integer(int64)
date	年-月-日	string(date)
day	日	integer(int32)
hourGroup	小时分组	integer(int32)
money	金额	number
month	月	integer(int32)
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer(int32)
year	年	integer(int32)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": [
        {
            "count": 0,
            "date": "",
            "day": 0,
            "hourGroup": 0,
            "money": 0,
            "month": 0,
            "monthName": "",
            "timeRange": "",
            "weekdayName": "",
            "weekdayNum": 0,
            "year": 0
        }
    ],
    "message": "",
    "success": true,
    "timestamp": 0
}

当月注册数量统计

接口地址:/panel/get_month_register_statistics

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
panelParam	面板参数	body	false	PanelParam	PanelParam
criteriaMap	赛选条件参数		false	criteriaMap_8	criteriaMap_8
endTimestamp	结束时间错（毫秒）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«RegisterDataStatistics»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	RegisterDataStatistics	RegisterDataStatistics
monthRegisterCount	当月用户注册数量	integer(int64)
monthRegisterData	统计数据	array	StatisticsData
count	数量	integer
date	年-月-日	string
day	日	integer
hourGroup	小时分组	integer
money	金额	number
month	月	integer
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer
year	年	integer
todayRegisterCount	当天用户注册数量	integer(int64)
todayRegisterData	统计数据	array	StatisticsData
count	数量	integer
date	年-月-日	string
day	日	integer
hourGroup	小时分组	integer
money	金额	number
month	月	integer
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer
year	年	integer
weekRegisterCount	当周用户注册数量	integer(int64)
weekRegisterData	统计数据	array	StatisticsData
count	数量	integer
date	年-月-日	string
day	日	integer
hourGroup	小时分组	integer
money	金额	number
month	月	integer
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer
year	年	integer
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "monthRegisterCount": 0,
        "monthRegisterData": [
            {
                "count": 0,
                "date": "",
                "day": 0,
                "hourGroup": 0,
                "money": 0,
                "month": 0,
                "monthName": "",
                "timeRange": "",
                "weekdayName": "",
                "weekdayNum": 0,
                "year": 0
            }
        ],
        "todayRegisterCount": 0,
        "todayRegisterData": [
            {
                "count": 0,
                "date": "",
                "day": 0,
                "hourGroup": 0,
                "money": 0,
                "month": 0,
                "monthName": "",
                "timeRange": "",
                "weekdayName": "",
                "weekdayNum": 0,
                "year": 0
            }
        ],
        "weekRegisterCount": 0,
        "weekRegisterData": [
            {
                "count": 0,
                "date": "",
                "day": 0,
                "hourGroup": 0,
                "money": 0,
                "month": 0,
                "monthName": "",
                "timeRange": "",
                "weekdayName": "",
                "weekdayNum": 0,
                "year": 0
            }
        ]
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

当月风铃充值统计

接口地址:/panel/get_month_wind_chime_recharge

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
panelParam	面板参数	body	false	PanelParam	PanelParam
criteriaMap	赛选条件参数		false	criteriaMap_8	criteriaMap_8
endTimestamp	结束时间错（毫秒）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«List«StatisticsData»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	array	StatisticsData
count	数量	integer(int64)
date	年-月-日	string(date)
day	日	integer(int32)
hourGroup	小时分组	integer(int32)
money	金额	number
month	月	integer(int32)
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer(int32)
year	年	integer(int32)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": [
        {
            "count": 0,
            "date": "",
            "day": 0,
            "hourGroup": 0,
            "money": 0,
            "month": 0,
            "monthName": "",
            "timeRange": "",
            "weekdayName": "",
            "weekdayNum": 0,
            "year": 0
        }
    ],
    "message": "",
    "success": true,
    "timestamp": 0
}

获取注册量

接口地址:/panel/get_register_volume

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
panelParam	面板参数	body	false	PanelParam	PanelParam
criteriaMap	赛选条件参数		false	criteriaMap_8	criteriaMap_8
endTimestamp	结束时间错（毫秒）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«RegisterDataStatistics»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	RegisterDataStatistics	RegisterDataStatistics
monthRegisterCount	当月用户注册数量	integer(int64)
monthRegisterData	统计数据	array	StatisticsData
count	数量	integer
date	年-月-日	string
day	日	integer
hourGroup	小时分组	integer
money	金额	number
month	月	integer
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer
year	年	integer
todayRegisterCount	当天用户注册数量	integer(int64)
todayRegisterData	统计数据	array	StatisticsData
count	数量	integer
date	年-月-日	string
day	日	integer
hourGroup	小时分组	integer
money	金额	number
month	月	integer
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer
year	年	integer
weekRegisterCount	当周用户注册数量	integer(int64)
weekRegisterData	统计数据	array	StatisticsData
count	数量	integer
date	年-月-日	string
day	日	integer
hourGroup	小时分组	integer
money	金额	number
month	月	integer
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer
year	年	integer
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "monthRegisterCount": 0,
        "monthRegisterData": [
            {
                "count": 0,
                "date": "",
                "day": 0,
                "hourGroup": 0,
                "money": 0,
                "month": 0,
                "monthName": "",
                "timeRange": "",
                "weekdayName": "",
                "weekdayNum": 0,
                "year": 0
            }
        ],
        "todayRegisterCount": 0,
        "todayRegisterData": [
            {
                "count": 0,
                "date": "",
                "day": 0,
                "hourGroup": 0,
                "money": 0,
                "month": 0,
                "monthName": "",
                "timeRange": "",
                "weekdayName": "",
                "weekdayNum": 0,
                "year": 0
            }
        ],
        "weekRegisterCount": 0,
        "weekRegisterData": [
            {
                "count": 0,
                "date": "",
                "day": 0,
                "hourGroup": 0,
                "money": 0,
                "month": 0,
                "monthName": "",
                "timeRange": "",
                "weekdayName": "",
                "weekdayNum": 0,
                "year": 0
            }
        ]
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

当日设备活跃量统计

接口地址:/panel/get_today_device_statistics

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
panelParam	面板参数	body	false	PanelParam	PanelParam
criteriaMap	赛选条件参数		false	criteriaMap_8	criteriaMap_8
endTimestamp	结束时间错（毫秒）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«DeviceDataStatistics»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	DeviceDataStatistics	DeviceDataStatistics
deviceTotal	当天活跃用户总数量	integer(int64)
offlineDeviceCount	当天离线设备数量	integer(int64)
onlineDeviceCount	当天活跃用户在线设备数量	integer(int64)
todayDeviceData	统计数据	array	StatisticsData
count	数量	integer
date	年-月-日	string
day	日	integer
hourGroup	小时分组	integer
money	金额	number
month	月	integer
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer
year	年	integer
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "deviceTotal": 0,
        "offlineDeviceCount": 0,
        "onlineDeviceCount": 0,
        "todayDeviceData": [
            {
                "count": 0,
                "date": "",
                "day": 0,
                "hourGroup": 0,
                "money": 0,
                "month": 0,
                "monthName": "",
                "timeRange": "",
                "weekdayName": "",
                "weekdayNum": 0,
                "year": 0
            }
        ]
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

当日金额统计

接口地址:/panel/get_today_money

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
panelParam	面板参数	body	false	PanelParam	PanelParam
criteriaMap	赛选条件参数		false	criteriaMap_8	criteriaMap_8
endTimestamp	结束时间错（毫秒）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«MoneyStatistics»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	MoneyStatistics	MoneyStatistics
toDayBalanceRecharge	余额充值	number
toDayBalanceWithdraw	余额提现	number
toDayShoppingMoney	购物金额	number
toDayWindChimeRecharge	风铃充值	number
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "toDayBalanceRecharge": 0,
        "toDayBalanceWithdraw": 0,
        "toDayShoppingMoney": 0,
        "toDayWindChimeRecharge": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

当天注册数量统计

接口地址:/panel/get_today_register_statistics

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
panelParam	面板参数	body	false	PanelParam	PanelParam
criteriaMap	赛选条件参数		false	criteriaMap_8	criteriaMap_8
endTimestamp	结束时间错（毫秒）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«RegisterDataStatistics»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	RegisterDataStatistics	RegisterDataStatistics
monthRegisterCount	当月用户注册数量	integer(int64)
monthRegisterData	统计数据	array	StatisticsData
count	数量	integer
date	年-月-日	string
day	日	integer
hourGroup	小时分组	integer
money	金额	number
month	月	integer
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer
year	年	integer
todayRegisterCount	当天用户注册数量	integer(int64)
todayRegisterData	统计数据	array	StatisticsData
count	数量	integer
date	年-月-日	string
day	日	integer
hourGroup	小时分组	integer
money	金额	number
month	月	integer
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer
year	年	integer
weekRegisterCount	当周用户注册数量	integer(int64)
weekRegisterData	统计数据	array	StatisticsData
count	数量	integer
date	年-月-日	string
day	日	integer
hourGroup	小时分组	integer
money	金额	number
month	月	integer
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer
year	年	integer
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "monthRegisterCount": 0,
        "monthRegisterData": [
            {
                "count": 0,
                "date": "",
                "day": 0,
                "hourGroup": 0,
                "money": 0,
                "month": 0,
                "monthName": "",
                "timeRange": "",
                "weekdayName": "",
                "weekdayNum": 0,
                "year": 0
            }
        ],
        "todayRegisterCount": 0,
        "todayRegisterData": [
            {
                "count": 0,
                "date": "",
                "day": 0,
                "hourGroup": 0,
                "money": 0,
                "month": 0,
                "monthName": "",
                "timeRange": "",
                "weekdayName": "",
                "weekdayNum": 0,
                "year": 0
            }
        ],
        "weekRegisterCount": 0,
        "weekRegisterData": [
            {
                "count": 0,
                "date": "",
                "day": 0,
                "hourGroup": 0,
                "money": 0,
                "month": 0,
                "monthName": "",
                "timeRange": "",
                "weekdayName": "",
                "weekdayNum": 0,
                "year": 0
            }
        ]
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

获取能量会员量

接口地址:/panel/get_vip_volume

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
panelParam	面板参数	body	false	PanelParam	PanelParam
criteriaMap	赛选条件参数		false	criteriaMap_8	criteriaMap_8
endTimestamp	结束时间错（毫秒）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«VipDataStatistics»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	VipDataStatistics	VipDataStatistics
allVipCount	所有会员量	integer(int64)
dayVipCount	当天开通会员量	integer(int64)
experienceVipCount	体验会员量	integer(int64)
formalVipCount	正式会员量	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "allVipCount": 0,
        "dayVipCount": 0,
        "experienceVipCount": 0,
        "formalVipCount": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

当周余额充值统计

接口地址:/panel/get_week_balance_recharge

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
panelParam	面板参数	body	false	PanelParam	PanelParam
criteriaMap	赛选条件参数		false	criteriaMap_8	criteriaMap_8
endTimestamp	结束时间错（毫秒）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«List«StatisticsData»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	array	StatisticsData
count	数量	integer(int64)
date	年-月-日	string(date)
day	日	integer(int32)
hourGroup	小时分组	integer(int32)
money	金额	number
month	月	integer(int32)
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer(int32)
year	年	integer(int32)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": [
        {
            "count": 0,
            "date": "",
            "day": 0,
            "hourGroup": 0,
            "money": 0,
            "month": 0,
            "monthName": "",
            "timeRange": "",
            "weekdayName": "",
            "weekdayNum": 0,
            "year": 0
        }
    ],
    "message": "",
    "success": true,
    "timestamp": 0
}

当周余额提现统计

接口地址:/panel/get_week_balance_withdraw

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
panelParam	面板参数	body	false	PanelParam	PanelParam
criteriaMap	赛选条件参数		false	criteriaMap_8	criteriaMap_8
endTimestamp	结束时间错（毫秒）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«List«StatisticsData»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	array	StatisticsData
count	数量	integer(int64)
date	年-月-日	string(date)
day	日	integer(int32)
hourGroup	小时分组	integer(int32)
money	金额	number
month	月	integer(int32)
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer(int32)
year	年	integer(int32)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": [
        {
            "count": 0,
            "date": "",
            "day": 0,
            "hourGroup": 0,
            "money": 0,
            "month": 0,
            "monthName": "",
            "timeRange": "",
            "weekdayName": "",
            "weekdayNum": 0,
            "year": 0
        }
    ],
    "message": "",
    "success": true,
    "timestamp": 0
}

当周注册数量统计

接口地址:/panel/get_week_register_statistics

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
panelParam	面板参数	body	false	PanelParam	PanelParam
criteriaMap	赛选条件参数		false	criteriaMap_8	criteriaMap_8
endTimestamp	结束时间错（毫秒）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«RegisterDataStatistics»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	RegisterDataStatistics	RegisterDataStatistics
monthRegisterCount	当月用户注册数量	integer(int64)
monthRegisterData	统计数据	array	StatisticsData
count	数量	integer
date	年-月-日	string
day	日	integer
hourGroup	小时分组	integer
money	金额	number
month	月	integer
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer
year	年	integer
todayRegisterCount	当天用户注册数量	integer(int64)
todayRegisterData	统计数据	array	StatisticsData
count	数量	integer
date	年-月-日	string
day	日	integer
hourGroup	小时分组	integer
money	金额	number
month	月	integer
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer
year	年	integer
weekRegisterCount	当周用户注册数量	integer(int64)
weekRegisterData	统计数据	array	StatisticsData
count	数量	integer
date	年-月-日	string
day	日	integer
hourGroup	小时分组	integer
money	金额	number
month	月	integer
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer
year	年	integer
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "monthRegisterCount": 0,
        "monthRegisterData": [
            {
                "count": 0,
                "date": "",
                "day": 0,
                "hourGroup": 0,
                "money": 0,
                "month": 0,
                "monthName": "",
                "timeRange": "",
                "weekdayName": "",
                "weekdayNum": 0,
                "year": 0
            }
        ],
        "todayRegisterCount": 0,
        "todayRegisterData": [
            {
                "count": 0,
                "date": "",
                "day": 0,
                "hourGroup": 0,
                "money": 0,
                "month": 0,
                "monthName": "",
                "timeRange": "",
                "weekdayName": "",
                "weekdayNum": 0,
                "year": 0
            }
        ],
        "weekRegisterCount": 0,
        "weekRegisterData": [
            {
                "count": 0,
                "date": "",
                "day": 0,
                "hourGroup": 0,
                "money": 0,
                "month": 0,
                "monthName": "",
                "timeRange": "",
                "weekdayName": "",
                "weekdayNum": 0,
                "year": 0
            }
        ]
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

当周风铃充值统计

接口地址:/panel/get_week_wind_chime_recharge

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
panelParam	面板参数	body	false	PanelParam	PanelParam
criteriaMap	赛选条件参数		false	criteriaMap_8	criteriaMap_8
endTimestamp	结束时间错（毫秒）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«List«StatisticsData»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	array	StatisticsData
count	数量	integer(int64)
date	年-月-日	string(date)
day	日	integer(int32)
hourGroup	小时分组	integer(int32)
money	金额	number
month	月	integer(int32)
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer(int32)
year	年	integer(int32)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": [
        {
            "count": 0,
            "date": "",
            "day": 0,
            "hourGroup": 0,
            "money": 0,
            "month": 0,
            "monthName": "",
            "timeRange": "",
            "weekdayName": "",
            "weekdayNum": 0,
            "year": 0
        }
    ],
    "message": "",
    "success": true,
    "timestamp": 0
}

当年余额充值统计

接口地址:/panel/get_year_balance_recharge

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
panelParam	面板参数	body	false	PanelParam	PanelParam
criteriaMap	赛选条件参数		false	criteriaMap_8	criteriaMap_8
endTimestamp	结束时间错（毫秒）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«List«StatisticsData»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	array	StatisticsData
count	数量	integer(int64)
date	年-月-日	string(date)
day	日	integer(int32)
hourGroup	小时分组	integer(int32)
money	金额	number
month	月	integer(int32)
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer(int32)
year	年	integer(int32)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": [
        {
            "count": 0,
            "date": "",
            "day": 0,
            "hourGroup": 0,
            "money": 0,
            "month": 0,
            "monthName": "",
            "timeRange": "",
            "weekdayName": "",
            "weekdayNum": 0,
            "year": 0
        }
    ],
    "message": "",
    "success": true,
    "timestamp": 0
}

当年余额提现统计

接口地址:/panel/get_year_balance_withdraw

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
panelParam	面板参数	body	false	PanelParam	PanelParam
criteriaMap	赛选条件参数		false	criteriaMap_8	criteriaMap_8
endTimestamp	结束时间错（毫秒）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«List«StatisticsData»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	array	StatisticsData
count	数量	integer(int64)
date	年-月-日	string(date)
day	日	integer(int32)
hourGroup	小时分组	integer(int32)
money	金额	number
month	月	integer(int32)
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer(int32)
year	年	integer(int32)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": [
        {
            "count": 0,
            "date": "",
            "day": 0,
            "hourGroup": 0,
            "money": 0,
            "month": 0,
            "monthName": "",
            "timeRange": "",
            "weekdayName": "",
            "weekdayNum": 0,
            "year": 0
        }
    ],
    "message": "",
    "success": true,
    "timestamp": 0
}

当年风铃充值统计

接口地址:/panel/get_year_wind_chime_recharge

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
panelParam	面板参数	body	false	PanelParam	PanelParam
criteriaMap	赛选条件参数		false	criteriaMap_8	criteriaMap_8
endTimestamp	结束时间错（毫秒）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«List«StatisticsData»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	array	StatisticsData
count	数量	integer(int64)
date	年-月-日	string(date)
day	日	integer(int32)
hourGroup	小时分组	integer(int32)
money	金额	number
month	月	integer(int32)
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer(int32)
year	年	integer(int32)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": [
        {
            "count": 0,
            "date": "",
            "day": 0,
            "hourGroup": 0,
            "money": 0,
            "month": 0,
            "monthName": "",
            "timeRange": "",
            "weekdayName": "",
            "weekdayNum": 0,
            "year": 0
        }
    ],
    "message": "",
    "success": true,
    "timestamp": 0
}

ML-商品管理

DB-商品分类

接口地址:/goods/category

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
categoryId	分类ID	query	false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«List«GoodsCategory对象»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	array	GoodsCategory对象
children		array	GoodsCategory对象
fullPath		string
id		integer(int32)
image	分类图片	string
isHomePage	是否首页展示	integer(int32)
level		integer(int32)
name		string
orderId		integer(int32)
path		string
pid		integer(int32)
rootId		integer(int32)
twoId		integer(int32)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": [
        {
            "children": [
                {
                    "children": [
                        {}
                    ],
                    "fullPath": "",
                    "id": 0,
                    "image": "",
                    "isHomePage": 0,
                    "level": 0,
                    "name": "",
                    "orderId": 0,
                    "path": "",
                    "pid": 0,
                    "rootId": 0,
                    "twoId": 0
                }
            ],
            "fullPath": "",
            "id": 0,
            "image": "",
            "isHomePage": 0,
            "level": 0,
            "name": "",
            "orderId": 0,
            "path": "",
            "pid": 0,
            "rootId": 0,
            "twoId": 0
        }
    ],
    "message": "",
    "success": true,
    "timestamp": 0
}

能量商品发货

接口地址:/goods/deliver_goods

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "expressCode": "",
  "expressName": "",
  "expressNum": "",
  "orderNum": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
energyGoodsDeliverParam	能量商品发货参数	body	true	EnergyGoodsDeliverParam	EnergyGoodsDeliverParam
expressCode	快递代号		true	string
expressName	快递名称		true	string
expressNum	快递号		true	string
orderNum	订单号		true	string

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

商品运费模板

接口地址:/goods/freight_template

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	接口返回对象«List«LogisticsTemplate对象»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	array	LogisticsTemplate对象
content	模板详情	string
createTime	创建时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
id		integer(int32)
price	没选地区默认运费	number
status	状态 1正常 0删除	integer(int32)
title	模板名称	string
userId	用户id	integer(int32)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": [
        {
            "content": "",
            "createTime": {
                "date": 0,
                "day": 0,
                "hours": 0,
                "minutes": 0,
                "month": 0,
                "nanos": 0,
                "seconds": 0,
                "time": 0,
                "timezoneOffset": 0,
                "year": 0
            },
            "id": 0,
            "price": 0,
            "status": 0,
            "title": "",
            "userId": 0
        }
    ],
    "message": "",
    "success": true,
    "timestamp": 0
}

获取Cookie

接口地址:/goods/getCookie

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

DB-商条形码

接口地址:/goods/goods_bar_code

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
goodsId	商品ID	query	true	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

商品订单

接口地址:/goods/goods_order

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "goodsOrderNum": "",
    "goodsOrderType": 0,
    "keyWord": "",
    "keyWordType": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
goodsOrderParam	商品订单	body	true	GoodsOrderParam	GoodsOrderParam
criteriaMap	赛选条件参数		true	criteriaMap_1	criteriaMap_1
endTimestamp	结束时间错（毫秒）		false	integer
goodsOrderNum	商品订单号【查询详情时查看】		false	string
goodsOrderType	订单类型（1：快卖商品订单 2：能量商品订单）		true	integer
keyWord	搜索关键词（仅兑换人昵称）		false	string
keyWordType	筛选类型（状态 0待确认(填写收货地址) 1待发货 2已发货 3已收货4买家退款申请 5: 买家主动退款 6卖家同意退款 7卖家主动退款 8 买家撤销退款申请 9卖家拒绝退款 10订单取消）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

DB-商品列表

接口地址:/goods/list

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "classifyID": 0,
    "endTimestamp": 0,
    "goodsType": 0,
    "keyWord": "",
    "merchantID": 0,
    "sort": [],
    "startTimestamp": 0,
    "status": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
queryGoodsParam	查询商品参数	body	true	QueryGoodsParam	QueryGoodsParam
criteriaMap	赛选条件参数		false	criteriaMap_5	criteriaMap_5
classifyID	一级分类ID		false	integer
endTimestamp	结束时间错（毫秒）——默认值：0		false	integer
goodsType	商品类型（0:其他商品(默认值) 1：快卖商品 2：能量商品）		false	integer
keyWord	搜索关键词（商品名/ID/SKU）		false	string
merchantID	商家ID		false	integer
sort	按XXX排序（1：昵称 2：能量值 3：库存 4：价格 5：上下架状态 6：限制条件）,——默认值: 降序,且不按指定字段排序		false	array	integer
startTimestamp	开始时间戳（毫秒）——默认值：0		false	integer
status	状态 (-1：全部（默认值） 3：已发布-待审核 4：已发布-审核驳回 1：已上架-审核通过 0：已下架 2：删除)		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«PageData«GoodsVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	PageData«GoodsVO»	PageData«GoodsVO»
dataList	商品列表	array	GoodsVO
categoryId	分类ID	integer
goodsBusinessName	商家名	string
goodsClassify	商品分类	string
goodsComplaintVolume	商品投诉量	integer
goodsFavorableRate	商品好评率	number
goodsID	商品ID	integer
goodsInventory	商品库存	integer
goodsMainImgUrl	商品主图	array	string
goodsOffReason	商品下架原因	string
goodsOffTime	下架时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
goodsPrice	商品价格	number
goodsReleaseTime	发布时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
goodsReturnRate	商品退货率	number
goodsSales	商品销量	integer
goodsStatus	商品状态 (0：已下架 1：已上架-审核通过 2：删除 3：已发布-待审核 4：已发布-审核驳回)	integer
goodsTitle	商品标题	string
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "dataList": [
            {
                "categoryId": 0,
                "goodsBusinessName": "",
                "goodsClassify": "",
                "goodsComplaintVolume": 0,
                "goodsFavorableRate": 0,
                "goodsID": 0,
                "goodsInventory": 0,
                "goodsMainImgUrl": [],
                "goodsOffReason": "",
                "goodsOffTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "goodsPrice": 0,
                "goodsReleaseTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "goodsReturnRate": 0,
                "goodsSales": 0,
                "goodsStatus": 0,
                "goodsTitle": ""
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

物流公司代码

接口地址:/goods/logistics_codes

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	接口返回对象«List«LogisticsCode对象»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	array	LogisticsCode对象
code	代码	string
id		integer(int32)
name	物流公司名称	string
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": [
        {
            "code": "",
            "id": 0,
            "name": ""
        }
    ],
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-商品上架拒绝原因列表

接口地址:/goods/offline_reasons

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
keyWord	搜索关键词	query	false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«List«GoodsOfflineReasons对象»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	array	GoodsOfflineReasons对象
category	分类：商品信息、品牌资质、价格设置、图片要求、合规性等	string
createTime	创建时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
id	主键ID	integer(int64)
isActive	是否启用：1-启用,0-禁用	integer(int32)
reasonCode	下架原因编码	string
reasonDescription	下架原因详细描述	string
reasonName	下架原因名称	string
sortOrder	排序字段	integer(int32)
updateTime	更新时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": [
        {
            "category": "",
            "createTime": {
                "date": 0,
                "day": 0,
                "hours": 0,
                "minutes": 0,
                "month": 0,
                "nanos": 0,
                "seconds": 0,
                "time": 0,
                "timezoneOffset": 0,
                "year": 0
            },
            "id": 0,
            "isActive": 0,
            "reasonCode": "",
            "reasonDescription": "",
            "reasonName": "",
            "sortOrder": 0,
            "updateTime": {
                "date": 0,
                "day": 0,
                "hours": 0,
                "minutes": 0,
                "month": 0,
                "nanos": 0,
                "seconds": 0,
                "time": 0,
                "timezoneOffset": 0,
                "year": 0
            }
        }
    ],
    "message": "",
    "success": true,
    "timestamp": 0
}

商品（CRUD）

接口地址:/goods/operate

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "energyGoodsEditParams": [
      {
        "content": "",
        "energy": 0,
        "expressPrice": 0,
        "expressTemplate": 0,
        "expressType": 0,
        "goodType": 0,
        "goodsId": 0,
        "id": 0,
        "image": "",
        "isLimitBuy": 0,
        "limitNum": 0,
        "name": "",
        "odds": 0,
        "price": 0,
        "status": 0,
        "stock": 0,
        "type": 0
      }
    ],
    "energyGoodsQueryParams": {
      "endTimestamp": 0,
      "id": 0,
      "keyWord": "",
      "pageCount": 0,
      "pageSize": 0,
      "screenType": 0,
      "sort": [],
      "startTimestamp": 0
    }
  },
  "goodsIlk": 0,
  "operateType": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
goodsOperateParam	商品操作参数对象	body	true	GoodsOperateParam	GoodsOperateParam
criteriaMap	赛选条件参数		true	criteriaMap	criteriaMap
energyGoodsEditParams	能量商品编辑/添加参数		false	array	EnergyGoodsEditParam
content	商品描述【注：仅编辑选传/添加必传】		false	string
energy	需要能量【注：仅编辑选传/添加必传】		false	number
expressPrice	运费(固定费用时为费用值，其他时为：0） ——默认值：0【注：仅编辑/（添加时，选传——未传默认值）】		false	number
expressTemplate	邮费模板Id——【注：仅编辑选传/非手动创建时添加必传，无手动创建添加时必传）】		false	integer
expressType	商品运费模板（0：固定费用 1：按距离计费 2：无需邮寄 3：包邮）——默认值：3【注：仅编辑选传/添加必传——未传默认值）】		false	integer
goodType	商品类型（0：实物 1：虚拟）——默认值：0【注：仅编辑/添加时，选传——未传默认值）】		false	integer
goodsId	映射的商品ID，如：选择的快卖商品ID【注：仅添加时，必传】		false	integer
id	商品ID【注：仅编辑/删除时，必传】		false	integer
image	商品图片URL，多张','分割【注：仅编辑选传/添加必传】		false	string
isLimitBuy	是否限购（0：不限购 1：限购）———默认值：0【注：仅编辑选传/添加时，选传】		false	integer
limitNum	限购数量【注：仅编辑选传/添加时，选传】		false	integer
name	商品名【注：编辑选传/添加必传】		false	string
odds	中奖权重，type=1时设置 ——默认值：0【注：仅编辑/添加时，选传——未传默认值）】		false	integer
price	价格【注：仅编辑选传/添加必传】		false	number
status	上架状态（0：下架、1：正常）——默认值：1【注：仅编辑/添加时，选传——未传默认值）】		false	integer
stock	库存【注：仅编辑选传/添加必传】		false	integer
type	商品类型（0：积分商城 1：抽奖商品）——默认值：0【注：仅编辑/添加时，选传——未传默认值）】		false	integer
energyGoodsQueryParams	能量商品查询参数		false	EnergyGoodsQueryParam	EnergyGoodsQueryParam
endTimestamp	结束时间错（毫秒）——默认值：0【注：仅查询时，选传——未传默认值）】		false	integer
id	商品ID——默认值：0【注：仅查询详情时必传传——未传默认值）】		false	integer
keyWord	搜索关键词（商品名）——默认值：0【注：仅查询时，选传——未传默认值）】		false	string
pageCount	当前页数【默认：0 即：第1页】【注：仅查询传，可选传，未传则默认值】		false	integer
pageSize	页大小【默认：10条】【注：仅查询传，可选传，未传则默认值】		false	integer
screenType	筛选类型（0、全部，1：产品ID，2：产品昵称）——默认值：0【注：仅查询时，选传——未传默认值）】		false	integer
sort	按XXX排序（1：昵称 2：能量值 3：库存 4：价格 5：上下架状态 6：限制条件）,——默认值: 降序,且不按指定字段排序【注：仅查询时，选传——未传默认值）】		false	array	integer
startTimestamp	开始时间戳（毫秒）——默认值：0【注：仅查询时，选传——未传默认值）】		false	integer
goodsIlk	商品类型（0：积分商城 1：抽奖商品 2:快卖商品）——默认值：0		true	integer(int32)
operateType	操作类型（0：无效操作，1：添加商品，2：删除商品 3：修改商品 4：查询商品）—— 默认值：0		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

DB-快卖物流轨迹（实时）

接口地址:/goods/qg_logistics_realtime

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "customerName": "",
  "logisticCode": "",
  "shipperCode": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
logisticsParam	订单物流轨迹参数	body	true	LogisticsParam	LogisticsParam
customerName	手机尾号4位		true	string
logisticCode	物流单号		true	string
shipperCode	物流类型标识 SF 等		true	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«KdniaoResponseDTO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	KdniaoResponseDTO	KdniaoResponseDTO
ebusinessID		string
location		string
logisticCode		string
orderCode		string
shipperCode		string
state		string
stateEx		string
success		boolean
traces	轨迹	array	Traces
acceptStation		string
acceptTime		string
action		string
location		string
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "ebusinessID": "",
        "location": "",
        "logisticCode": "",
        "orderCode": "",
        "shipperCode": "",
        "state": "",
        "stateEx": "",
        "success": true,
        "traces": [
            {
                "acceptStation": "",
                "acceptTime": "",
                "action": "",
                "location": ""
            }
        ]
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-快卖商品批量发货（商家）

接口地址:/goods/quickly_batch_deliver_goods

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "expressCode": "",
  "expressName": "",
  "expressNum": "",
  "orderNum": "",
  "orderNums": [],
  "sellerId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
quicklyDeliverGoodsParam	快卖商品发货参数	body	true	QuicklyDeliverGoodsParam	QuicklyDeliverGoodsParam
expressCode	物流公司代号）		true	string
expressName	物流名称）		true	string
expressNum	物流号）		true	string
orderNum	订单号: 单个发货）		true	string
orderNums	订单号: 批量发货		true	array	string
sellerId	卖家ID）		true	integer(int32)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

DB-快卖商品发货（商家）

接口地址:/goods/quickly_deliver_goods

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "expressCode": "",
  "expressName": "",
  "expressNum": "",
  "orderNum": "",
  "orderNums": [],
  "sellerId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
quicklyDeliverGoodsParam	快卖商品发货参数	body	true	QuicklyDeliverGoodsParam	QuicklyDeliverGoodsParam
expressCode	物流公司代号）		true	string
expressName	物流名称）		true	string
expressNum	物流号）		true	string
orderNum	订单号: 单个发货）		true	string
orderNums	订单号: 批量发货		true	array	string
sellerId	卖家ID）		true	integer(int32)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

快卖商品

接口地址:/goods/quickly_goods

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "goodsType": 0,
    "keyWord": "",
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
goodsParam	商品参数	body	true	GoodsParam	GoodsParam
criteriaMap	赛选条件参数		true	CriteriaMap	CriteriaMap
endTimestamp	结束时间错（毫秒）		false	integer
goodsType	订单类型（1：快卖商品 2：能量商品）		true	integer
keyWord	搜索关键词（商品昵称）		false	string
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«PageData«FriendCircle对象»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	PageData«FriendCircle对象»	PageData«FriendCircle对象»
dataList	朋友圈	array	FriendCircle对象
allowWindChimePay	是否允许风铃支付 （Y=允许,N=不允许）	string
collectionNum	收藏数	integer
commentNum	评论数	integer
content	文字内容	string
createTime	创建时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
delTime	删除时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
friendType	内容类型（common=通常）	string
goodsNum	快卖商品剩余（卖出后的库存）	integer
goodsPrice	快卖价格	number
goodsStock	快卖库存（添加快卖时的库存 这个是不会变的）	integer
helpNum	点赞数	integer
id	主键	integer
invisible	不可见用户ID	string
isExtend		string
isPublishAddr	是否公布朋友圈定位（:Y=是,N=否）	string
link	跳转链接	string
linkTitle	链接标题	string
preRelease	预发布 Y=是,N=不是	string
quicklyStatus	快卖状态（0：已删除 1正常）	integer
shareNum	分享数量	integer
source	来源	string
topRank	宇宙朋友圈排序等级	integer
topTime	朋友圈置顶时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
topUser	个人朋友圈置顶	integer
type	类型（0 朋友图 1快卖 2外部链接,3到门口商品 99广告）	integer
unlikeNum	点踩数	integer
upTime	修改时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
updNum	朋友圈修改次数，最多3次	integer
url	商品图片（多张','分隔）	string
userId	用户id	integer
visible	可见状态(public=公开,private=仅自己可见 part=部分可见 invisible=部分不可见)	string
visitNum	浏览量	integer
windChimeRatio	风铃支付比例	integer
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "dataList": [
            {
                "allowWindChimePay": "",
                "collectionNum": 0,
                "commentNum": 0,
                "content": "",
                "createTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "delTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "friendType": "",
                "goodsNum": 0,
                "goodsPrice": 0,
                "goodsStock": 0,
                "helpNum": 0,
                "id": 0,
                "invisible": "",
                "isExtend": "",
                "isPublishAddr": "",
                "link": "",
                "linkTitle": "",
                "preRelease": "",
                "quicklyStatus": 0,
                "shareNum": 0,
                "source": "",
                "topRank": 0,
                "topTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "topUser": 0,
                "type": 0,
                "unlikeNum": 0,
                "upTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "updNum": 0,
                "url": "",
                "userId": 0,
                "visible": "",
                "visitNum": 0,
                "windChimeRatio": 0
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-快卖商品详情

接口地址:/goods/quickly_goods_info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
goodsId	商品ID	query	true	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«GoodsInfoVO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	GoodsInfoVO	GoodsInfoVO
goodsBarcode	商品条形码	string
goodsBusinessName	商家名	string
goodsComplaintVolume	商品投诉量	integer(int32)
goodsDetails	商品详情	string
goodsFavorableRate	商品好评率	number(double)
goodsID	商品ID	integer(int32)
goodsInventory	商品库存	integer(int32)
goodsLink	跳转链接	string
goodsMainImgUrl	商品主图	array	string
goodsMarketPrice	商品市场价格	number
goodsOffReason	商品下架原因	string
goodsOffTime	下架时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
goodsPrice	商品价格	number
goodsQRCode	商品二维码	string
goodsReleaseTime	发布时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
goodsReturnRate	商品退货率	number(double)
goodsSales	商品销量	integer(int32)
goodsStatus	商品状态 (0：已下架 1：已上架-审核通过 2：删除 3：已发布-待审核 4：已发布-审核驳回)	integer(int32)
goodsTitle	商品标题	string
goodsUpdateTime	更新时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
shippingAddress	发货地址	string
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "goodsBarcode": "",
        "goodsBusinessName": "",
        "goodsComplaintVolume": 0,
        "goodsDetails": "",
        "goodsFavorableRate": 0,
        "goodsID": 0,
        "goodsInventory": 0,
        "goodsLink": "",
        "goodsMainImgUrl": [],
        "goodsMarketPrice": 0,
        "goodsOffReason": "",
        "goodsOffTime": {
            "date": 0,
            "day": 0,
            "hours": 0,
            "minutes": 0,
            "month": 0,
            "nanos": 0,
            "seconds": 0,
            "time": 0,
            "timezoneOffset": 0,
            "year": 0
        },
        "goodsPrice": 0,
        "goodsQRCode": "",
        "goodsReleaseTime": {
            "date": 0,
            "day": 0,
            "hours": 0,
            "minutes": 0,
            "month": 0,
            "nanos": 0,
            "seconds": 0,
            "time": 0,
            "timezoneOffset": 0,
            "year": 0
        },
        "goodsReturnRate": 0,
        "goodsSales": 0,
        "goodsStatus": 0,
        "goodsTitle": "",
        "goodsUpdateTime": {
            "date": 0,
            "day": 0,
            "hours": 0,
            "minutes": 0,
            "month": 0,
            "nanos": 0,
            "seconds": 0,
            "time": 0,
            "timezoneOffset": 0,
            "year": 0
        },
        "shippingAddress": ""
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

快卖商品订单

接口地址:/goods/quickly_goods_order

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "goodsOrderNum": "",
    "goodsOrderType": 0,
    "keyWord": "",
    "keyWordType": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
goodsOrderParam	商品订单	body	true	GoodsOrderParam	GoodsOrderParam
criteriaMap	赛选条件参数		true	criteriaMap_1	criteriaMap_1
endTimestamp	结束时间错（毫秒）		false	integer
goodsOrderNum	商品订单号【查询详情时查看】		false	string
goodsOrderType	订单类型（1：快卖商品订单 2：能量商品订单）		true	integer
keyWord	搜索关键词（仅兑换人昵称）		false	string
keyWordType	筛选类型（状态 0待确认(填写收货地址) 1待发货 2已发货 3已收货4买家退款申请 5: 买家主动退款 6卖家同意退款 7卖家主动退款 8 买家撤销退款申请 9卖家拒绝退款 10订单取消）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«PageData«QuicklyOrder对象»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	PageData«QuicklyOrder对象»	PageData«QuicklyOrder对象»
dataList	快卖订单	array	QuicklyOrder对象
addressId	选择的地址编号	integer
agreeReason	商家主动退款原因	string
applyInterposeTime	申请客服介入时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
applyRefundTime	申请退款时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
cancelApplyRefundTime	撤销申请退款时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
consignee	收件人	string
createTime	创建时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
deletedAt	删除时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
deliveryTime	发货时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
expressCode	物流公司代码	string
expressName	快递公司名称	string
expressNum	快递单号	string
goodPrice	商品价格	number
goodSpecsId	商品规格id	integer
goodsId	商品id	integer
goodsName	商品名	string
goodsUrl	商品图（多个','分隔）	string
handleTime	商家处理时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
helpPayUserId	代付用户id	integer
hfReqDate	汇付请求日期	string
hfReqSeqId	汇付请求流水号	string
id		integer
interposeCompleteTime	客服处理时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
interposeReason	申请客服介入原因（json）	string
isHelpPay	是否是代付	string
isInterpose	客服是否接入（0：未介入 1：申请介入 2：介入中 3：处理完成）	integer
nickname	卖家昵称	string
notes	订单备注	string
orderNum	订单号	string
orderType	订单类型（废弃）	integer
payNum	支付数量	string
payTime	支付时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
payType	0余额支付 1风铃支付 2支付宝,3微信 4 银行卡快捷支付（斗拱） 5 入群有礼	integer
portraitUri	卖家头像	string
price	支付价格	number
primaryOrderNum	主订单号，多个商品一起支付时使用	string
qianshouNotice	是否发送签收通知 0没有 1发送了	integer
reason	申请退款原因（json）	string
receivedTime	收货时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
refundMoney	退款金额	number
refundTime	退款时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
refuseReason	商家拒绝原因	string
sellerId	卖家ID	integer
state	订单状态 0 待支付 1已支付 2已发货 3确认收货 4买家退款申请 5买家主动退款 6卖家同意退款 7卖家主动退款 8 买家撤销退款申请 9卖家拒绝退款 10订单取消 11订单删除	integer
status	状态 0 待支付 1已支付 2已发货 3确认收货 4退款申请 5已退款 10订单取消 11订单删除	integer
telephone	手机号码	integer
tradeNum	订单交易号，用于退款	string
userId	用户ID	integer
windChimeOffset	抵扣的风铃	number
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "dataList": [
            {
                "addressId": 0,
                "agreeReason": "",
                "applyInterposeTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "applyRefundTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "cancelApplyRefundTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "consignee": "",
                "createTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "deletedAt": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "deliveryTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "expressCode": "",
                "expressName": "",
                "expressNum": "",
                "goodPrice": 0,
                "goodSpecsId": 0,
                "goodsId": 0,
                "goodsName": "",
                "goodsUrl": "",
                "handleTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "helpPayUserId": 0,
                "hfReqDate": "",
                "hfReqSeqId": "",
                "id": 0,
                "interposeCompleteTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "interposeReason": "",
                "isHelpPay": "",
                "isInterpose": 0,
                "nickname": "",
                "notes": "",
                "orderNum": "",
                "orderType": 0,
                "payNum": "",
                "payTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "payType": 0,
                "portraitUri": "",
                "price": 0,
                "primaryOrderNum": "",
                "qianshouNotice": 0,
                "reason": "",
                "receivedTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "refundMoney": 0,
                "refundTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "refuseReason": "",
                "sellerId": 0,
                "state": 0,
                "status": 0,
                "telephone": 0,
                "tradeNum": "",
                "userId": 0,
                "windChimeOffset": 0
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-快卖订单详情

接口地址:/goods/quickly_goods_order_info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
goodsOrderNum	商品订单号	query	true	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«QuicklyGoodsOrderResult»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	QuicklyGoodsOrderResult	QuicklyGoodsOrderResult
consignee	收货人姓名	string
consigneePhone	收货人电话	string
createTime	订单创建时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
deliveryAddress	收货地址	string
deliveryAddressId	收货地址Id	string
deliveryTime	订单发货时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
discountAmount	优惠金额	number
finishTime	订单完成时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
goodsBusinessId	商家卖家ID	string
goodsBusinessName	商家名称	string
goodsCount	商品数量	integer(int32)
goodsExpressCode	快递名（英文简称）	string
goodsExpressName	快递公司名称	string
goodsExpressNum	快递单号	string
goodsID	商品ID	string
goodsMainImgUrl	商品主图URL	array	string
goodsOrderNum	商品订单号	string
goodsOrderState	商品订单状态	integer(int32)
goodsPrice	商品价格（单价）	number
goodsSellerId	卖家名称	string
goodsSellerName	卖家名称	string
goodsSpec	商品规格	string
goodsTitle	商品标题	string
payAmount	实际支付金额	number
payTime	订单支付时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
payType	订单支付方式（0余额支付 1风铃支付 2支付宝,3微信 4 银行卡快捷支付（斗拱）5 入群有礼 6到门口余额 7宏图 8华标 9助花 10竹花 11竹购）	integer(int32)
remark	订单备注	string
shippingFee	运费	number
totalAmount	订单总金额	number
userId	用户Id	integer(int32)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "consignee": "",
        "consigneePhone": "",
        "createTime": {
            "date": 0,
            "day": 0,
            "hours": 0,
            "minutes": 0,
            "month": 0,
            "nanos": 0,
            "seconds": 0,
            "time": 0,
            "timezoneOffset": 0,
            "year": 0
        },
        "deliveryAddress": "",
        "deliveryAddressId": "",
        "deliveryTime": {
            "date": 0,
            "day": 0,
            "hours": 0,
            "minutes": 0,
            "month": 0,
            "nanos": 0,
            "seconds": 0,
            "time": 0,
            "timezoneOffset": 0,
            "year": 0
        },
        "discountAmount": 0,
        "finishTime": {
            "date": 0,
            "day": 0,
            "hours": 0,
            "minutes": 0,
            "month": 0,
            "nanos": 0,
            "seconds": 0,
            "time": 0,
            "timezoneOffset": 0,
            "year": 0
        },
        "goodsBusinessId": "",
        "goodsBusinessName": "",
        "goodsCount": 0,
        "goodsExpressCode": "",
        "goodsExpressName": "",
        "goodsExpressNum": "",
        "goodsID": "",
        "goodsMainImgUrl": [],
        "goodsOrderNum": "",
        "goodsOrderState": 0,
        "goodsPrice": 0,
        "goodsSellerId": "",
        "goodsSellerName": "",
        "goodsSpec": "",
        "goodsTitle": "",
        "payAmount": 0,
        "payTime": {
            "date": 0,
            "day": 0,
            "hours": 0,
            "minutes": 0,
            "month": 0,
            "nanos": 0,
            "seconds": 0,
            "time": 0,
            "timezoneOffset": 0,
            "year": 0
        },
        "payType": 0,
        "remark": "",
        "shippingFee": 0,
        "totalAmount": 0,
        "userId": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-快卖商品订单

接口地址:/goods/quickly_goods_orders

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "buyerName": "",
    "endTimestamp": 0,
    "goodsName": "",
    "goodsOrderNum": "",
    "goodsOrderType": 0,
    "orderState": 0,
    "startTimestamp": 0,
    "userId": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
quicklyGoodsOrderParam	快卖商品订单	body	true	QuicklyGoodsOrderParam	QuicklyGoodsOrderParam
criteriaMap	赛选条件参数		true	criteriaMap_6	criteriaMap_6
buyerName	买家姓名		false	string
endTimestamp	结束时间错（毫秒）		false	integer
goodsName	商品名		false	string
goodsOrderNum	商品订单号		false	string
goodsOrderType	订单类型（1：快卖商品订单 2：能量商品订单）		true	integer
orderState	筛选类型（状态 0待确认(填写收货地址) 1待发货 2已发货 3已收货4买家退款申请 5: 买家主动退款 6卖家同意退款 7卖家主动退款 8 买家撤销退款申请 9卖家拒绝退款 10订单取消）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
userId	用户ID		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«PageData«QuicklyGoodsOrderResult»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	PageData«QuicklyGoodsOrderResult»	PageData«QuicklyGoodsOrderResult»
dataList	快卖商品订单	array	QuicklyGoodsOrderResult
consignee	收货人姓名	string
consigneePhone	收货人电话	string
createTime	订单创建时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
deliveryAddress	收货地址	string
deliveryAddressId	收货地址Id	string
deliveryTime	订单发货时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
discountAmount	优惠金额	number
finishTime	订单完成时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
goodsBusinessId	商家卖家ID	string
goodsBusinessName	商家名称	string
goodsCount	商品数量	integer
goodsExpressCode	快递名（英文简称）	string
goodsExpressName	快递公司名称	string
goodsExpressNum	快递单号	string
goodsID	商品ID	string
goodsMainImgUrl	商品主图URL	array	string
goodsOrderNum	商品订单号	string
goodsOrderState	商品订单状态	integer
goodsPrice	商品价格（单价）	number
goodsSellerId	卖家名称	string
goodsSellerName	卖家名称	string
goodsSpec	商品规格	string
goodsTitle	商品标题	string
payAmount	实际支付金额	number
payTime	订单支付时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
payType	订单支付方式（0余额支付 1风铃支付 2支付宝,3微信 4 银行卡快捷支付（斗拱）5 入群有礼 6到门口余额 7宏图 8华标 9助花 10竹花 11竹购）	integer
remark	订单备注	string
shippingFee	运费	number
totalAmount	订单总金额	number
userId	用户Id	integer
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "dataList": [
            {
                "consignee": "",
                "consigneePhone": "",
                "createTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "deliveryAddress": "",
                "deliveryAddressId": "",
                "deliveryTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "discountAmount": 0,
                "finishTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "goodsBusinessId": "",
                "goodsBusinessName": "",
                "goodsCount": 0,
                "goodsExpressCode": "",
                "goodsExpressName": "",
                "goodsExpressNum": "",
                "goodsID": "",
                "goodsMainImgUrl": [],
                "goodsOrderNum": "",
                "goodsOrderState": 0,
                "goodsPrice": 0,
                "goodsSellerId": "",
                "goodsSellerName": "",
                "goodsSpec": "",
                "goodsTitle": "",
                "payAmount": 0,
                "payTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "payType": 0,
                "remark": "",
                "shippingFee": 0,
                "totalAmount": 0,
                "userId": 0
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-快卖成交额统计

接口地址:/goods/quickly_goods_orders_amount

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	接口返回对象«OrderDashboardDTO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	OrderDashboardDTO	OrderDashboardDTO
amountGrowthPercent		number
disputeGrowthPercent		number
orderCountGrowthPercent		number
todayAmount	今日成交金额统计	number
todayNewDisputeCount		integer(int32)
todayOrderCount		integer(int32)
todayUnhandledRefundCount		integer(int32)
unhandledRefundGrowthPercent		number
yesterdayAmount		number
yesterdayNewDisputeCount		integer(int32)
yesterdayOrderCount		integer(int32)
yesterdayUnhandledRefundCount		integer(int32)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "amountGrowthPercent": 0,
        "disputeGrowthPercent": 0,
        "orderCountGrowthPercent": 0,
        "todayAmount": 0,
        "todayNewDisputeCount": 0,
        "todayOrderCount": 0,
        "todayUnhandledRefundCount": 0,
        "unhandledRefundGrowthPercent": 0,
        "yesterdayAmount": 0,
        "yesterdayNewDisputeCount": 0,
        "yesterdayOrderCount": 0,
        "yesterdayUnhandledRefundCount": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-快卖订单数统计

接口地址:/goods/quickly_goods_orders_count

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	接口返回对象«OrderDashboardDTO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	OrderDashboardDTO	OrderDashboardDTO
amountGrowthPercent		number
disputeGrowthPercent		number
orderCountGrowthPercent		number
todayAmount	今日成交金额统计	number
todayNewDisputeCount		integer(int32)
todayOrderCount		integer(int32)
todayUnhandledRefundCount		integer(int32)
unhandledRefundGrowthPercent		number
yesterdayAmount		number
yesterdayNewDisputeCount		integer(int32)
yesterdayOrderCount		integer(int32)
yesterdayUnhandledRefundCount		integer(int32)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "amountGrowthPercent": 0,
        "disputeGrowthPercent": 0,
        "orderCountGrowthPercent": 0,
        "todayAmount": 0,
        "todayNewDisputeCount": 0,
        "todayOrderCount": 0,
        "todayUnhandledRefundCount": 0,
        "unhandledRefundGrowthPercent": 0,
        "yesterdayAmount": 0,
        "yesterdayNewDisputeCount": 0,
        "yesterdayOrderCount": 0,
        "yesterdayUnhandledRefundCount": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-快卖物流轨迹（已签收的）

接口地址:/goods/quickly_goods_orders_logistics

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
goodsOrderNum	商品订单号	query	true	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

DB-快卖订单纠纷统计

接口地址:/goods/quickly_goods_orders_new_dispute

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	接口返回对象«OrderDashboardDTO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	OrderDashboardDTO	OrderDashboardDTO
amountGrowthPercent		number
disputeGrowthPercent		number
orderCountGrowthPercent		number
todayAmount	今日成交金额统计	number
todayNewDisputeCount		integer(int32)
todayOrderCount		integer(int32)
todayUnhandledRefundCount		integer(int32)
unhandledRefundGrowthPercent		number
yesterdayAmount		number
yesterdayNewDisputeCount		integer(int32)
yesterdayOrderCount		integer(int32)
yesterdayUnhandledRefundCount		integer(int32)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "amountGrowthPercent": 0,
        "disputeGrowthPercent": 0,
        "orderCountGrowthPercent": 0,
        "todayAmount": 0,
        "todayNewDisputeCount": 0,
        "todayOrderCount": 0,
        "todayUnhandledRefundCount": 0,
        "unhandledRefundGrowthPercent": 0,
        "yesterdayAmount": 0,
        "yesterdayNewDisputeCount": 0,
        "yesterdayOrderCount": 0,
        "yesterdayUnhandledRefundCount": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-快卖未处理退款统计

接口地址:/goods/quickly_goods_orders_refund

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	接口返回对象«OrderDashboardDTO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	OrderDashboardDTO	OrderDashboardDTO
amountGrowthPercent		number
disputeGrowthPercent		number
orderCountGrowthPercent		number
todayAmount	今日成交金额统计	number
todayNewDisputeCount		integer(int32)
todayOrderCount		integer(int32)
todayUnhandledRefundCount		integer(int32)
unhandledRefundGrowthPercent		number
yesterdayAmount		number
yesterdayNewDisputeCount		integer(int32)
yesterdayOrderCount		integer(int32)
yesterdayUnhandledRefundCount		integer(int32)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "amountGrowthPercent": 0,
        "disputeGrowthPercent": 0,
        "orderCountGrowthPercent": 0,
        "todayAmount": 0,
        "todayNewDisputeCount": 0,
        "todayOrderCount": 0,
        "todayUnhandledRefundCount": 0,
        "unhandledRefundGrowthPercent": 0,
        "yesterdayAmount": 0,
        "yesterdayNewDisputeCount": 0,
        "yesterdayOrderCount": 0,
        "yesterdayUnhandledRefundCount": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-快卖商品主动退款（商家）

接口地址:/goods/quickly_merchant_refund

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

错误码说明
200: 成功
3305: 订单不存在
3306: 该订单不能退款
3307: 退款金额超出订单总额
3308: 未发货必须全额退款
3309: 该状态下无法退款

请求示例:

{
  "agreeReason": "商品质量问题",
  "orderNum": "",
  "refundMoney": "",
  "sellerId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
quicklyMerchantRefundParam	快卖商品商家主动退款参数	body	true	QuicklyMerchantRefundParam	QuicklyMerchantRefundParam
agreeReason	退款原因,注：无理由，传空字符串		true	string
orderNum	订单号）		true	string
refundMoney	退款金额）		true	string
sellerId	卖家ID）		true	integer(int32)

响应状态:

状态码	说明	schema
200	退款成功
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
3305	订单不存在
3306	该订单不能退款
3307	退款金额超出订单总额
3308	未发货必须全额退款
3309	该状态下无法退款

响应参数:

暂无

响应示例:

DB-快卖商品物流修改（商家）

接口地址:/goods/quickly_modify_logistics

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

前端设置12小时内仅修改

请求示例:

{
  "expressCode": "",
  "expressName": "",
  "expressNum": "",
  "orderNum": "",
  "sellerId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
quicklyModifyLogisticsParam	快卖商品物流信息修改参数	body	true	QuicklyModifyLogisticsParam	QuicklyModifyLogisticsParam
expressCode	物流公司代号）		true	string
expressName	物流名称）		true	string
expressNum	物流号）		true	string
orderNum	订单号）		true	string
sellerId	卖家ID）		true	integer(int32)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

ML-好友管理

获取好友列表

接口地址:/friendship/get_friends_list

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "keyWord": "",
    "startTimestamp": 0,
    "userId": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ModuleParam	好友列表参数	body	true	UserFriendListParam	UserFriendListParam
criteriaMap	赛选条件参数		false	criteriaMap_4	criteriaMap_4
endTimestamp	结束时间错（毫秒）		false	integer
keyWord	搜索关键词（仅昵称）		false	string
startTimestamp	结束时间戳（毫秒）		false	integer
userId	用户ID		true	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«PageData«UserFriendList»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	PageData«UserFriendList»	PageData«UserFriendList»
dataList	好友列表	array	UserFriendList
createdAt		Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
description	描述	string
displayName	备注名	string
friendId		integer
friendName	好友昵称	string
friendPortraitUri	好友头像	string
id		integer
imageUri	图片	string
imageUris	图片	string
message	申请说明	string
phone	手机号	string
phones	手机号	string
ratio	付费群奖励比例	integer
region		string
star	是否星标 Y是 N不是	string
status	10申请11过时20好友21忽略30删除31拉黑	integer
tagId	标签ID 自friendships_tag	integer
timestamp	操作时间	integer
updatedAt		Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
userId		integer
viewFriendTime	我查看好友朋友圈时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "dataList": [
            {
                "createdAt": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "description": "",
                "displayName": "",
                "friendId": 0,
                "friendName": "",
                "friendPortraitUri": "",
                "id": 0,
                "imageUri": "",
                "imageUris": "",
                "message": "",
                "phone": "",
                "phones": "",
                "ratio": 0,
                "region": "",
                "star": "",
                "status": 0,
                "tagId": 0,
                "timestamp": 0,
                "updatedAt": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "userId": 0,
                "viewFriendTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                }
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

ML-导出管理

筛选导出数据 (能量商品)

接口地址:/export/energy_goods

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "energyGoodsEditParams": [
      {
        "content": "",
        "energy": 0,
        "expressPrice": 0,
        "expressTemplate": 0,
        "expressType": 0,
        "goodType": 0,
        "goodsId": 0,
        "id": 0,
        "image": "",
        "isLimitBuy": 0,
        "limitNum": 0,
        "name": "",
        "odds": 0,
        "price": 0,
        "status": 0,
        "stock": 0,
        "type": 0
      }
    ],
    "energyGoodsQueryParams": {
      "endTimestamp": 0,
      "id": 0,
      "keyWord": "",
      "pageCount": 0,
      "pageSize": 0,
      "screenType": 0,
      "sort": [],
      "startTimestamp": 0
    }
  },
  "goodsIlk": 0,
  "operateType": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
goodsOperateParam	商品操作参数对象	body	true	GoodsOperateParam	GoodsOperateParam
criteriaMap	赛选条件参数		true	criteriaMap	criteriaMap
energyGoodsEditParams	能量商品编辑/添加参数		false	array	EnergyGoodsEditParam
content	商品描述【注：仅编辑选传/添加必传】		false	string
energy	需要能量【注：仅编辑选传/添加必传】		false	number
expressPrice	运费(固定费用时为费用值，其他时为：0） ——默认值：0【注：仅编辑/（添加时，选传——未传默认值）】		false	number
expressTemplate	邮费模板Id——【注：仅编辑选传/非手动创建时添加必传，无手动创建添加时必传）】		false	integer
expressType	商品运费模板（0：固定费用 1：按距离计费 2：无需邮寄 3：包邮）——默认值：3【注：仅编辑选传/添加必传——未传默认值）】		false	integer
goodType	商品类型（0：实物 1：虚拟）——默认值：0【注：仅编辑/添加时，选传——未传默认值）】		false	integer
goodsId	映射的商品ID，如：选择的快卖商品ID【注：仅添加时，必传】		false	integer
id	商品ID【注：仅编辑/删除时，必传】		false	integer
image	商品图片URL，多张','分割【注：仅编辑选传/添加必传】		false	string
isLimitBuy	是否限购（0：不限购 1：限购）———默认值：0【注：仅编辑选传/添加时，选传】		false	integer
limitNum	限购数量【注：仅编辑选传/添加时，选传】		false	integer
name	商品名【注：编辑选传/添加必传】		false	string
odds	中奖权重，type=1时设置 ——默认值：0【注：仅编辑/添加时，选传——未传默认值）】		false	integer
price	价格【注：仅编辑选传/添加必传】		false	number
status	上架状态（0：下架、1：正常）——默认值：1【注：仅编辑/添加时，选传——未传默认值）】		false	integer
stock	库存【注：仅编辑选传/添加必传】		false	integer
type	商品类型（0：积分商城 1：抽奖商品）——默认值：0【注：仅编辑/添加时，选传——未传默认值）】		false	integer
energyGoodsQueryParams	能量商品查询参数		false	EnergyGoodsQueryParam	EnergyGoodsQueryParam
endTimestamp	结束时间错（毫秒）——默认值：0【注：仅查询时，选传——未传默认值）】		false	integer
id	商品ID——默认值：0【注：仅查询详情时必传传——未传默认值）】		false	integer
keyWord	搜索关键词（商品名）——默认值：0【注：仅查询时，选传——未传默认值）】		false	string
pageCount	当前页数【默认：0 即：第1页】【注：仅查询传，可选传，未传则默认值】		false	integer
pageSize	页大小【默认：10条】【注：仅查询传，可选传，未传则默认值】		false	integer
screenType	筛选类型（0、全部，1：产品ID，2：产品昵称）——默认值：0【注：仅查询时，选传——未传默认值）】		false	integer
sort	按XXX排序（1：昵称 2：能量值 3：库存 4：价格 5：上下架状态 6：限制条件）,——默认值: 降序,且不按指定字段排序【注：仅查询时，选传——未传默认值）】		false	array	integer
startTimestamp	开始时间戳（毫秒）——默认值：0【注：仅查询时，选传——未传默认值）】		false	integer
goodsIlk	商品类型（0：积分商城 1：抽奖商品 2:快卖商品）——默认值：0		true	integer(int32)
operateType	操作类型（0：无效操作，1：添加商品，2：删除商品 3：修改商品 4：查询商品）—— 默认值：0		false	integer(int32)
isExportImg	是否将url导出图片（开启后会很慢）(0:否 1：是)	query	false	string
screenFiled	导出时传,导出的字段名(未传全部	query	false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

筛选导出字段 (能量商品)

接口地址:/export/energy_goods_fields

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

筛选导出数据 (能量订单)

接口地址:/export/energy_order

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "goodsOrderNum": "",
    "goodsOrderType": 0,
    "keyWord": "",
    "keyWordType": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
goodsOrderParam	商品订单	body	true	GoodsOrderParam	GoodsOrderParam
criteriaMap	赛选条件参数		true	criteriaMap_1	criteriaMap_1
endTimestamp	结束时间错（毫秒）		false	integer
goodsOrderNum	商品订单号【查询详情时查看】		false	string
goodsOrderType	订单类型（1：快卖商品订单 2：能量商品订单）		true	integer
keyWord	搜索关键词（仅兑换人昵称）		false	string
keyWordType	筛选类型（状态 0待确认(填写收货地址) 1待发货 2已发货 3已收货4买家退款申请 5: 买家主动退款 6卖家同意退款 7卖家主动退款 8 买家撤销退款申请 9卖家拒绝退款 10订单取消）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)
isExportImg	是否将url导出图片（开启后会很慢）(0:否 1：是)	query	false	string
screenFiled	导出时传,导出的字段名(未传全部	query	false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

筛选导出字段 (能量订单)

接口地址:/export/energy_order_fields

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

筛选导出数据 (群员信息)

接口地址:/export/group_user_info

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "groupId": 0,
    "keyWord": "",
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
queryGroupMembersParam	查询群员信息参数	body	true	QueryGroupMembersParam	QueryGroupMembersParam
criteriaMap	赛选条件参数		true	criteriaMap_2	criteriaMap_2
endTimestamp	结束时间错（毫秒）		false	integer
groupId	群Id		true	integer
keyWord	搜索关键词【昵称】		false	string
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

筛选导出数据 (快卖商品)

接口地址:/export/quickly_goods

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "goodsType": 0,
    "keyWord": "",
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
goodsParam	商品参数	body	true	GoodsParam	GoodsParam
criteriaMap	赛选条件参数		true	CriteriaMap	CriteriaMap
endTimestamp	结束时间错（毫秒）		false	integer
goodsType	订单类型（1：快卖商品 2：能量商品）		true	integer
keyWord	搜索关键词（商品昵称）		false	string
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)
isExportImg	是否将url导出图片（开启后会很慢）(0:否 1：是)	query	false	string
screenFiled	导出时传,导出的字段名(未传全部	query	false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

筛选导出字段 (快卖商品)

接口地址:/export/quickly_goods_fields

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

筛选导出数据 (快卖订单)

接口地址:/export/quickly_order

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "goodsOrderNum": "",
    "goodsOrderType": 0,
    "keyWord": "",
    "keyWordType": 0,
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
goodsOrderParam	商品订单	body	true	GoodsOrderParam	GoodsOrderParam
criteriaMap	赛选条件参数		true	criteriaMap_1	criteriaMap_1
endTimestamp	结束时间错（毫秒）		false	integer
goodsOrderNum	商品订单号【查询详情时查看】		false	string
goodsOrderType	订单类型（1：快卖商品订单 2：能量商品订单）		true	integer
keyWord	搜索关键词（仅兑换人昵称）		false	string
keyWordType	筛选类型（状态 0待确认(填写收货地址) 1待发货 2已发货 3已收货4买家退款申请 5: 买家主动退款 6卖家同意退款 7卖家主动退款 8 买家撤销退款申请 9卖家拒绝退款 10订单取消）		false	integer
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)
isExportImg	是否将url导出图片（开启后会很慢）(0:否 1：是)	query	false	string
screenFiled	导出时传,导出的字段名(未传全部	query	false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

筛选导出字段 (快卖订单)

接口地址:/export/quickly_order_fields

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

筛选导出字段 (用户信息)

接口地址:/export/user_fields

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

筛选导出数据 (用户信息)

接口地址:/export/user_info

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "isBan": 0,
    "isMember": 0,
    "keyWord": "",
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
queryUserInfoParam	查询用户对象参数	body	true	QueryUserInfoParam	QueryUserInfoParam
criteriaMap	赛选条件参数		false	criteriaMap_3	criteriaMap_3
endTimestamp	结束时间错（毫秒）		false	integer
isBan	是否禁用（-1：全部 1:禁用 0：未禁用）		false	integer
isMember	是否会员（-1：全部 0:未开通会员 1：已开通会员）		false	integer
keyWord	用户id/用户昵称/手机号/真实姓名		false	string
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)
isExportImg	是否将url导出图片（开启后会很慢）(0:否 1：是)	query	false	string
screenFiled	导出时传,导出的字段名(未传全部	query	false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

ML-文件管理

上传图片

接口地址:/file/upload_image

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
file	文件	formData	true	file

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

ML-用户管理

绑定设备信息

接口地址:/user/bind_device

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "isBind": 0,
    "userId": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
bindDeviceParam	绑定设备参数	body	true	BindDeviceParam	BindDeviceParam
criteriaMap	赛选条件参数		false	criteriaMap_16	criteriaMap_16
isBind	是否解绑（0：否 1：是）		false	integer
userId	用户ID		true	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

取消实名认证

接口地址:/user/cancel_real_name

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userId	userId	query	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

企业实名认证

接口地址:/user/enterprise_real_name

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "idNumber": "",
  "nickName": "",
  "realName": "",
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
param	官方实名认证参数	body	true	OfficialRealNameParam	OfficialRealNameParam
idNumber	企业社会信用编码		true	string
nickName	昵称		true	string
realName	官方认证所属企业名		true	string
userId	要实名认证的用户id		true	integer(int32)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

DB-活跃用户数统计

接口地址:/user/get_active_volume_stats

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	接口返回对象«DeviceDataStatistics»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	DeviceDataStatistics	DeviceDataStatistics
deviceTotal	当天活跃用户总数量	integer(int64)
offlineDeviceCount	当天离线设备数量	integer(int64)
onlineDeviceCount	当天活跃用户在线设备数量	integer(int64)
todayDeviceData	统计数据	array	StatisticsData
count	数量	integer
date	年-月-日	string
day	日	integer
hourGroup	小时分组	integer
money	金额	number
month	月	integer
monthName	月名	string
timeRange	时间范围	string
weekdayName	周名	string
weekdayNum	周索引	integer
year	年	integer
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "deviceTotal": 0,
        "offlineDeviceCount": 0,
        "onlineDeviceCount": 0,
        "todayDeviceData": [
            {
                "count": 0,
                "date": "",
                "day": 0,
                "hourGroup": 0,
                "money": 0,
                "month": 0,
                "monthName": "",
                "timeRange": "",
                "weekdayName": "",
                "weekdayNum": 0,
                "year": 0
            }
        ]
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-收货地址列表（含默认）

接口地址:/user/get_address_list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userId	userId	query	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

DB-绑定的设备信息

接口地址:/user/get_bind_device_info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
driverId	绑定的设备id	query	true	string
userId	用户ID	query	true	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«LoginDevice对象»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	LoginDevice对象	LoginDevice对象
appVersion		string
carrier		string
createdAt		Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
device	设备名	string
deviceId	设备id	string
deviceName	品牌	string
id		integer(int32)
ipAddress	ip地址	string
isLogin	是否登录（0：登录，非0：未登录）	integer(int32)
manufacturer		string
os		string
osVersion		string
updateAt	最新登录时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
userAgent	app名	string
userId		integer(int32)
userName	用户名	string
userPortraitUri	用户头像	string
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "appVersion": "",
        "carrier": "",
        "createdAt": {
            "date": 0,
            "day": 0,
            "hours": 0,
            "minutes": 0,
            "month": 0,
            "nanos": 0,
            "seconds": 0,
            "time": 0,
            "timezoneOffset": 0,
            "year": 0
        },
        "device": "",
        "deviceId": "",
        "deviceName": "",
        "id": 0,
        "ipAddress": "",
        "isLogin": 0,
        "manufacturer": "",
        "os": "",
        "osVersion": "",
        "updateAt": {
            "date": 0,
            "day": 0,
            "hours": 0,
            "minutes": 0,
            "month": 0,
            "nanos": 0,
            "seconds": 0,
            "time": 0,
            "timezoneOffset": 0,
            "year": 0
        },
        "userAgent": "",
        "userId": 0,
        "userName": "",
        "userPortraitUri": ""
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-用户黑名单统计

接口地址:/user/get_blacks_volume_stats

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	接口返回对象«BlackListStatsDTO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	BlackListStatsDTO	BlackListStatsDTO
dayGrowthRate	增长率（百分比）	number
todayAdded	今日新增	integer(int64)
todayVsYesterday	今日比昨日新增数	integer(int64)
totalCount	总黑名单数量	integer(int64)
yesterdayAdded	昨日新增	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "dayGrowthRate": 0,
        "todayAdded": 0,
        "todayVsYesterday": 0,
        "totalCount": 0,
        "yesterdayAdded": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

查询历史消息(DB-回话消息记录)

接口地址:/user/get_chat_contents

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "channelType": "",
    "endTimestamp": 0,
    "fromUserId": "",
    "keyWord": "",
    "msgType": "",
    "startTimestamp": 0,
    "toUserId": "",
    "userId": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
queryChatContentsParam	查询用户历史消息参数	body	true	QueryChatContentsParam	QueryChatContentsParam
criteriaMap	赛选条件参数		true	criteriaMap_12	criteriaMap_12
channelType	聊天类型：PERSON（二人会话）、PERSONS（讨论组会话）、GROUP（群组会话）、TEMPGROUP（聊天室会话）、CUSTOMERSERVICE（客服会话）、NOTIFY（系统通知）、MC（应用公众服务）、MP（公众服务）、 ULTRAGROUP（超级群服务）		false	string
endTimestamp	结束时间错（毫秒）		false	integer
fromUserId	发送者Id		true	string
keyWord	聊天内容		false	string
msgType	消息类型：文本消息 RC:TxtMsg、图片消息 RC:ImgMsg、红包消息 RCD:RedMsg		false	string
startTimestamp	结束时间戳（毫秒）		false	integer
toUserId	接收者Id【精准定位查询时要】		false	string
userId	用户ID【注：新设计图需要，DB-接口】		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«ChatContentList»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	ChatContentList	ChatContentList
chatMessagesList	聊天消息	array	ChatMessages
busChannel	会话频道 ID，使用超级群频道功能时，可通过 buschannel 获取频道 ID，未使用时该内容为空。	string
channelType	会话类型。PERSON（二人会话）、PERSONS（讨论组会话）、GROUP（群组会话）、TEMPGROUP（聊天室会话）、CUSTOMERSERVICE（客服会话）、NOTIFY（系统通知）、MC（应用公众服务）、MP（公众服务）、 ULTRAGROUP（超级群服务）。	string
content	发送的消息内容。	string
friendImage	群头像	string
friendName	群昵称	string
fromUserId	发送用户 ID。	integer
fromUserImage	【消息-发送者】系统头像 -- 单聊	string
fromUserName	【消息-发送者】昵称 -- 单聊	string
fromUserRealName	【消息-发送者】系统真实姓名 -- 单聊	string
groupImage	好友头像	string
groupName	好友昵称	string
groupUserIds	接收群定向消息的群组成员用户 ID 数组。仅群组会话（channelType 为 GROUP）支持群定向消息，如果指定的用户不在群组中，该字段为空。非群定向消息时，该字段为空。	string
id		integer
msgTimestamp	服务端收到客户端发送消息时的服务器时间	integer
msgUid	可通过 msgUID 确定消息唯一。	string
objectName	消息类型，例如文本消息 RC:TxtMsg、图片消息 RC:ImgMsg、红包消息 RCD:RedMsg	string
originalMsgUid	原始消息 ID，仅针对超级群会话有效。在修改消息、扩展消息、删除消息时，此字段携带有效值。可通过此字段查询原始消息内容。修改超级群消息后，如果需要在服务端撤回消息，必须使用该 ID。	string
sensitiveType	消息中是否含有敏感信息。0 为不包含，1 为含有屏蔽敏感词，2 为含有替换敏感词。	integer
source	标识消息的发送源头，包括：iOS、Android、Websocket、MiniProgram（小程序）、PC、Server（通过 Server API 发送，需要开通 Server API 发送消息进行消息路由功能）。	string
status	关系状态：【是否退群 0正常 1退群/好友关系 10 申请11过时20好友21忽略30删除31拉黑】	integer
toUserId	目标 ID	integer
toUserImage	【消息-接收者】系统昵称	string
toUserName	【消息-接收者】系统昵称	string
toUserRealName	【消息-接收者】系统真实姓名	string
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "chatMessagesList": [
            {
                "busChannel": "",
                "channelType": "",
                "content": "",
                "friendImage": "",
                "friendName": "",
                "fromUserId": 0,
                "fromUserImage": "",
                "fromUserName": "",
                "fromUserRealName": "",
                "groupImage": "",
                "groupName": "",
                "groupUserIds": "",
                "id": 0,
                "msgTimestamp": 0,
                "msgUid": "",
                "objectName": "",
                "originalMsgUid": "",
                "sensitiveType": 0,
                "source": "",
                "status": 0,
                "toUserId": 0,
                "toUserImage": "",
                "toUserName": "",
                "toUserRealName": ""
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

设备信息

接口地址:/user/get_devices

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "keyWord": "",
    "startTimestamp": 0,
    "userId": ""
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
queryLoginDeviceParam	查询登录设备参数	body	true	QueryLoginDeviceParam	QueryLoginDeviceParam
criteriaMap	赛选条件参数		false	criteriaMap_13	criteriaMap_13
endTimestamp	结束时间错（毫秒）		false	integer
keyWord	搜索关键词（门铃号/用户昵称）		false	string
startTimestamp	结束时间戳（毫秒）		false	integer
userId	用户id名		false	string
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«PageData«LoginDevice对象»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	PageData«LoginDevice对象»	PageData«LoginDevice对象»
dataList	登录设备表	array	LoginDevice对象
appVersion		string
carrier		string
createdAt		Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
device	设备名	string
deviceId	设备id	string
deviceName	品牌	string
id		integer
ipAddress	ip地址	string
isLogin	是否登录（0：登录，非0：未登录）	integer
manufacturer		string
os		string
osVersion		string
updateAt	最新登录时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
userAgent	app名	string
userId		integer
userName	用户名	string
userPortraitUri	用户头像	string
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "dataList": [
            {
                "appVersion": "",
                "carrier": "",
                "createdAt": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "device": "",
                "deviceId": "",
                "deviceName": "",
                "id": 0,
                "ipAddress": "",
                "isLogin": 0,
                "manufacturer": "",
                "os": "",
                "osVersion": "",
                "updateAt": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "userAgent": "",
                "userId": 0,
                "userName": "",
                "userPortraitUri": ""
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-能量日志

接口地址:/user/get_energy_logs

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userId	用户ID	query	true	string
pageCount	页码,默认：1	query	false	string
pageSize	页大小,默认：10	query	false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«PageData«UserEnergyLog对象»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	PageData«UserEnergyLog对象»	PageData«UserEnergyLog对象»
dataList	能量日志	array	UserEnergyLog对象
createTime	操作时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
energyType	奖励分类，关联energy_rule表	integer
id		integer
money	金额	number
operation	操作 1加 2减	integer
orderNum	订单号	string
remark	备注	string
serviceFee	服务费	number
snapshot	快照	number
title	标题	string
typeId	分类ID	integer
userId	用户ID	integer
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "dataList": [
            {
                "createTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "energyType": 0,
                "id": 0,
                "money": 0,
                "operation": 0,
                "orderNum": "",
                "remark": "",
                "serviceFee": 0,
                "snapshot": 0,
                "title": "",
                "typeId": 0,
                "userId": 0
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-群聊回话列表

接口地址:/user/get_group_chat_list

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "channelType": "",
    "endTimestamp": 0,
    "fromUserId": "",
    "keyWord": "",
    "msgType": "",
    "startTimestamp": 0,
    "toUserId": "",
    "userId": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
queryChatContentsParam	查询用户历史消息参数	body	true	QueryChatContentsParam	QueryChatContentsParam
criteriaMap	赛选条件参数		true	criteriaMap_12	criteriaMap_12
channelType	聊天类型：PERSON（二人会话）、PERSONS（讨论组会话）、GROUP（群组会话）、TEMPGROUP（聊天室会话）、CUSTOMERSERVICE（客服会话）、NOTIFY（系统通知）、MC（应用公众服务）、MP（公众服务）、 ULTRAGROUP（超级群服务）		false	string
endTimestamp	结束时间错（毫秒）		false	integer
fromUserId	发送者Id		true	string
keyWord	聊天内容		false	string
msgType	消息类型：文本消息 RC:TxtMsg、图片消息 RC:ImgMsg、红包消息 RCD:RedMsg		false	string
startTimestamp	结束时间戳（毫秒）		false	integer
toUserId	接收者Id【精准定位查询时要】		false	string
userId	用户ID【注：新设计图需要，DB-接口】		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«ChatContentList»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	ChatContentList	ChatContentList
chatMessagesList	聊天消息	array	ChatMessages
busChannel	会话频道 ID，使用超级群频道功能时，可通过 buschannel 获取频道 ID，未使用时该内容为空。	string
channelType	会话类型。PERSON（二人会话）、PERSONS（讨论组会话）、GROUP（群组会话）、TEMPGROUP（聊天室会话）、CUSTOMERSERVICE（客服会话）、NOTIFY（系统通知）、MC（应用公众服务）、MP（公众服务）、 ULTRAGROUP（超级群服务）。	string
content	发送的消息内容。	string
friendImage	群头像	string
friendName	群昵称	string
fromUserId	发送用户 ID。	integer
fromUserImage	【消息-发送者】系统头像 -- 单聊	string
fromUserName	【消息-发送者】昵称 -- 单聊	string
fromUserRealName	【消息-发送者】系统真实姓名 -- 单聊	string
groupImage	好友头像	string
groupName	好友昵称	string
groupUserIds	接收群定向消息的群组成员用户 ID 数组。仅群组会话（channelType 为 GROUP）支持群定向消息，如果指定的用户不在群组中，该字段为空。非群定向消息时，该字段为空。	string
id		integer
msgTimestamp	服务端收到客户端发送消息时的服务器时间	integer
msgUid	可通过 msgUID 确定消息唯一。	string
objectName	消息类型，例如文本消息 RC:TxtMsg、图片消息 RC:ImgMsg、红包消息 RCD:RedMsg	string
originalMsgUid	原始消息 ID，仅针对超级群会话有效。在修改消息、扩展消息、删除消息时，此字段携带有效值。可通过此字段查询原始消息内容。修改超级群消息后，如果需要在服务端撤回消息，必须使用该 ID。	string
sensitiveType	消息中是否含有敏感信息。0 为不包含，1 为含有屏蔽敏感词，2 为含有替换敏感词。	integer
source	标识消息的发送源头，包括：iOS、Android、Websocket、MiniProgram（小程序）、PC、Server（通过 Server API 发送，需要开通 Server API 发送消息进行消息路由功能）。	string
status	关系状态：【是否退群 0正常 1退群/好友关系 10 申请11过时20好友21忽略30删除31拉黑】	integer
toUserId	目标 ID	integer
toUserImage	【消息-接收者】系统昵称	string
toUserName	【消息-接收者】系统昵称	string
toUserRealName	【消息-接收者】系统真实姓名	string
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "chatMessagesList": [
            {
                "busChannel": "",
                "channelType": "",
                "content": "",
                "friendImage": "",
                "friendName": "",
                "fromUserId": 0,
                "fromUserImage": "",
                "fromUserName": "",
                "fromUserRealName": "",
                "groupImage": "",
                "groupName": "",
                "groupUserIds": "",
                "id": 0,
                "msgTimestamp": 0,
                "msgUid": "",
                "objectName": "",
                "originalMsgUid": "",
                "sensitiveType": 0,
                "source": "",
                "status": 0,
                "toUserId": 0,
                "toUserImage": "",
                "toUserName": "",
                "toUserRealName": ""
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

获取群员列表

接口地址:/user/get_group_members

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "groupId": 0,
    "keyWord": "",
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
queryGroupMembersParam	查询群员信息参数	body	true	QueryGroupMembersParam	QueryGroupMembersParam
criteriaMap	赛选条件参数		true	criteriaMap_2	criteriaMap_2
endTimestamp	结束时间错（毫秒）		false	integer
groupId	群Id		true	integer
keyWord	搜索关键词【昵称】		false	string
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«GroupMembersList»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	GroupMembersList	GroupMembersList
groupMembersList	群员信息	array	GroupMembersVO
alipay		string
createdAt		Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
displayName		string
gender	性别	string
groupId		integer
groupName	群昵称	string
groupNickname		string
id		integer
isDeleted		boolean
memberDesc		string
memberId	门铃号	integer
mute	是否禁言 0正常 1 禁言	boolean
phone		string
region		string
role	角色 0：群主 1：群成员 2：群管理员	integer
timestamp		integer
updatedAt		Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
userName	昵称[群>真实>昵称]	string
userNickname	昵称	string
userPhone	手机号	string
userPortraitUri	头像	string
userRealName	真实姓名	string
weChat		string
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "groupMembersList": [
            {
                "alipay": "",
                "createdAt": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "displayName": "",
                "gender": "",
                "groupId": 0,
                "groupName": "",
                "groupNickname": "",
                "id": 0,
                "isDeleted": true,
                "memberDesc": "",
                "memberId": 0,
                "mute": true,
                "phone": "",
                "region": "",
                "role": 0,
                "timestamp": 0,
                "updatedAt": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "userName": "",
                "userNickname": "",
                "userPhone": "",
                "userPortraitUri": "",
                "userRealName": "",
                "weChat": ""
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-登录设备列表

接口地址:/user/get_login_device_list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userId	用户ID	query	true	string
pageCount	页码,默认：1	query	false	string
pageSize	页大小,默认：10	query	false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«PageData«LoginDevice对象»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	PageData«LoginDevice对象»	PageData«LoginDevice对象»
dataList	登录设备表	array	LoginDevice对象
appVersion		string
carrier		string
createdAt		Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
device	设备名	string
deviceId	设备id	string
deviceName	品牌	string
id		integer
ipAddress	ip地址	string
isLogin	是否登录（0：登录，非0：未登录）	integer
manufacturer		string
os		string
osVersion		string
updateAt	最新登录时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
userAgent	app名	string
userId		integer
userName	用户名	string
userPortraitUri	用户头像	string
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "dataList": [
            {
                "appVersion": "",
                "carrier": "",
                "createdAt": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "device": "",
                "deviceId": "",
                "deviceName": "",
                "id": 0,
                "ipAddress": "",
                "isLogin": 0,
                "manufacturer": "",
                "os": "",
                "osVersion": "",
                "updateAt": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "userAgent": "",
                "userId": 0,
                "userName": "",
                "userPortraitUri": ""
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

登录设备信息

接口地址:/user/get_login_devices

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "keyWord": "",
    "startTimestamp": 0,
    "userId": ""
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
queryLoginDeviceParam	查询登录设备参数	body	true	QueryLoginDeviceParam	QueryLoginDeviceParam
criteriaMap	赛选条件参数		false	criteriaMap_13	criteriaMap_13
endTimestamp	结束时间错（毫秒）		false	integer
keyWord	搜索关键词（门铃号/用户昵称）		false	string
startTimestamp	结束时间戳（毫秒）		false	integer
userId	用户id名		false	string
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«LoginDeviceList»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	LoginDeviceList	LoginDeviceList
loginDevices	登录设备表	array	LoginDevice对象
appVersion		string
carrier		string
createdAt		Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
device	设备名	string
deviceId	设备id	string
deviceName	品牌	string
id		integer
ipAddress	ip地址	string
isLogin	是否登录（0：登录，非0：未登录）	integer
manufacturer		string
os		string
osVersion		string
updateAt	最新登录时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
userAgent	app名	string
userId		integer
userName	用户名	string
userPortraitUri	用户头像	string
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "loginDevices": [
            {
                "appVersion": "",
                "carrier": "",
                "createdAt": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "device": "",
                "deviceId": "",
                "deviceName": "",
                "id": 0,
                "ipAddress": "",
                "isLogin": 0,
                "manufacturer": "",
                "os": "",
                "osVersion": "",
                "updateAt": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "userAgent": "",
                "userId": 0,
                "userName": "",
                "userPortraitUri": ""
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-登录日志

接口地址:/user/get_login_logs

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userId	用户ID	query	true	string
pageCount	页码,默认：1	query	false	string
pageSize	页大小,默认：10	query	false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«PageData«LoginLogs对象»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	PageData«LoginLogs对象»	PageData«LoginLogs对象»
dataList	登录日志	array	LoginLogs对象
address		string
appVersion		string
carrier		string
createdAt		Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
device		string
deviceId		string
deviceName	品牌	string
id		integer
imei	设备识别号码	string
ipAddress		string
manufacturer		string
meid	移动设备识别码	string
os		string
osVersion		string
userAgent		string
userId		integer
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "dataList": [
            {
                "address": "",
                "appVersion": "",
                "carrier": "",
                "createdAt": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "device": "",
                "deviceId": "",
                "deviceName": "",
                "id": 0,
                "imei": "",
                "ipAddress": "",
                "manufacturer": "",
                "meid": "",
                "os": "",
                "osVersion": "",
                "userAgent": "",
                "userId": 0
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

登录日志信息

接口地址:/user/get_login_logs

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "userId": ""
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
queryLoginLogsParam	查询日志登录参数	body	true	QueryLoginLogsParam	QueryLoginLogsParam
criteriaMap	赛选条件参数		false	criteriaMap_14	criteriaMap_14
userId	用户id名		true	string
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«LoginLogList»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	LoginLogList	LoginLogList
loginLogs	登录日志	array	LoginLogs对象
address		string
appVersion		string
carrier		string
createdAt		Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
device		string
deviceId		string
deviceName	品牌	string
id		integer
imei	设备识别号码	string
ipAddress		string
manufacturer		string
meid	移动设备识别码	string
os		string
osVersion		string
userAgent		string
userId		integer
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "loginLogs": [
            {
                "address": "",
                "appVersion": "",
                "carrier": "",
                "createdAt": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "device": "",
                "deviceId": "",
                "deviceName": "",
                "id": 0,
                "imei": "",
                "ipAddress": "",
                "manufacturer": "",
                "meid": "",
                "os": "",
                "osVersion": "",
                "userAgent": "",
                "userId": 0
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-余额日志

接口地址:/user/get_money_logs

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userId	用户ID	query	true	string
pageCount	页码,默认：1	query	false	string
pageSize	页大小,默认：10	query	false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«PageData«UserMoneyLog对象»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	PageData«UserMoneyLog对象»	PageData«UserMoneyLog对象»
dataList	余额日志	array	UserMoneyLog对象
createTime	操作时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
id		integer
money	金额	number
operation	操作 1加 2减	integer
orderNum	订单号	string
remark	备注	string
serviceFee	服务费	number
snapshot	快照	number
title	标题	string
typeId	分类ID，关联operation_type表	integer
typeName	类型名	string
userId	用户ID	integer
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "dataList": [
            {
                "createTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "id": 0,
                "money": 0,
                "operation": 0,
                "orderNum": "",
                "remark": "",
                "serviceFee": 0,
                "snapshot": 0,
                "title": "",
                "typeId": 0,
                "typeName": "",
                "userId": 0
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-系统通知回话列表

接口地址:/user/get_notify_chat_list

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "channelType": "",
    "endTimestamp": 0,
    "fromUserId": "",
    "keyWord": "",
    "msgType": "",
    "startTimestamp": 0,
    "toUserId": "",
    "userId": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
queryChatContentsParam	查询用户历史消息参数	body	true	QueryChatContentsParam	QueryChatContentsParam
criteriaMap	赛选条件参数		true	criteriaMap_12	criteriaMap_12
channelType	聊天类型：PERSON（二人会话）、PERSONS（讨论组会话）、GROUP（群组会话）、TEMPGROUP（聊天室会话）、CUSTOMERSERVICE（客服会话）、NOTIFY（系统通知）、MC（应用公众服务）、MP（公众服务）、 ULTRAGROUP（超级群服务）		false	string
endTimestamp	结束时间错（毫秒）		false	integer
fromUserId	发送者Id		true	string
keyWord	聊天内容		false	string
msgType	消息类型：文本消息 RC:TxtMsg、图片消息 RC:ImgMsg、红包消息 RCD:RedMsg		false	string
startTimestamp	结束时间戳（毫秒）		false	integer
toUserId	接收者Id【精准定位查询时要】		false	string
userId	用户ID【注：新设计图需要，DB-接口】		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«ChatContentList»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	ChatContentList	ChatContentList
chatMessagesList	聊天消息	array	ChatMessages
busChannel	会话频道 ID，使用超级群频道功能时，可通过 buschannel 获取频道 ID，未使用时该内容为空。	string
channelType	会话类型。PERSON（二人会话）、PERSONS（讨论组会话）、GROUP（群组会话）、TEMPGROUP（聊天室会话）、CUSTOMERSERVICE（客服会话）、NOTIFY（系统通知）、MC（应用公众服务）、MP（公众服务）、 ULTRAGROUP（超级群服务）。	string
content	发送的消息内容。	string
friendImage	群头像	string
friendName	群昵称	string
fromUserId	发送用户 ID。	integer
fromUserImage	【消息-发送者】系统头像 -- 单聊	string
fromUserName	【消息-发送者】昵称 -- 单聊	string
fromUserRealName	【消息-发送者】系统真实姓名 -- 单聊	string
groupImage	好友头像	string
groupName	好友昵称	string
groupUserIds	接收群定向消息的群组成员用户 ID 数组。仅群组会话（channelType 为 GROUP）支持群定向消息，如果指定的用户不在群组中，该字段为空。非群定向消息时，该字段为空。	string
id		integer
msgTimestamp	服务端收到客户端发送消息时的服务器时间	integer
msgUid	可通过 msgUID 确定消息唯一。	string
objectName	消息类型，例如文本消息 RC:TxtMsg、图片消息 RC:ImgMsg、红包消息 RCD:RedMsg	string
originalMsgUid	原始消息 ID，仅针对超级群会话有效。在修改消息、扩展消息、删除消息时，此字段携带有效值。可通过此字段查询原始消息内容。修改超级群消息后，如果需要在服务端撤回消息，必须使用该 ID。	string
sensitiveType	消息中是否含有敏感信息。0 为不包含，1 为含有屏蔽敏感词，2 为含有替换敏感词。	integer
source	标识消息的发送源头，包括：iOS、Android、Websocket、MiniProgram（小程序）、PC、Server（通过 Server API 发送，需要开通 Server API 发送消息进行消息路由功能）。	string
status	关系状态：【是否退群 0正常 1退群/好友关系 10 申请11过时20好友21忽略30删除31拉黑】	integer
toUserId	目标 ID	integer
toUserImage	【消息-接收者】系统昵称	string
toUserName	【消息-接收者】系统昵称	string
toUserRealName	【消息-接收者】系统真实姓名	string
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "chatMessagesList": [
            {
                "busChannel": "",
                "channelType": "",
                "content": "",
                "friendImage": "",
                "friendName": "",
                "fromUserId": 0,
                "fromUserImage": "",
                "fromUserName": "",
                "fromUserRealName": "",
                "groupImage": "",
                "groupName": "",
                "groupUserIds": "",
                "id": 0,
                "msgTimestamp": 0,
                "msgUid": "",
                "objectName": "",
                "originalMsgUid": "",
                "sensitiveType": 0,
                "source": "",
                "status": 0,
                "toUserId": 0,
                "toUserImage": "",
                "toUserName": "",
                "toUserRealName": ""
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-单聊回话列表

接口地址:/user/get_person_chat_list

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "channelType": "",
    "endTimestamp": 0,
    "fromUserId": "",
    "keyWord": "",
    "msgType": "",
    "startTimestamp": 0,
    "toUserId": "",
    "userId": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
queryChatContentsParam	查询用户历史消息参数	body	true	QueryChatContentsParam	QueryChatContentsParam
criteriaMap	赛选条件参数		true	criteriaMap_12	criteriaMap_12
channelType	聊天类型：PERSON（二人会话）、PERSONS（讨论组会话）、GROUP（群组会话）、TEMPGROUP（聊天室会话）、CUSTOMERSERVICE（客服会话）、NOTIFY（系统通知）、MC（应用公众服务）、MP（公众服务）、 ULTRAGROUP（超级群服务）		false	string
endTimestamp	结束时间错（毫秒）		false	integer
fromUserId	发送者Id		true	string
keyWord	聊天内容		false	string
msgType	消息类型：文本消息 RC:TxtMsg、图片消息 RC:ImgMsg、红包消息 RCD:RedMsg		false	string
startTimestamp	结束时间戳（毫秒）		false	integer
toUserId	接收者Id【精准定位查询时要】		false	string
userId	用户ID【注：新设计图需要，DB-接口】		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«ChatContentList»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	ChatContentList	ChatContentList
chatMessagesList	聊天消息	array	ChatMessages
busChannel	会话频道 ID，使用超级群频道功能时，可通过 buschannel 获取频道 ID，未使用时该内容为空。	string
channelType	会话类型。PERSON（二人会话）、PERSONS（讨论组会话）、GROUP（群组会话）、TEMPGROUP（聊天室会话）、CUSTOMERSERVICE（客服会话）、NOTIFY（系统通知）、MC（应用公众服务）、MP（公众服务）、 ULTRAGROUP（超级群服务）。	string
content	发送的消息内容。	string
friendImage	群头像	string
friendName	群昵称	string
fromUserId	发送用户 ID。	integer
fromUserImage	【消息-发送者】系统头像 -- 单聊	string
fromUserName	【消息-发送者】昵称 -- 单聊	string
fromUserRealName	【消息-发送者】系统真实姓名 -- 单聊	string
groupImage	好友头像	string
groupName	好友昵称	string
groupUserIds	接收群定向消息的群组成员用户 ID 数组。仅群组会话（channelType 为 GROUP）支持群定向消息，如果指定的用户不在群组中，该字段为空。非群定向消息时，该字段为空。	string
id		integer
msgTimestamp	服务端收到客户端发送消息时的服务器时间	integer
msgUid	可通过 msgUID 确定消息唯一。	string
objectName	消息类型，例如文本消息 RC:TxtMsg、图片消息 RC:ImgMsg、红包消息 RCD:RedMsg	string
originalMsgUid	原始消息 ID，仅针对超级群会话有效。在修改消息、扩展消息、删除消息时，此字段携带有效值。可通过此字段查询原始消息内容。修改超级群消息后，如果需要在服务端撤回消息，必须使用该 ID。	string
sensitiveType	消息中是否含有敏感信息。0 为不包含，1 为含有屏蔽敏感词，2 为含有替换敏感词。	integer
source	标识消息的发送源头，包括：iOS、Android、Websocket、MiniProgram（小程序）、PC、Server（通过 Server API 发送，需要开通 Server API 发送消息进行消息路由功能）。	string
status	关系状态：【是否退群 0正常 1退群/好友关系 10 申请11过时20好友21忽略30删除31拉黑】	integer
toUserId	目标 ID	integer
toUserImage	【消息-接收者】系统昵称	string
toUserName	【消息-接收者】系统昵称	string
toUserRealName	【消息-接收者】系统真实姓名	string
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "chatMessagesList": [
            {
                "busChannel": "",
                "channelType": "",
                "content": "",
                "friendImage": "",
                "friendName": "",
                "fromUserId": 0,
                "fromUserImage": "",
                "fromUserName": "",
                "fromUserRealName": "",
                "groupImage": "",
                "groupName": "",
                "groupUserIds": "",
                "id": 0,
                "msgTimestamp": 0,
                "msgUid": "",
                "objectName": "",
                "originalMsgUid": "",
                "sensitiveType": 0,
                "source": "",
                "status": 0,
                "toUserId": 0,
                "toUserImage": "",
                "toUserName": "",
                "toUserRealName": ""
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-用户会员数统计（当日-所有）)

接口地址:/user/get_registers_volume_stats

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	接口返回对象«UserRegisterStatsDTO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	UserRegisterStatsDTO	UserRegisterStatsDTO
currentMonthCount	本月注册数	integer(int64)
dayGrowthRate	今日增长率（百分比）	number
lastMonthCount	本月注册数	integer(int64)
monthGrowthRate	本月增长率（百分比）	number
todayCount	当天注册用户数	integer(int64)
totalCount	总注册用户数	integer(int64)
yesterdayCount	昨天注册数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "currentMonthCount": 0,
        "dayGrowthRate": 0,
        "lastMonthCount": 0,
        "monthGrowthRate": 0,
        "todayCount": 0,
        "totalCount": 0,
        "yesterdayCount": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-用户详细信息(列表)

接口地址:/user/get_users

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "isBan": 0,
    "isMember": 0,
    "keyWord": "",
    "startTimestamp": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
queryUserInfoParam	查询用户对象参数	body	true	QueryUserInfoParam	QueryUserInfoParam
criteriaMap	赛选条件参数		false	criteriaMap_3	criteriaMap_3
endTimestamp	结束时间错（毫秒）		false	integer
isBan	是否禁用（-1：全部 1:禁用 0：未禁用）		false	integer
isMember	是否会员（-1：全部 0:未开通会员 1：已开通会员）		false	integer
keyWord	用户id/用户昵称/手机号/真实姓名		false	string
startTimestamp	结束时间戳（毫秒）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«UserList»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	UserList	UserList
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
usersList	用户表	array	Users对象
address	地址	string
alipayAccount	支付宝账号	string
alipayNickName	支付宝昵称	string
alipayUserId	支付宝userId	string
appleSubId	苹果subID	string
backendAccount		string
birthday	生日	string
certBeginDate	身份证有效期起始时间）	string
certEndDate	身份证有效期截止时间	string
certType	身份证类型（0:中国居民二代身份证，1:港澳台来往内地通行证，2:外国人永久居留证，3:定居国外的中国公民护照，4:港澳台居民居住证）	integer
certValidityType	身份证有效期类型 （1：长期有效；0：非长期有效）	integer
circleSeeDay		integer
createdAt	注册时间	string
deletedAt	注销时间	string
device	绑订的设备	string
dmkAppleSubId	到门口APP苹果登录ID	string
driverId	绑订的设备唯一标识	string
energy	能量	number
friVerify		integer
friendsCount		integer
gender	性别（male：男，female：女）	string
groupCount		integer
groupVerify		integer
id		integer
idNumber	身份证号码	string
isBan	是否被禁（0：未禁用 1：已禁用）	integer
isEnergyMember	是否开通能量会员（0：未开通 1：已开通）	integer
isForced		integer
isMember	是否会员（0:未开通会员 1：正式会员 2：体验会员）	integer
isOfficialAccount		integer
isRealname	是否实名（ 1：已实名 0：未实名）	integer
lastLoginTime	最近登录时间（时间戳：毫秒）	integer
loginIp	登录IP	string
momentsCover	朋友圈头部图片	string
money	余额	number
nickname	用户昵称	string
openMenling		integer
password		string
passwordHash		string
passwordSalt		string
payPass		string
personalityName	个性签名	string
phone	手机号	string
phoneVerify		integer
pid		integer
pokeStatus		integer
portraitUri	用户头像	string
promotionCode		string
realnameTime	实名认证时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
region		string
rongCloudToken		string
stAccount		string
stSearchVerify		integer
strangerCanSee		string
strangerSeeCount	陌生人可查看朋友圈数量 20	integer
timestamp		integer
total	消费订单数	integer
totalCount	总条数	integer
totalMoney	消费金额	number
unionId	微信unionId	string
updAddressTime	修改地址时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
updBirthTime	修改生日时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
updatedAt		string
urealname		string
userType		string
windChime	风铃	number
wxNickName	微信昵称（用于已绑定的时候显示）	string
wxOpenId	微信openID	string
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0,
        "usersList": [
            {
                "address": "",
                "alipayAccount": "",
                "alipayNickName": "",
                "alipayUserId": "",
                "appleSubId": "",
                "backendAccount": "",
                "birthday": "",
                "certBeginDate": "",
                "certEndDate": "",
                "certType": 0,
                "certValidityType": 0,
                "circleSeeDay": 0,
                "createdAt": "",
                "deletedAt": "",
                "device": "",
                "dmkAppleSubId": "",
                "driverId": "",
                "energy": 0,
                "friVerify": 0,
                "friendsCount": 0,
                "gender": "",
                "groupCount": 0,
                "groupVerify": 0,
                "id": 0,
                "idNumber": "",
                "isBan": 0,
                "isEnergyMember": 0,
                "isForced": 0,
                "isMember": 0,
                "isOfficialAccount": 0,
                "isRealname": 0,
                "lastLoginTime": 0,
                "loginIp": "",
                "momentsCover": "",
                "money": 0,
                "nickname": "",
                "openMenling": 0,
                "password": "",
                "passwordHash": "",
                "passwordSalt": "",
                "payPass": "",
                "personalityName": "",
                "phone": "",
                "phoneVerify": 0,
                "pid": 0,
                "pokeStatus": 0,
                "portraitUri": "",
                "promotionCode": "",
                "realnameTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "region": "",
                "rongCloudToken": "",
                "stAccount": "",
                "stSearchVerify": 0,
                "strangerCanSee": "",
                "strangerSeeCount": 0,
                "timestamp": 0,
                "total": 0,
                "totalCount": 0,
                "totalMoney": 0,
                "unionId": "",
                "updAddressTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "updBirthTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "updatedAt": "",
                "urealname": "",
                "userType": "",
                "windChime": 0,
                "wxNickName": "",
                "wxOpenId": ""
            }
        ]
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-风铃日志

接口地址:/user/get_wind_chime_logs

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userId	用户ID	query	true	string
pageCount	页码,默认：1	query	false	string
pageSize	页大小,默认：10	query	false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«PageData«UserWindChimeLog对象»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	PageData«UserWindChimeLog对象»	PageData«UserWindChimeLog对象»
dataList	风铃日志	array	UserWindChimeLog对象
createTime	操作时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
id		integer
money	金额	number
operation	操作 1加 2减	integer
orderNum	订单号	string
remark	备注	string
serviceFee	服务费	number
snapshot	快照	number
title	标题	string
typeId	分类ID	integer
userId	用户ID	integer
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "dataList": [
            {
                "createTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "id": 0,
                "money": 0,
                "operation": 0,
                "orderNum": "",
                "remark": "",
                "serviceFee": 0,
                "snapshot": 0,
                "title": "",
                "typeId": 0,
                "userId": 0
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

门铃号加密-解密

接口地址:/user/id_encode

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ciphertextId	明文id	query	false	string
plaintextId	密文id	query	false	string

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

登录二维码生成（base64-png）

接口地址:/user/login_2code

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id（登录二维码时：QRCodeId）	query	true	string
type	二维码类型（1、登录二维码）	query	true	string
codeBackGroundColor	二维码背景颜色（十进制）---(默认(黑)：16777215)	query	false	string
codeColor	二维码颜色（十进制）---(默认(白)：000000)	query	false	string
height	二维码高(默认：300)	query	false	string
imgType	二维码图片类型(默认：PNG)	query	false	string
logoPath	二维码logo(默认：助花logo)	query	false	string
width	二维码宽(默认：300)	query	false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

二维码扫描登录确认

接口地址:/user/login_2code_confirm

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
QRCodeId	二维码Id	query	false	string
QRCodeKey	二维码密钥	query	false	string
userId	用户id（明文）	query	false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

二维码扫描登录

接口地址:/user/login_2code_scan

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
QRCodeId	二维码ID	query	false	string
QRCodeKeySecret	密钥	query	false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

人工实名认证

接口地址:/user/manual_real_name

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "addressInfo": "",
  "certBeginDate": "",
  "certEndDate": "",
  "certType": 0,
  "certValidityType": 0,
  "idNumber": "",
  "realName": "",
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
param	人工实名认证参数	body	true	ManualRealNameParam	ManualRealNameParam
addressInfo	身份证上地址		false	string
certBeginDate	身份证有效期（起始）示例值：20110112		true	string
certEndDate	身份证有效期（截止）示例值：20110112/长期		true	string
certType	身份证类型		false	integer(int32)
certValidityType	身份证有效期类型 1：长期有效；0：非长期有效		false	integer(int32)
idNumber	身份证号		true	string
realName	身份认证的名字		true	string
userId	要实名认证的用户id		true	integer(int32)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

官方实名认证

接口地址:/user/official_real_name

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "idNumber": "",
  "nickName": "",
  "realName": "",
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
param	官方实名认证参数	body	true	OfficialRealNameParam	OfficialRealNameParam
idNumber	企业社会信用编码		true	string
nickName	昵称		true	string
realName	官方认证所属企业名		true	string
userId	要实名认证的用户id		true	integer(int32)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

红包-转账记录

接口地址:/user/rp_tr_log

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "id": 0,
    "type": 0,
    "way": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
redPacketAndTransferParam	红包/转账参数	body	true	RedPacketAndTransferParam	RedPacketAndTransferParam
criteriaMap	赛选条件参数		true	criteriaMap_15	criteriaMap_15
id	红包/转账id		true	integer
type	消息类型（10：单聊红包 11：群里红包 20：单聊转账 21：群里转账）		true	integer
way	方式（1：红包 2：转账）		true	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10000条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«RedPacketAndTransferList»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	RedPacketAndTransferList	RedPacketAndTransferList
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
redPacketAndTransfersInfo	红包转账信息	RedPacketAndTransfersInfo	RedPacketAndTransfersInfo
addTime	添加时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
amount	红包和转账的总金额	number
content	内容	string
contentLength	内容长度	integer
contentTxt	内容(显示)	string
contentType	内容类型 （1余额红包 2转账 3接龙 4风铃红包）	integer
count	红包个数，几个包	integer
dateInt	添加日期	string
destId	接收人	integer
id	id	integer
isCallback	是否IM回调的消息	integer
isSend		integer
messageType	消息类型 1私聊 3群聊	integer
msgSeq	消息seq	string
orderNum	订单号,关联余额明细表	string
privateUserId	专属红包接收人userid	integer
receiveName	接收者名	string
selectType	红包类型 unique ,luck，common	string
senderAvatar	发送者头像	string
senderGender	发送者性别	string
senderId	发送人	integer
senderNickname	发送者昵称	string
senderUserId	发送者Id	integer
status	状态 1 可领 2已领完 3已退回	integer
upTime	修改时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
redPacketReceiveInfoList	红包接收者信息	array	RedPacketReceiveInfo
receiveAmount	接收金额	string
receiveAvatar	接收者头像	string
receiveGender	接收者性别	string
receiveIsMax	是否运气王（1：是 0：否）	string
receiveNickname	接收者昵称	string
receiveTime	时间戳（秒）	string
receiveUserId	接收者者Id	integer
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "redPacketAndTransfersInfo": {
            "addTime": {
                "date": 0,
                "day": 0,
                "hours": 0,
                "minutes": 0,
                "month": 0,
                "nanos": 0,
                "seconds": 0,
                "time": 0,
                "timezoneOffset": 0,
                "year": 0
            },
            "amount": 0,
            "content": "",
            "contentLength": 0,
            "contentTxt": "",
            "contentType": 0,
            "count": 0,
            "dateInt": "",
            "destId": 0,
            "id": 0,
            "isCallback": 0,
            "isSend": 0,
            "messageType": 0,
            "msgSeq": "",
            "orderNum": "",
            "privateUserId": 0,
            "receiveName": "",
            "selectType": "",
            "senderAvatar": "",
            "senderGender": "",
            "senderId": 0,
            "senderNickname": "",
            "senderUserId": 0,
            "status": 0,
            "upTime": {
                "date": 0,
                "day": 0,
                "hours": 0,
                "minutes": 0,
                "month": 0,
                "nanos": 0,
                "seconds": 0,
                "time": 0,
                "timezoneOffset": 0,
                "year": 0
            }
        },
        "redPacketReceiveInfoList": [
            {
                "receiveAmount": "",
                "receiveAvatar": "",
                "receiveGender": "",
                "receiveIsMax": "",
                "receiveNickname": "",
                "receiveTime": "",
                "receiveUserId": 0
            }
        ],
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

发送验证码

接口地址:/user/send_sms_code

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "actionType": 0,
  "code": "",
  "operateType": 0,
  "phone": "",
  "region": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
smsSendCodeParam	验证码发送请求参数	body	true	SmsSendCodeParam	SmsSendCodeParam
actionType	操作类型（0：无效操作 2：登录 4：修改/重置登录密码）		false	integer(int32)
code	验证码【注：校验必传】		false	string
operateType	操作类型（0：无效操作 1：发送验证码 2：校验验证码		false	integer(int32)
phone	手机号【注：必传】		false	string
region	地区号（默认：86）【注：必传】		false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

系统用户登录

接口地址:/user/sys_login

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "account": "",
  "loginWay": 0,
  "password": "",
  "smsCode": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userLoginParam	用户登录参数	body	true	UserLoginParam	UserLoginParam
account	账号：用户id/油箱/手机号		true	string
loginWay	登录方式（1：密码 2：手机号 3：扫描）		true	integer(int32)
password	密码		false	string
smsCode	验证码		false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«LoginVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	LoginVO	LoginVO
account	账号	string
avatar	头像	string
doorBellIdDe	关联门铃号（明文）	integer(int32)
doorBellIdEn	关联门铃号（密文）	string
gender	性别（1：男,2：女）	integer(int32)
id	用户ID	string
loginAccountType	登录账号类型（1：手机号 2：邮箱 3：账号）	integer(int32)
loginTime	性别	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
phoneNumber	手机号	string
userId	用户ID	string
userRealName	真实姓名	string
userToken	用户token	string
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "account": "",
        "avatar": "",
        "doorBellIdDe": 0,
        "doorBellIdEn": "",
        "gender": 0,
        "id": "",
        "loginAccountType": 0,
        "loginTime": {
            "date": 0,
            "day": 0,
            "hours": 0,
            "minutes": 0,
            "month": 0,
            "nanos": 0,
            "seconds": 0,
            "time": 0,
            "timezoneOffset": 0,
            "year": 0
        },
        "phoneNumber": "",
        "userId": "",
        "userRealName": "",
        "userToken": ""
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

编辑管理员信息

接口地址:/user/update_admin_info

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "avatar": "",
  "doorBellId": "",
  "gender": "",
  "isBan": 0,
  "loginPassword": "",
  "nickname": "",
  "payPassword": "",
  "phone": "",
  "remake": "",
  "unbindAccount": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
editUserInfoParam	编辑用户对象参数	body	true	EditUserInfoParam	EditUserInfoParam
avatar	用户头像URL		false	string
doorBellId	关联门铃号ID（明文）		false	string
gender	用户性别（male：男, female：女）		false	string
isBan	是否禁用用户（1：是 0：否）		false	integer(int32)
loginPassword	用户登录密码		false	string
nickname	用户昵称		false	string
payPassword	用户支付密码		false	string
phone	用户手机号		false	string
remake	备注		false	string
unbindAccount	解绑账号（解绑账号(100：解绑微信 101：解绑手机 102：解绑苹果 103：解绑支付宝)）		false	integer(int32)
userId	用户userId		true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

编辑用户信息

接口地址:/user/update_user_info

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "avatar": "",
  "doorBellId": "",
  "gender": "",
  "isBan": 0,
  "loginPassword": "",
  "nickname": "",
  "payPassword": "",
  "phone": "",
  "remake": "",
  "unbindAccount": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
editUserInfoParam	编辑用户对象参数	body	true	EditUserInfoParam	EditUserInfoParam
avatar	用户头像URL		false	string
doorBellId	关联门铃号ID（明文）		false	string
gender	用户性别（male：男, female：女）		false	string
isBan	是否禁用用户（1：是 0：否）		false	integer(int32)
loginPassword	用户登录密码		false	string
nickname	用户昵称		false	string
payPassword	用户支付密码		false	string
phone	用户手机号		false	string
remake	备注		false	string
unbindAccount	解绑账号（解绑账号(100：解绑微信 101：解绑手机 102：解绑苹果 103：解绑支付宝)）		false	integer(int32)
userId	用户userId		true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

门铃号解密

接口地址:/user/user_id_decode

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userIds	用户ID（密文）,多个‘,’分割	query	true	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

门铃号加密

接口地址:/user/user_id_encode

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userIds	用户ID（明文）,多个‘,’分割	query	true	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

违规记录列表

接口地址:/user/violation_logs

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "groupId": 0,
    "keyWord": "",
    "startTimestamp": 0,
    "userId": 0,
    "violationLevel": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
violationLogsParam	违规列表参数	body	true	ViolationLogsParam	ViolationLogsParam
criteriaMap	赛选条件参数		false	criteriaMap_11	criteriaMap_11
endTimestamp	结束时间错（毫秒）		false	integer
groupId	违规群ID（不传则全部）		false	integer
keyWord	搜索关键词（如：管理员昵称/违规门铃号/群id/违规内容）		false	string
startTimestamp	结束时间戳（毫秒）		false	integer
userId	违规用户ID（不传则全部）		false	integer
violationLevel	违规等级（不传则全部）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«PageData«ViolationLogsList»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	PageData«ViolationLogsList»	PageData«ViolationLogsList»
dataList	违规记录列表	array	ViolationLogsList
createTime	开始时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
dayCount	天数	integer
dayLimit	每天限制次数	integer
endTime	结束时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
groupId	群id	integer
id		integer
monthLimit	每月限制次数	integer
status	状态 0 失效 1生效	integer
userId	用户id	integer
userName	用户昵称昵称	string
userPortraitUri	用户头像	string
violationLevel	违规等级 1：禁止建群，禁止进群，禁止加好友 2：没有购物能量奖励 3：禁止风铃提现至余额 4：禁止私聊 5：禁止群聊 6：全部禁言 7：禁止转账 8：禁止发红包 9：禁止领红包 10：禁止提现 11：禁止入群 12：禁止建群 13：禁止加好友 14：禁止发朋友圈 15：取消能量奖励 16：禁止发布快卖 17：禁止音视频聊天 18：禁止充值 19：限制微信充值次数 20：限制支付宝充值次数 21：限制提现次数 22：禁止评论朋友圈 23：禁止改头像昵称 24：禁止能量兑换商品 25：禁止能量兑换风铃 26：禁止风铃购物抵扣 27：限制更换设备登录 28：取消发布朋友圈能量奖励 29：禁止开启门铃 30：取消评论能量奖励 31：取消视频播放能量奖励 32：禁止群聊发语音 33：禁止群聊发图片 34：禁止群聊发视频 35：禁止群聊发文件 36：禁止群聊发朋友圈链接 37：禁止群聊发红包 38：设置群聊全体禁言 39：禁止单聊发语音 40：禁止单聊发图片 41：禁止单聊发视频 42：禁止单聊发文件 42：禁止单聊发朋友圈链接 44：禁止单聊发红包 45：32-37综合禁止	integer
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "dataList": [
            {
                "createTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "dayCount": 0,
                "dayLimit": 0,
                "endTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "groupId": 0,
                "id": 0,
                "monthLimit": 0,
                "status": 0,
                "userId": 0,
                "userName": "",
                "userPortraitUri": "",
                "violationLevel": 0
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

ML-管理员管理

管理员充值-转让

接口地址:/admin/money

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "adminUserId": "",
  "money": 0,
  "originalUserId": 0,
  "targetUserId": 0,
  "type": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
beAdminRechargeParam	管理员充值参数	body	true	BeAdminRechargeParam	BeAdminRechargeParam
adminUserId	超级管理员用户ID		true	string
money	金额）		false	number
originalUserId	源用户id（注：转让必传）		false	integer(int32)
targetUserId	目标用户ID		true	integer(int32)
type	类型（11：风铃充值 12：能量充值 13：余额充值 31：风铃转让 32：能量转让 33：余额转让）		true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

管理员充值-转让记录

接口地址:/admin/money_logs

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "groupId": 0,
    "keyWord": "",
    "startTimestamp": 0,
    "userId": 0,
    "violationLevel": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
violationLogsParam	违规列表参数	body	true	ViolationLogsParam	ViolationLogsParam
criteriaMap	赛选条件参数		false	criteriaMap_11	criteriaMap_11
endTimestamp	结束时间错（毫秒）		false	integer
groupId	违规群ID（不传则全部）		false	integer
keyWord	搜索关键词（如：管理员昵称/违规门铃号/群id/违规内容）		false	string
startTimestamp	结束时间戳（毫秒）		false	integer
userId	违规用户ID（不传则全部）		false	integer
violationLevel	违规等级（不传则全部）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«PageData«AdminMoneyLogsList»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	PageData«AdminMoneyLogsList»	PageData«AdminMoneyLogsList»
dataList	管理员充值/转让设置记录列表	array	AdminMoneyLogsList
adminPortraitUri	管理员用户头像	string
adminUserId	超级管理员用户ID	string
adminUserName	管理员用户名	string
createTime	操作时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
id		integer
money	金额	number
operation	操作（0：无 1：加 2：减）	integer
orderNum	订单号	string
originalUserId	源用户id	integer
originalUserName	源用户昵称昵称	string
originalUserPortraitUri	源用户头像	string
remark	备注	string
serviceFee	服务费	number
snapshot	快照	number
targetUserId	目标用户ID	integer
targetUserName	目标用户昵称昵称	string
targetUserPortraitUri	目标用户头像	string
title	标题	string
type	类型（11：风铃充值 12：能量充值 13：余额充值 31：风铃转让 32：能量转让 33：余额转让）	integer
typeId	分类ID，关联operation_type表（1：充值 18：转让）	integer
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "dataList": [
            {
                "adminPortraitUri": "",
                "adminUserId": "",
                "adminUserName": "",
                "createTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "id": 0,
                "money": 0,
                "operation": 0,
                "orderNum": "",
                "originalUserId": 0,
                "originalUserName": "",
                "originalUserPortraitUri": "",
                "remark": "",
                "serviceFee": 0,
                "snapshot": 0,
                "targetUserId": 0,
                "targetUserName": "",
                "targetUserPortraitUri": "",
                "title": "",
                "type": 0,
                "typeId": 0
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

忘记密码

接口地址:/admin/update_password

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
password	新密码	query	false	string
phone	手机号	query	false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

管理员违规设置

接口地址:/admin/violation

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "adminUserId": "",
  "day": 0,
  "dayLimit": 0,
  "groupId": "",
  "monthLimit": 0,
  "remark": "",
  "status": 0,
  "userId": "",
  "violationLevel": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
beAdminViolationParam	管理员违规管理参数	body	true	BeAdminViolationParam	BeAdminViolationParam
adminUserId	超级管理员用户id		true	string
day	天数		true	integer(int32)
dayLimit	每天限制次数		true	integer(int32)
groupId	违规群id（多个群id”,“分割）		false	string
monthLimit	每月限制次数		true	integer(int32)
remark	备注		false	string
status	状态(0 失效 1生效)		true	integer(int32)
userId	违规用户id（多个用户”,“分割）		false	string
violationLevel	违规等级\n1：禁止建群，禁止进群，禁止加好友\n2：没有购物能量奖励 \n3：禁止风铃提现至余额 \n4：禁止私聊\n5：禁止群聊\n6：全部禁言\n7：禁止转账\n8：禁止发红包\n9：禁止领红包\n10：禁止提现\n11：禁止入群\n12：禁止建群\n13：禁止加好友\n14：禁止发朋友圈\n15：取消能量奖励\n16：禁止发布快卖\n17：禁止音视频聊天\n18：禁止充值\n19：限制微信充值次数\n20：限制支付宝充值次数\n21：限制提现次数\n22：禁止评论朋友圈\n23：禁止改头像昵称\n24：禁止能量兑换商品\n25：禁止能量兑换风铃\n26：禁止风铃购物抵扣\n27：限制更换设备登录\n28：取消发布朋友圈能量奖励\n29：禁止开启门铃\n30：取消评论能量奖励\n31：取消视频播放能量奖励\n32：禁止群聊发语音\n33：禁止群聊发图片\n34：禁止群聊发视频 \n35：禁止群聊发文件\n36：禁止群聊发朋友圈链接\n37：禁止群聊发红包\n38：设置群聊全体禁言\n39：禁止单聊发语音\n40：禁止单聊发图片\n41：禁止单聊发视频\n42：禁止单聊发文件\n42：禁止单聊发朋友圈链接\n44：禁止单聊发红包\n45：32-37综合禁止		true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

管理员违规记录

接口地址:/admin/violation_logs

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "groupId": 0,
    "keyWord": "",
    "startTimestamp": 0,
    "userId": 0,
    "violationLevel": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
violationLogsParam	违规列表参数	body	true	ViolationLogsParam	ViolationLogsParam
criteriaMap	赛选条件参数		false	criteriaMap_11	criteriaMap_11
endTimestamp	结束时间错（毫秒）		false	integer
groupId	违规群ID（不传则全部）		false	integer
keyWord	搜索关键词（如：管理员昵称/违规门铃号/群id/违规内容）		false	string
startTimestamp	结束时间戳（毫秒）		false	integer
userId	违规用户ID（不传则全部）		false	integer
violationLevel	违规等级（不传则全部）		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«PageData«AdminViolationLogsList»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	PageData«AdminViolationLogsList»	PageData«AdminViolationLogsList»
dataList	管理员违规设置记录列表	array	AdminViolationLogsList
adminPortraitUri	管理员用户头像	string
adminUserId	超级管理员用户ID	string
adminUserName	管理员用户名	string
createTime	操作时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
dayCount	天数	integer
dayLimit	每天限制次数	integer
endTime	结束时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
groupId	违禁群id	integer
id		integer
monthLimit	每月限制次数	integer
opId	操作id	string
remark	备注	string
status	状态 0 失效 1生效	integer
userId	违禁用户ID	integer
userName	用户昵称昵称	string
userPortraitUri	用户头像	string
violationGroupsId	违规群id(逗号分割)	string
violationLevel	违规等级 1：禁止建群，禁止进群，禁止加好友 2：没有购物能量奖励 3：禁止风铃提现至余额 4：禁止私聊 5：禁止群聊 6：全部禁言 7：禁止转账 8：禁止发红包 9：禁止领红包 10：禁止提现 11：禁止入群 12：禁止建群 13：禁止加好友 14：禁止发朋友圈 15：取消能量奖励 16：禁止发布快卖 17：禁止音视频聊天 18：禁止充值 19：限制微信充值次数 20：限制支付宝充值次数 21：限制提现次数 22：禁止评论朋友圈 23：禁止改头像昵称 24：禁止能量兑换商品 25：禁止能量兑换风铃 26：禁止风铃购物抵扣 27：限制更换设备登录 28：取消发布朋友圈能量奖励 29：禁止开启门铃 30：取消评论能量奖励 31：取消视频播放能量奖励 32：禁止群聊发语音 33：禁止群聊发图片 34：禁止群聊发视频 35：禁止群聊发文件 36：禁止群聊发朋友圈链接 37：禁止群聊发红包 38：设置群聊全体禁言 39：禁止单聊发语音 40：禁止单聊发图片 41：禁止单聊发视频 42：禁止单聊发文件 42：禁止单聊发朋友圈链接 44：禁止单聊发红包 45：32-37综合禁止	integer
violationUsersId	违规用户id(逗号分割)	string
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "dataList": [
            {
                "adminPortraitUri": "",
                "adminUserId": "",
                "adminUserName": "",
                "createTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "dayCount": 0,
                "dayLimit": 0,
                "endTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "groupId": 0,
                "id": 0,
                "monthLimit": 0,
                "opId": "",
                "remark": "",
                "status": 0,
                "userId": 0,
                "userName": "",
                "userPortraitUri": "",
                "violationGroupsId": "",
                "violationLevel": 0,
                "violationUsersId": ""
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

ML-红包风控管理

DB-红包异常数据统计（次数-金额）

接口地址:/red_risk/get_abnormal_data_statistics

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	接口返回对象«RedDataStatisticsDTO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	RedDataStatisticsDTO	RedDataStatisticsDTO
abnormalBlockedAmount	红包异常拦截总金额	number
abnormalBlockedCount	红包异常拦截总次数	integer(int32)
abnormalIssuedAmount	红包异常发放总金额	number
abnormalIssuedCount	红包异常发放总次数	integer(int32)
abnormalUserCount	红包异常用户数	integer(int64)
abnormalUserInfoList	用户表	array	Users对象
address	地址	string
alipayAccount	支付宝账号	string
alipayNickName	支付宝昵称	string
alipayUserId	支付宝userId	string
appleSubId	苹果subID	string
backendAccount		string
birthday	生日	string
certBeginDate	身份证有效期起始时间）	string
certEndDate	身份证有效期截止时间	string
certType	身份证类型（0:中国居民二代身份证，1:港澳台来往内地通行证，2:外国人永久居留证，3:定居国外的中国公民护照，4:港澳台居民居住证）	integer
certValidityType	身份证有效期类型 （1：长期有效；0：非长期有效）	integer
circleSeeDay		integer
createdAt	注册时间	string
deletedAt	注销时间	string
device	绑订的设备	string
dmkAppleSubId	到门口APP苹果登录ID	string
driverId	绑订的设备唯一标识	string
energy	能量	number
friVerify		integer
friendsCount		integer
gender	性别（male：男，female：女）	string
groupCount		integer
groupVerify		integer
id		integer
idNumber	身份证号码	string
isBan	是否被禁（0：未禁用 1：已禁用）	integer
isEnergyMember	是否开通能量会员（0：未开通 1：已开通）	integer
isForced		integer
isMember	是否会员（0:未开通会员 1：正式会员 2：体验会员）	integer
isOfficialAccount		integer
isRealname	是否实名（ 1：已实名 0：未实名）	integer
lastLoginTime	最近登录时间（时间戳：毫秒）	integer
loginIp	登录IP	string
momentsCover	朋友圈头部图片	string
money	余额	number
nickname	用户昵称	string
openMenling		integer
password		string
passwordHash		string
passwordSalt		string
payPass		string
personalityName	个性签名	string
phone	手机号	string
phoneVerify		integer
pid		integer
pokeStatus		integer
portraitUri	用户头像	string
promotionCode		string
realnameTime	实名认证时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
region		string
rongCloudToken		string
stAccount		string
stSearchVerify		integer
strangerCanSee		string
strangerSeeCount	陌生人可查看朋友圈数量 20	integer
timestamp		integer
total	消费订单数	integer
totalCount	总条数	integer
totalMoney	消费金额	number
unionId	微信unionId	string
updAddressTime	修改地址时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
updBirthTime	修改生日时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
updatedAt		string
urealname		string
userType		string
windChime	风铃	number
wxNickName	微信昵称（用于已绑定的时候显示）	string
wxOpenId	微信openID	string
todayTotalAmount	今天总金额	number
todayTotalCount	今天红包总数	integer(int32)
yesterdayTotalAmount	昨天总金额	number
yesterdayTotalCount	昨天红包总数	integer(int32)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "abnormalBlockedAmount": 0,
        "abnormalBlockedCount": 0,
        "abnormalIssuedAmount": 0,
        "abnormalIssuedCount": 0,
        "abnormalUserCount": 0,
        "abnormalUserInfoList": [
            {
                "address": "",
                "alipayAccount": "",
                "alipayNickName": "",
                "alipayUserId": "",
                "appleSubId": "",
                "backendAccount": "",
                "birthday": "",
                "certBeginDate": "",
                "certEndDate": "",
                "certType": 0,
                "certValidityType": 0,
                "circleSeeDay": 0,
                "createdAt": "",
                "deletedAt": "",
                "device": "",
                "dmkAppleSubId": "",
                "driverId": "",
                "energy": 0,
                "friVerify": 0,
                "friendsCount": 0,
                "gender": "",
                "groupCount": 0,
                "groupVerify": 0,
                "id": 0,
                "idNumber": "",
                "isBan": 0,
                "isEnergyMember": 0,
                "isForced": 0,
                "isMember": 0,
                "isOfficialAccount": 0,
                "isRealname": 0,
                "lastLoginTime": 0,
                "loginIp": "",
                "momentsCover": "",
                "money": 0,
                "nickname": "",
                "openMenling": 0,
                "password": "",
                "passwordHash": "",
                "passwordSalt": "",
                "payPass": "",
                "personalityName": "",
                "phone": "",
                "phoneVerify": 0,
                "pid": 0,
                "pokeStatus": 0,
                "portraitUri": "",
                "promotionCode": "",
                "realnameTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "region": "",
                "rongCloudToken": "",
                "stAccount": "",
                "stSearchVerify": 0,
                "strangerCanSee": "",
                "strangerSeeCount": 0,
                "timestamp": 0,
                "total": 0,
                "totalCount": 0,
                "totalMoney": 0,
                "unionId": "",
                "updAddressTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "updBirthTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "updatedAt": "",
                "urealname": "",
                "userType": "",
                "windChime": 0,
                "wxNickName": "",
                "wxOpenId": ""
            }
        ],
        "todayTotalAmount": 0,
        "todayTotalCount": 0,
        "yesterdayTotalAmount": 0,
        "yesterdayTotalCount": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-红包异常用户数据统计

接口地址:/red_risk/get_abnormal_user_data_statistics

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	接口返回对象«RedDataStatisticsDTO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	RedDataStatisticsDTO	RedDataStatisticsDTO
abnormalBlockedAmount	红包异常拦截总金额	number
abnormalBlockedCount	红包异常拦截总次数	integer(int32)
abnormalIssuedAmount	红包异常发放总金额	number
abnormalIssuedCount	红包异常发放总次数	integer(int32)
abnormalUserCount	红包异常用户数	integer(int64)
abnormalUserInfoList	用户表	array	Users对象
address	地址	string
alipayAccount	支付宝账号	string
alipayNickName	支付宝昵称	string
alipayUserId	支付宝userId	string
appleSubId	苹果subID	string
backendAccount		string
birthday	生日	string
certBeginDate	身份证有效期起始时间）	string
certEndDate	身份证有效期截止时间	string
certType	身份证类型（0:中国居民二代身份证，1:港澳台来往内地通行证，2:外国人永久居留证，3:定居国外的中国公民护照，4:港澳台居民居住证）	integer
certValidityType	身份证有效期类型 （1：长期有效；0：非长期有效）	integer
circleSeeDay		integer
createdAt	注册时间	string
deletedAt	注销时间	string
device	绑订的设备	string
dmkAppleSubId	到门口APP苹果登录ID	string
driverId	绑订的设备唯一标识	string
energy	能量	number
friVerify		integer
friendsCount		integer
gender	性别（male：男，female：女）	string
groupCount		integer
groupVerify		integer
id		integer
idNumber	身份证号码	string
isBan	是否被禁（0：未禁用 1：已禁用）	integer
isEnergyMember	是否开通能量会员（0：未开通 1：已开通）	integer
isForced		integer
isMember	是否会员（0:未开通会员 1：正式会员 2：体验会员）	integer
isOfficialAccount		integer
isRealname	是否实名（ 1：已实名 0：未实名）	integer
lastLoginTime	最近登录时间（时间戳：毫秒）	integer
loginIp	登录IP	string
momentsCover	朋友圈头部图片	string
money	余额	number
nickname	用户昵称	string
openMenling		integer
password		string
passwordHash		string
passwordSalt		string
payPass		string
personalityName	个性签名	string
phone	手机号	string
phoneVerify		integer
pid		integer
pokeStatus		integer
portraitUri	用户头像	string
promotionCode		string
realnameTime	实名认证时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
region		string
rongCloudToken		string
stAccount		string
stSearchVerify		integer
strangerCanSee		string
strangerSeeCount	陌生人可查看朋友圈数量 20	integer
timestamp		integer
total	消费订单数	integer
totalCount	总条数	integer
totalMoney	消费金额	number
unionId	微信unionId	string
updAddressTime	修改地址时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
updBirthTime	修改生日时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
updatedAt		string
urealname		string
userType		string
windChime	风铃	number
wxNickName	微信昵称（用于已绑定的时候显示）	string
wxOpenId	微信openID	string
todayTotalAmount	今天总金额	number
todayTotalCount	今天红包总数	integer(int32)
yesterdayTotalAmount	昨天总金额	number
yesterdayTotalCount	昨天红包总数	integer(int32)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "abnormalBlockedAmount": 0,
        "abnormalBlockedCount": 0,
        "abnormalIssuedAmount": 0,
        "abnormalIssuedCount": 0,
        "abnormalUserCount": 0,
        "abnormalUserInfoList": [
            {
                "address": "",
                "alipayAccount": "",
                "alipayNickName": "",
                "alipayUserId": "",
                "appleSubId": "",
                "backendAccount": "",
                "birthday": "",
                "certBeginDate": "",
                "certEndDate": "",
                "certType": 0,
                "certValidityType": 0,
                "circleSeeDay": 0,
                "createdAt": "",
                "deletedAt": "",
                "device": "",
                "dmkAppleSubId": "",
                "driverId": "",
                "energy": 0,
                "friVerify": 0,
                "friendsCount": 0,
                "gender": "",
                "groupCount": 0,
                "groupVerify": 0,
                "id": 0,
                "idNumber": "",
                "isBan": 0,
                "isEnergyMember": 0,
                "isForced": 0,
                "isMember": 0,
                "isOfficialAccount": 0,
                "isRealname": 0,
                "lastLoginTime": 0,
                "loginIp": "",
                "momentsCover": "",
                "money": 0,
                "nickname": "",
                "openMenling": 0,
                "password": "",
                "passwordHash": "",
                "passwordSalt": "",
                "payPass": "",
                "personalityName": "",
                "phone": "",
                "phoneVerify": 0,
                "pid": 0,
                "pokeStatus": 0,
                "portraitUri": "",
                "promotionCode": "",
                "realnameTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "region": "",
                "rongCloudToken": "",
                "stAccount": "",
                "stSearchVerify": 0,
                "strangerCanSee": "",
                "strangerSeeCount": 0,
                "timestamp": 0,
                "total": 0,
                "totalCount": 0,
                "totalMoney": 0,
                "unionId": "",
                "updAddressTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "updBirthTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "updatedAt": "",
                "urealname": "",
                "userType": "",
                "windChime": 0,
                "wxNickName": "",
                "wxOpenId": ""
            }
        ],
        "todayTotalAmount": 0,
        "todayTotalCount": 0,
        "yesterdayTotalAmount": 0,
        "yesterdayTotalCount": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-行为风控列表

接口地址:/red_risk/get_behavior_rule_list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
adminId	管理员ID	query	false	string
endTimestamp	结束时间戳（毫秒）	query	false	string
keyword	搜索关键词	query	false	string
pageCount	页码,默认：1	query	false	string
pageSize	页大小,默认：10	query	false	string
startTimestamp	开始时间戳（毫秒）	query	false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«PageData«RedRiskBehaviorRule对象»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	PageData«RedRiskBehaviorRule对象»	PageData«RedRiskBehaviorRule对象»
dataList	红包行为风控规则表	array	RedRiskBehaviorRule对象
checkInterval	检测时间窗口（秒）	integer
createTime	创建时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
creatorId	创建人（后台管理员ID）	string
id	主键ID	integer
riskLevel	关联风险等级：1-低， 2-中， 3-高	integer
ruleCode	规则唯一编码，如：SPEED_GRAB	string
ruleDesc	规则详细描述	string
ruleName	规则名称，如：领包速度异常	string
status	状态：0-关闭， 1-开启	integer
threshold	触发阈值	integer
triggerCondition	触发条件（JSON结构，便于灵活配置）	object
updateTime	更新时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "dataList": [
            {
                "checkInterval": 0,
                "createTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "creatorId": "",
                "id": 0,
                "riskLevel": 0,
                "ruleCode": "",
                "ruleDesc": "",
                "ruleName": "",
                "status": 0,
                "threshold": 0,
                "triggerCondition": {},
                "updateTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                }
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-敏感词风控列表

接口地址:/red_risk/get_keywords_list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
adminId	管理员ID	query	false	string
endTimestamp	结束时间戳（毫秒）	query	false	string
keyword	搜索关键词	query	false	string
pageCount	页码,默认：1	query	false	string
pageSize	页大小,默认：10	query	false	string
startTimestamp	开始时间戳（毫秒）	query	false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«PageData«RedRiskKeywords对象»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	PageData«RedRiskKeywords对象»	PageData«RedRiskKeywords对象»
dataList	红包风控敏感词库表	array	RedRiskKeywords对象
category	词条分类，如“赌博”、“诈骗”等	string
createTime	创建时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
creatorId	创建人（后台管理员ID）	string
hitCount	累计命中次数（统计用）	integer
id	主键ID	integer
keyword	敏感词	string
riskLevel	风险等级：1-低， 2-中， 3-高	integer
status	状态：0-禁用， 1-启用	integer
updateTime	更新时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "dataList": [
            {
                "category": "",
                "createTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "creatorId": "",
                "hitCount": 0,
                "id": 0,
                "keyword": "",
                "riskLevel": 0,
                "status": 0,
                "updateTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                }
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-红包正常数据统计(次数-金额)

接口地址:/red_risk/get_normal_data_statistics

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	接口返回对象«RedDataStatisticsDTO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	RedDataStatisticsDTO	RedDataStatisticsDTO
abnormalBlockedAmount	红包异常拦截总金额	number
abnormalBlockedCount	红包异常拦截总次数	integer(int32)
abnormalIssuedAmount	红包异常发放总金额	number
abnormalIssuedCount	红包异常发放总次数	integer(int32)
abnormalUserCount	红包异常用户数	integer(int64)
abnormalUserInfoList	用户表	array	Users对象
address	地址	string
alipayAccount	支付宝账号	string
alipayNickName	支付宝昵称	string
alipayUserId	支付宝userId	string
appleSubId	苹果subID	string
backendAccount		string
birthday	生日	string
certBeginDate	身份证有效期起始时间）	string
certEndDate	身份证有效期截止时间	string
certType	身份证类型（0:中国居民二代身份证，1:港澳台来往内地通行证，2:外国人永久居留证，3:定居国外的中国公民护照，4:港澳台居民居住证）	integer
certValidityType	身份证有效期类型 （1：长期有效；0：非长期有效）	integer
circleSeeDay		integer
createdAt	注册时间	string
deletedAt	注销时间	string
device	绑订的设备	string
dmkAppleSubId	到门口APP苹果登录ID	string
driverId	绑订的设备唯一标识	string
energy	能量	number
friVerify		integer
friendsCount		integer
gender	性别（male：男，female：女）	string
groupCount		integer
groupVerify		integer
id		integer
idNumber	身份证号码	string
isBan	是否被禁（0：未禁用 1：已禁用）	integer
isEnergyMember	是否开通能量会员（0：未开通 1：已开通）	integer
isForced		integer
isMember	是否会员（0:未开通会员 1：正式会员 2：体验会员）	integer
isOfficialAccount		integer
isRealname	是否实名（ 1：已实名 0：未实名）	integer
lastLoginTime	最近登录时间（时间戳：毫秒）	integer
loginIp	登录IP	string
momentsCover	朋友圈头部图片	string
money	余额	number
nickname	用户昵称	string
openMenling		integer
password		string
passwordHash		string
passwordSalt		string
payPass		string
personalityName	个性签名	string
phone	手机号	string
phoneVerify		integer
pid		integer
pokeStatus		integer
portraitUri	用户头像	string
promotionCode		string
realnameTime	实名认证时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
region		string
rongCloudToken		string
stAccount		string
stSearchVerify		integer
strangerCanSee		string
strangerSeeCount	陌生人可查看朋友圈数量 20	integer
timestamp		integer
total	消费订单数	integer
totalCount	总条数	integer
totalMoney	消费金额	number
unionId	微信unionId	string
updAddressTime	修改地址时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
updBirthTime	修改生日时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
updatedAt		string
urealname		string
userType		string
windChime	风铃	number
wxNickName	微信昵称（用于已绑定的时候显示）	string
wxOpenId	微信openID	string
todayTotalAmount	今天总金额	number
todayTotalCount	今天红包总数	integer(int32)
yesterdayTotalAmount	昨天总金额	number
yesterdayTotalCount	昨天红包总数	integer(int32)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "abnormalBlockedAmount": 0,
        "abnormalBlockedCount": 0,
        "abnormalIssuedAmount": 0,
        "abnormalIssuedCount": 0,
        "abnormalUserCount": 0,
        "abnormalUserInfoList": [
            {
                "address": "",
                "alipayAccount": "",
                "alipayNickName": "",
                "alipayUserId": "",
                "appleSubId": "",
                "backendAccount": "",
                "birthday": "",
                "certBeginDate": "",
                "certEndDate": "",
                "certType": 0,
                "certValidityType": 0,
                "circleSeeDay": 0,
                "createdAt": "",
                "deletedAt": "",
                "device": "",
                "dmkAppleSubId": "",
                "driverId": "",
                "energy": 0,
                "friVerify": 0,
                "friendsCount": 0,
                "gender": "",
                "groupCount": 0,
                "groupVerify": 0,
                "id": 0,
                "idNumber": "",
                "isBan": 0,
                "isEnergyMember": 0,
                "isForced": 0,
                "isMember": 0,
                "isOfficialAccount": 0,
                "isRealname": 0,
                "lastLoginTime": 0,
                "loginIp": "",
                "momentsCover": "",
                "money": 0,
                "nickname": "",
                "openMenling": 0,
                "password": "",
                "passwordHash": "",
                "passwordSalt": "",
                "payPass": "",
                "personalityName": "",
                "phone": "",
                "phoneVerify": 0,
                "pid": 0,
                "pokeStatus": 0,
                "portraitUri": "",
                "promotionCode": "",
                "realnameTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "region": "",
                "rongCloudToken": "",
                "stAccount": "",
                "stSearchVerify": 0,
                "strangerCanSee": "",
                "strangerSeeCount": 0,
                "timestamp": 0,
                "total": 0,
                "totalCount": 0,
                "totalMoney": 0,
                "unionId": "",
                "updAddressTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "updBirthTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "updatedAt": "",
                "urealname": "",
                "userType": "",
                "windChime": 0,
                "wxNickName": "",
                "wxOpenId": ""
            }
        ],
        "todayTotalAmount": 0,
        "todayTotalCount": 0,
        "yesterdayTotalAmount": 0,
        "yesterdayTotalCount": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-风控记录

接口地址:/red_risk/get_trigger_logs

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "keyWord": "",
    "startTimestamp": 0,
    "triggerType": 0,
    "userId": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
redRiskTriggerLogParam	风控日志参数	body	true	RedRiskTriggerLogParam	RedRiskTriggerLogParam
criteriaMap	赛选条件参数		false	criteriaMap_9	criteriaMap_9
endTimestamp	结束时间错（毫秒）		false	integer
keyWord	搜索关键词（仅昵称）		false	string
startTimestamp	结束时间戳（毫秒）		false	integer
triggerType	触发类型：1-关键词 2-行为复合触发 3-关键词+行为复合触发		false	integer
userId	风控用户ID		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«PageData«RedRiskTriggerLog对象»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	PageData«RedRiskTriggerLog对象»	PageData«RedRiskTriggerLog对象»
dataList	红包风控触发记录表	array	RedRiskTriggerLog对象
groupId	群ID（如为群聊触发）	integer
id	主键ID	integer
isProcessed	是否已被复合判定或处罚流程处理：0-否， 1-是	integer
logSn	风控记录流水号，全局唯一	string
processRemark	处理备注	string
relatedRedpacketId	关联的红包ID	integer
riskLevel	本次触发的风险等级	integer
riskName	风控标题	string
ruleId	关联的规则ID（risk_keywords.id 或 risk_behavior_rule.id）	integer
triggerData	触发时的上下文数据快照（JSON，如消息内容、红包金额、领取列表等）	object
triggerTime	触发时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
triggerType	触发类型：1-关键词 2-行为复合触发 3-关键词+行为复合触发	integer
userId	触发用户ID	integer
userImage	触发用户头像	string
userName	触发用户名	string
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "dataList": [
            {
                "groupId": 0,
                "id": 0,
                "isProcessed": 0,
                "logSn": "",
                "processRemark": "",
                "relatedRedpacketId": 0,
                "riskLevel": 0,
                "riskName": "",
                "ruleId": 0,
                "triggerData": {},
                "triggerTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "triggerType": 0,
                "userId": 0,
                "userImage": "",
                "userName": ""
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

DB-用户风控列表

接口地址:/red_risk/get_user_punish_list

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "keyWord": "",
    "punishLevel": 0,
    "punishStatus": 0,
    "punishType": 0,
    "startTimestamp": 0,
    "triggerType": 0,
    "userId": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
redRiskUserPunishParam	风控处罚参数	body	true	RedRiskUserPunishParam	RedRiskUserPunishParam
criteriaMap	赛选条件参数		false	criteriaMap_10	criteriaMap_10
endTimestamp	结束时间错（毫秒） 默认值：0		false	integer
keyWord	搜索关键词（仅昵称）		false	string
punishLevel	处罚程度：1-高， 2-中， 3-低 默认值：-1		false	integer
punishStatus	处理状态：0-待处理， 1-处理中， 2-已处理 3-已关闭 默认值：-1		false	integer
punishType	处罚类型： 1-弹窗警告， 2-违规处罚 默认值：-1		false	integer
startTimestamp	结束时间戳（毫秒） 默认值：0		false	integer
triggerType	触发类型：1-关键词 2-行为复合触发 3-关键词+行为复合触发 默认值：-1		false	integer
userId	风控用户ID		false	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«PageData«RedRiskList»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	PageData«RedRiskList»	PageData«RedRiskList»
dataList	用户风控列表	array	RedRiskList
auditRemark	审核意见	string
auditTime	审核时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
auditorId	审核人(SYSTEM/AI 或 后台管理员ID）	string
blackListId	违规处罚ID：关联的违规黑名单ID（balck_list.id）	integer
createTime	开始时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
dayCount	天数	integer
dayLimit	每天限制次数	integer
endTime	结束时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
groupId	群ID（如为群聊触发）	integer
monthLimit	每月限制次数	integer
punishLevel	处罚程度：1-高， 2-中， 3-低	integer
punishRemark	处罚备注	string
punishSn	工单号	string
punishStatus	处理状态：0-待处理， 1-处理中， 2-已处理 3-已关闭	integer
punishType	处罚类型：1-弹窗警告， 2-违规处罚	integer
relatedLogIds	关联的触发记录ID（证据链）	string
riskName	风控标题	string
status	状态 0 失效 1生效	integer
triggerType	触发类型：1-关键词 2-行为复合触发 3-关键词+行为复合触发	integer
updateTime	更新时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
userId	被处罚用户ID	integer
userImage	触发用户头像	string
userName	触发用户名	string
violationCount	历史总违规次数（统计）	integer
violationLevel	违规等级 1：禁止建群，禁止进群，禁止加好友 2：没有购物能量奖励 3：禁止风铃提现至余额 4：禁止私聊 5：禁止群聊 6：全部禁言 7：禁止转账 8：禁止发红包 9：禁止领红包 10：禁止提现 11：禁止入群 12：禁止建群 13：禁止加好友 14：禁止发朋友圈 15：取消能量奖励 16：禁止发布快卖 17：禁止音视频聊天 18：禁止充值 19：限制微信充值次数 20：限制支付宝充值次数 21：限制提现次数 22：禁止评论朋友圈 23：禁止改头像昵称 24：禁止能量兑换商品 25：禁止能量兑换风铃 26：禁止风铃购物抵扣 27：限制更换设备登录 28：取消发布朋友圈能量奖励 29：禁止开启门铃 30：取消评论能量奖励 31：取消视频播放能量奖励 32：禁止群聊发语音 33：禁止群聊发图片 34：禁止群聊发视频 35：禁止群聊发文件 36：禁止群聊发朋友圈链接 37：禁止群聊发红包 38：设置群聊全体禁言 39：禁止单聊发语音 40：禁止单聊发图片 41：禁止单聊发视频 42：禁止单聊发文件 42：禁止单聊发朋友圈链接 44：禁止单聊发红包 45：32-37综合禁止	integer
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "dataList": [
            {
                "auditRemark": "",
                "auditTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "auditorId": "",
                "blackListId": 0,
                "createTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "dayCount": 0,
                "dayLimit": 0,
                "endTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "groupId": 0,
                "monthLimit": 0,
                "punishLevel": 0,
                "punishRemark": "",
                "punishSn": "",
                "punishStatus": 0,
                "punishType": 0,
                "relatedLogIds": "",
                "riskName": "",
                "status": 0,
                "triggerType": 0,
                "updateTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "userId": 0,
                "userImage": "",
                "userName": "",
                "violationCount": 0,
                "violationLevel": 0
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

ML-群管理

DB-添加自动加群

接口地址:/groups/auto_join_groups

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
groupIds	groupIds	query	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

获取群列表

接口地址:/groups/get_groups_list

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "criteriaMap": {
    "endTimestamp": 0,
    "keyWord": "",
    "startTimestamp": 0,
    "userId": 0
  },
  "pageCount": 0,
  "pageSize": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userGroupsParam	用户群列表	body	true	UserGroupsParam	UserGroupsParam
criteriaMap	赛选条件参数		true	criteriaMap_7	criteriaMap_7
endTimestamp	结束时间错（毫秒）		false	integer
keyWord	搜索关键词（仅昵称）		false	string
startTimestamp	结束时间戳（毫秒）		false	integer
userId	用户ID		true	integer
pageCount	页数【默认：第1页】		false	integer(int32)
pageSize	页大小【默认：10条】		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«UserGroupsList»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	UserGroupsList	UserGroupsList
groupsList	群	array	Groups对象
bulletin	公告	string
canMoneyPay	是否支持余额支付 Y支持 N不支持	string
certiStatus	证书状态	integer
clearStatus	清楚状态	integer
clearTimeAt	清楚时间	integer
copiedTime	复制时间	integer
createdAt	创建时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
creatorId	创建者ID	integer
deletedAt	删除时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
fee	入群费用	number
id	群ID	integer
isMute	是否静音	integer
lable	群标签，付费	string
maxManagerCount	最大管理员人数	integer
maxMemberCount	最大群员人数	integer
memberCount	群员人数	integer
memberProtection		integer
name	群名	string
notice	付费权益公告	string
portraitUri	群logo	string
timestamp	时间戳	integer
updNameNum	修改群昵称次数，限制3次	integer
updNameTime	最后一次修改群昵称时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
updatedAt	更新时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
pageCount	当前页	integer(int64)
pageSize	当前页大小	integer(int64)
pages	页数	integer(int64)
total	所有数据条数	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "groupsList": [
            {
                "bulletin": "",
                "canMoneyPay": "",
                "certiStatus": 0,
                "clearStatus": 0,
                "clearTimeAt": 0,
                "copiedTime": 0,
                "createdAt": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "creatorId": 0,
                "deletedAt": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "fee": 0,
                "id": 0,
                "isMute": 0,
                "lable": "",
                "maxManagerCount": 0,
                "maxMemberCount": 0,
                "memberCount": 0,
                "memberProtection": 0,
                "name": "",
                "notice": "",
                "portraitUri": "",
                "timestamp": 0,
                "updNameNum": 0,
                "updNameTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "updatedAt": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                }
            }
        ],
        "pageCount": 0,
        "pageSize": 0,
        "pages": 0,
        "total": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

ML-融云管理

群聊发送

接口地址:/rongcloud/message/group/publish.json

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
params	详细参数，详见官方（https://docs.rongcloud.cn/platform-chat-api/message/send-group）\n【注：字段名、字段类型、是否必传务必与官方API对应】	body	false	string

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

单聊发送

接口地址:/rongcloud/message/private/publish.json

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
params	详细参数，详见官方（https://docs.rongcloud.cn/platform-chat-api/message/send-private）\n【注：字段名、字段类型、是否必传务必与官方API对应】	body	false	string

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

DB-添加消息敏感词

接口地址:/rongcloud/sensitiveword/add.json

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
params	详细参数，详见官方（https://docs.rongcloud.cn/platform-chat-api/moderation/add-sensitive-word）\n【注：字段名、字段类型、是否必传务必与官方API对应】	body	false	string

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

DB-批量添加消息敏感词

接口地址:/rongcloud/sensitiveword/batch/add.json

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
params	详细参数，详见官方（https://docs.rongcloud.cn/platform-chat-api/moderation/batch-add-sensitive-word）\n【注：字段名、字段类型、是否必传务必与官方API对应】	body	false	string

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

DB-批量移除消息敏感词

接口地址:/rongcloud/sensitiveword/batch/delete.json

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
params	详细参数，详见官方（https://docs.rongcloud.cn/platform-chat-api/moderation/batch-remove-sensitive-word）\n【注：字段名、字段类型、是否必传务必与官方API对应】	body	false	string

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

DB-移除消息敏感词

接口地址:/rongcloud/sensitiveword/delete.json

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
params	详细参数，详见官方（https://docs.rongcloud.cn/platform-chat-api/moderation/remove-sensitive-word）\n【注：字段名、字段类型、是否必传务必与官方API对应】	body	false	string

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

DB-查询消息敏感词

接口地址:/rongcloud/sensitiveword/list.json

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
params	详细参数，详见官方（https://docs.rongcloud.cn/platform-chat-api/moderation/query-sensitive-word）\n【注：字段名、字段类型、是否必传务必与官方API对应】	body	false	string

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

ML-运费模板管理

DB-运费模板列表

接口地址:/logistics/add_template

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

一页大小10条数据

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	页数：0 为第一页	query	true	string

响应状态:

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

DB-添加运费模板

接口地址:/logistics/add_template

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "expressCode": "测试",
  "moban": [
    "[{arr:[{\"id\":1 ,\"name\":\"江西\"},{\"id\":1 ,\"name\":\"上海\",}],price:\"8.00\"},{arr:[{\"id\":1 ,\"name\":\"江西\"},{\"id\":1 ,\"name\":\"上海\",}],price:\"10.00\"}]"
  ],
  "price": 1.2
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
templateParam	运费模板参数	body	true	TemplateParam	TemplateParam
expressCode	模板标题		true	string
moban	id 为地区ID： 格式 [{arr:[{"id":1 ,"name":"江西"},{"id":1 ,"name":"上海",}],price:"8.00"},{arr:[{"id":1 ,"name":"江西"},{"id":1 ,"name":"上海",}],price:"10.00"}]		true	array	string
price	未设置城市价格		true	string

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

商家认证管理

商家认证审核[后台转发请求]

接口地址:/storeLeasing/doAudit

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "failReason": "",
  "id": 0,
  "reviewUserId": 0,
  "status": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
auditBO	商家认证审核BO	body	true	商家认证审核BO	商家认证审核BO
failReason			false	string
id			false	integer(int64)
reviewUserId			false	integer(int64)
status			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

暂无

响应示例:

查询认证详情

接口地址:/storeLeasing/getLeasingDetail

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
leasingId	leasingId	query	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«StoreLeasing对象»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	StoreLeasing对象	StoreLeasing对象
address	注册地址	string
authorizationLicenseUrl	授权方营业执照	string
authorizationUrl	授权书	string
bossName	经营者名称	string
bossPhone	经营者电话	string
brandName	品牌名称	string
brandType	品牌类型1，自营品牌 2，代理品牌	string
businessLicenseUrl	营业执照	string
businessTypeId	经营行业	integer(int32)
cardBackUrl	身份证背面照片	string
cardFaceUrl	身份证正脸照片	string
cardNum	社会信用代码	string
companyName	企业名称	string
corporateEntity	法定代表人	string
corporateEntityCard	法定代表人身份证	string
createTime	创建时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
failReason	审核失败的原因	string
id		integer(int32)
logoCertificateUrl	商标注册证书	string
reviewUserId	审核人的id	integer(int32)
status	审核状态 0审核中 1审核通过 2不通过	integer(int32)
storeImg	店铺头像	string
storeName	店铺名称	string
type	主体类型 1：个人商家 2：企业商家 3：品牌商家	integer(int32)
userId	关联用户id	integer(int32)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "address": "",
        "authorizationLicenseUrl": "",
        "authorizationUrl": "",
        "bossName": "",
        "bossPhone": "",
        "brandName": "",
        "brandType": "",
        "businessLicenseUrl": "",
        "businessTypeId": 0,
        "cardBackUrl": "",
        "cardFaceUrl": "",
        "cardNum": "",
        "companyName": "",
        "corporateEntity": "",
        "corporateEntityCard": "",
        "createTime": {
            "date": 0,
            "day": 0,
            "hours": 0,
            "minutes": 0,
            "month": 0,
            "nanos": 0,
            "seconds": 0,
            "time": 0,
            "timezoneOffset": 0,
            "year": 0
        },
        "failReason": "",
        "id": 0,
        "logoCertificateUrl": "",
        "reviewUserId": 0,
        "status": 0,
        "storeImg": "",
        "storeName": "",
        "type": 0,
        "userId": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

分页查询订单

接口地址:/storeLeasing/pageLeasing

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

查询类型说明: 1:店铺名称/经营者名称
排序类型说明: 1:创建时间

请求示例:

{
  "endDate": "",
  "keyword": "",
  "keywordType": 0,
  "page": {
    "current": 0,
    "pageSize": 0
  },
  "sortIsDesc": 0,
  "sortType": 0,
  "startDate": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
auditStatus	商家认证状态	query	false	integer(int32)
params	请求参数	body	false	请求参数	请求参数
endDate	截至日期(如:2024-01-08		false	string(date)
keyword	搜索关键字(模糊查询		false	string
keywordType	关键字类型(不同接口不同搜索类型		false	integer(int32)
page	分页参数		false	分页参数	分页参数
current	页码(默认为1		false	integer
pageSize	页长(默认为10		false	integer
sortIsDesc	排序是否倒序(1倒序大到小0正序小到大		false	integer(int32)
sortType	排序类型(不同接口不同排序类型		false	integer(int32)
startDate	开始日期(如:2024-01-08		false	string(date)
storeType	商家主体类型	query	false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«PageDto«分页查询商家认证VO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	PageDto«分页查询商家认证VO»	PageDto«分页查询商家认证VO»
dataCount	所有数据条数	integer(int64)
dataList	查询数据列表	array	分页查询商家认证VO
bossName	经营者名称	string
createTime	创建时间	Timestamp	Timestamp
date		integer
day		integer
hours		integer
minutes		integer
month		integer
nanos		integer
seconds		integer
time		integer
timezoneOffset		integer
year		integer
id		integer
status	审核状态 0审核中 1审核通过 2不通过	integer
storeImg	店铺头像	string
storeName	店铺名称	string
type	主体类型 1：个人商家 2：企业商家 3：品牌商家	integer
pageCount	所有页数	integer(int64)
pageCurrent	当前页数	integer(int64)
pageSize	当前页大小	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "dataCount": 0,
        "dataList": [
            {
                "bossName": "",
                "createTime": {
                    "date": 0,
                    "day": 0,
                    "hours": 0,
                    "minutes": 0,
                    "month": 0,
                    "nanos": 0,
                    "seconds": 0,
                    "time": 0,
                    "timezoneOffset": 0,
                    "year": 0
                },
                "id": 0,
                "status": 0,
                "storeImg": "",
                "storeName": "",
                "type": 0
            }
        ],
        "pageCount": 0,
        "pageCurrent": 0,
        "pageSize": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

平台日志管理

分页查询操作日志

接口地址:/log/pageLog

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

查询类型说明: 1:用户ID/用户名, 2:操作类型/操作描述, 3:请求IP/请求地址
排序类型说明: 1:记录时间, 2:耗费时长(毫秒)

请求示例:

{
  "endDate": "",
  "keyword": "",
  "keywordType": 0,
  "page": {
    "current": 0,
    "pageSize": 0
  },
  "sortIsDesc": 0,
  "sortType": 0,
  "startDate": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
params	请求参数	body	true	请求参数	请求参数
endDate	截至日期(如:2024-01-08		false	string(date)
keyword	搜索关键字(模糊查询		false	string
keywordType	关键字类型(不同接口不同搜索类型		false	integer(int32)
page	分页参数		false	分页参数	分页参数
current	页码(默认为1		false	integer
pageSize	页长(默认为10		false	integer
sortIsDesc	排序是否倒序(1倒序大到小0正序小到大		false	integer(int32)
sortType	排序类型(不同接口不同排序类型		false	integer(int32)
startDate	开始日期(如:2024-01-08		false	string(date)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

管理账号管理

修改管理账号信息(包含角色列表

接口地址:/admin/alterAdmin

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "password": "",
  "roleIdList": [],
  "status": 0,
  "userAvatar": "",
  "userEmail": "",
  "userGender": 0,
  "userId": "",
  "userRealname": "",
  "userTelephone": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
alterAdmin	修改管理员	body	true	修改管理员	修改管理员
password	用户密码		false	string
roleIdList	角色id		false	array	string
status	启用状态(0禁用,1启用)		false	integer(int32)
userAvatar	用户头像		false	string
userEmail	用户邮箱		false	string
userGender	用户性别(1男,2女)		false	integer(int32)
userId	管理员id		false	string
userRealname	用户姓名		false	string
userTelephone	用户手机		false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

修改管理账号密码

接口地址:/admin/alterAdminPwd

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "password": "",
  "userId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
alterAdminPwd	修改管理员密码	body	true	修改管理员密码	修改管理员密码
password			false	string
userId			false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

修改我的手机号(执行修改)

接口地址:/admin/alterMinePhone

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "captchaCode": "",
  "phoneNew": "",
  "phoneOld": "",
  "region": "",
  "userId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
alterMinePhone	修改我的手机号	body	true	修改我的手机号	修改我的手机号
captchaCode	验证码code		false	string
phoneNew	新手机号		false	string
phoneOld	旧手机号		false	string
region	地区号【注：必传,86为中国大陆】		false	string
userId	管理员id		false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

修改我的手机号(发送验证码)

接口地址:/admin/alterMinePhoneSendCode

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "phoneOld": "",
  "region": "",
  "userId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
alterMinePhoneSendCode	修改我的手机号	body	true	修改我的手机号_1	修改我的手机号_1
phoneOld	旧手机号		false	string
region	地区号【注：必传,86为中国大陆】		false	string
userId	管理员id		false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

修改我的密码

接口地址:/admin/alterMinePwd

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "pwdNew": "",
  "pwdOld": "",
  "userId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
alterMinePassword	修改我的密码	body	true	修改我的密码	修改我的密码
pwdNew	新密码		false	string
pwdOld	旧密码		false	string
userId	管理员id		false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

禁用启用管理账号

接口地址:/admin/alterStatus

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
status	status	query	true	integer(int32)
userId	userId	query	true	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

创建管理账号并指定角色列表

接口地址:/admin/createAdmin

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "roleIdList": [],
  "userAccount": "",
  "userAvatar": "",
  "userEmail": "",
  "userGender": 0,
  "userNote": "",
  "userPassword": "",
  "userRealname": "",
  "userTelephone": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
admin	创建管理员	body	true	创建管理员	创建管理员
roleIdList	角色id列表		false	array	string
userAccount	用户账号		false	string
userAvatar	用户头像		false	string
userEmail	用户邮箱		false	string
userGender	用户性别(1男,2女)		false	integer(int32)
userNote	用户备注		false	string
userPassword	用户密码		false	string
userRealname	用户姓名		false	string
userTelephone	用户手机		false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

删除管理账号

接口地址:/admin/delAdmin

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userId	userId	query	true	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

查询管理账号详情

接口地址:/admin/getAdminDetails

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
adminId	adminId	query	true	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

分页查询管理账号

接口地址:/admin/pageAdmin

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

查询类型说明: 1:用户ID/用户名
排序类型说明: 1:新增时间, 2:修改时间

请求示例:

{
  "endDate": "",
  "keyword": "",
  "keywordType": 0,
  "page": {
    "current": 0,
    "pageSize": 0
  },
  "sortIsDesc": 0,
  "sortType": 0,
  "startDate": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
params	请求参数	body	true	请求参数	请求参数
endDate	截至日期(如:2024-01-08		false	string(date)
keyword	搜索关键字(模糊查询		false	string
keywordType	关键字类型(不同接口不同搜索类型		false	integer(int32)
page	分页参数		false	分页参数	分页参数
current	页码(默认为1		false	integer
pageSize	页长(默认为10		false	integer
sortIsDesc	排序是否倒序(1倒序大到小0正序小到大		false	integer(int32)
sortType	排序类型(不同接口不同排序类型		false	integer(int32)
startDate	开始日期(如:2024-01-08		false	string(date)
roleId	roleId	query	false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

管理账号角色权限管理

修改角色权限

接口地址:/adminPerm/alterPerm

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "createTime": "",
  "permId": "",
  "permName": "",
  "permPath": "",
  "permPathLevel": 0,
  "permSort": 0,
  "status": 0,
  "updateTime": "",
  "upperPermId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
adminPerm	管理人员角色权限	body	true	AdminPerm对象	AdminPerm对象
createTime	创建时间		false	string(date-time)
permId	权限id		false	string
permName	权限名称		false	string
permPath	授权页面路径(如/admin/details		false	string
permPathLevel	授权页面路径层级(默认为0		false	integer(int32)
permSort	排序字段		false	integer(int32)
status	启用状态(0禁用,1启用)		false	integer(int32)
updateTime	更新时间		false	string(date-time)
upperPermId	上级权限id		false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

禁用启用管理角色权限

接口地址:/adminPerm/alterStatus

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
permId	permId	query	true	string
status	status	query	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

批量新增角色权限

接口地址:/adminPerm/batchAddPerm

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

[
  {
    "createTime": "",
    "permId": "",
    "permName": "",
    "permPath": "",
    "permPathLevel": 0,
    "permSort": 0,
    "status": 0,
    "updateTime": "",
    "upperPermId": ""
  }
]

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
permList	管理人员角色权限	body	true	array	AdminPerm对象
createTime	创建时间		false	string(date-time)
permId	权限id		false	string
permName	权限名称		false	string
permPath	授权页面路径(如/admin/details		false	string
permPathLevel	授权页面路径层级(默认为0		false	integer(int32)
permSort	排序字段		false	integer(int32)
status	启用状态(0禁用,1启用)		false	integer(int32)
updateTime	更新时间		false	string(date-time)
upperPermId	上级权限id		false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

增删角色权限

接口地址:/adminPerm/changePerm

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "createTime": "",
  "permId": "",
  "permName": "",
  "permPath": "",
  "permPathLevel": 0,
  "permSort": 0,
  "status": 0,
  "updateTime": "",
  "upperPermId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
adminPerm	管理人员角色权限	body	true	AdminPerm对象	AdminPerm对象
createTime	创建时间		false	string(date-time)
permId	权限id		false	string
permName	权限名称		false	string
permPath	授权页面路径(如/admin/details		false	string
permPathLevel	授权页面路径层级(默认为0		false	integer(int32)
permSort	排序字段		false	integer(int32)
status	启用状态(0禁用,1启用)		false	integer(int32)
updateTime	更新时间		false	string(date-time)
upperPermId	上级权限id		false	string
actionType	1添加角色权限, 2移除角色权限	query	false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

列表查询角色权限

接口地址:/adminPerm/listPerm

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "createTime": "",
  "permId": "",
  "permName": "",
  "permPath": "",
  "permPathLevel": 0,
  "permSort": 0,
  "status": 0,
  "updateTime": "",
  "upperPermId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
perm	管理人员角色权限	body	true	AdminPerm对象	AdminPerm对象
createTime	创建时间		false	string(date-time)
permId	权限id		false	string
permName	权限名称		false	string
permPath	授权页面路径(如/admin/details		false	string
permPathLevel	授权页面路径层级(默认为0		false	integer(int32)
permSort	排序字段		false	integer(int32)
status	启用状态(0禁用,1启用)		false	integer(int32)
updateTime	更新时间		false	string(date-time)
upperPermId	上级权限id		false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

分页查询角色权限

接口地址:/adminPerm/pagePerm

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

查询类型说明: 1:权限ID/权限名, 2:授权页面路径
排序类型说明: 1:新增时间, 2:修改时间, 3:手动排序字段

请求示例:

{
  "endDate": "",
  "keyword": "",
  "keywordType": 0,
  "page": {
    "current": 0,
    "pageSize": 0
  },
  "sortIsDesc": 0,
  "sortType": 0,
  "startDate": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
params	请求参数	body	true	请求参数	请求参数
endDate	截至日期(如:2024-01-08		false	string(date)
keyword	搜索关键字(模糊查询		false	string
keywordType	关键字类型(不同接口不同搜索类型		false	integer(int32)
page	分页参数		false	分页参数	分页参数
current	页码(默认为1		false	integer
pageSize	页长(默认为10		false	integer
sortIsDesc	排序是否倒序(1倒序大到小0正序小到大		false	integer(int32)
sortType	排序类型(不同接口不同排序类型		false	integer(int32)
startDate	开始日期(如:2024-01-08		false	string(date)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

树形查询角色权限

接口地址:/adminPerm/treePerm

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
permId	permId	query	false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

管理账号角色管理

修改管理角色

接口地址:/adminRole/alterRole

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "permIdList": [],
  "roleDesc": "",
  "roleId": "",
  "roleName": "",
  "roleSort": 0,
  "status": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
adminRole	修改管理员角色	body	true	修改管理员角色	修改管理员角色
permIdList	权限id列表		false	array	string
roleDesc	角色描述		false	string
roleId	角色id		false	string
roleName	角色名(如管理员,财务员		false	string
roleSort	排序字段		false	integer(int32)
status	启用状态(0禁用,1启用)		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

禁用启用管理角色

接口地址:/adminRole/alterStatus

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
roleId	roleId	query	true	string
status	status	query	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

增删管理角色

接口地址:/adminRole/changeRole

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "createTime": "",
  "permIdList": [],
  "permList": [
    {
      "createTime": "",
      "permId": "",
      "permName": "",
      "permPath": "",
      "permPathLevel": 0,
      "permSort": 0,
      "status": 0,
      "updateTime": "",
      "upperPermId": ""
    }
  ],
  "permNode": {
    "createTime": "",
    "permId": "",
    "permName": "",
    "permNodeList": [
      {
        "createTime": "",
        "permId": "",
        "permName": "",
        "permNodeList": [
          {}
        ],
        "permPath": "",
        "permPathLevel": 0,
        "permSort": 0,
        "status": 0,
        "updateTime": "",
        "upperPermId": ""
      }
    ],
    "permPath": "",
    "permPathLevel": 0,
    "permSort": 0,
    "status": 0,
    "updateTime": "",
    "upperPermId": ""
  },
  "roleDesc": "",
  "roleId": "",
  "roleName": "",
  "roleSort": 0,
  "status": 0,
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
adminRole	管理人员角色	body	true	AdminRole对象	AdminRole对象
createTime	创建时间		false	string(date-time)
permIdList	权限id列表		false	array	string
permList	管理人员角色权限		false	array	AdminPerm对象
createTime	创建时间		false	string
permId	权限id		false	string
permName	权限名称		false	string
permPath	授权页面路径(如/admin/details		false	string
permPathLevel	授权页面路径层级(默认为0		false	integer
permSort	排序字段		false	integer
status	启用状态(0禁用,1启用)		false	integer
updateTime	更新时间		false	string
upperPermId	上级权限id		false	string
permNode	管理账号角色权限		false	管理账号角色权限	管理账号角色权限
createTime	创建时间		false	string
permId	权限id		false	string
permName	权限名称		false	string
permNodeList			false	array	管理账号角色权限
permPath	授权页面路径(如/admin/details		false	string
permPathLevel	授权页面路径层级(默认为0		false	integer
permSort	排序字段		false	integer
status	启用状态(0禁用,1启用)		false	integer
updateTime	更新时间		false	string
upperPermId	上级权限id		false	string
roleDesc	角色描述		false	string
roleId	角色id		false	string
roleName	角色名(如管理员,财务员		false	string
roleSort	排序字段		false	integer(int32)
status	启用状态(0禁用,1启用)		false	integer(int32)
updateTime	更新时间		false	string(date-time)
actionType	1添加管理角色, 2移除管理角色	query	false	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

查询管理角色详情

接口地址:/adminRole/getRoleDetails

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
roleId	roleId	query	true	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

分页查询管理角色

接口地址:/adminRole/pageRole

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

查询类型说明: 1:角色ID/角色名/角色描述
排序类型说明: 1:新增时间, 2:修改时间, 3:手动排序字段

请求示例:

{
  "endDate": "",
  "keyword": "",
  "keywordType": 0,
  "page": {
    "current": 0,
    "pageSize": 0
  },
  "sortIsDesc": 0,
  "sortType": 0,
  "startDate": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
params	请求参数	body	true	请求参数	请求参数
endDate	截至日期(如:2024-01-08		false	string(date)
keyword	搜索关键字(模糊查询		false	string
keywordType	关键字类型(不同接口不同搜索类型		false	integer(int32)
page	分页参数		false	分页参数	分页参数
current	页码(默认为1		false	integer
pageSize	页长(默认为10		false	integer
sortIsDesc	排序是否倒序(1倒序大到小0正序小到大		false	integer(int32)
sortType	排序类型(不同接口不同排序类型		false	integer(int32)
startDate	开始日期(如:2024-01-08		false	string(date)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	object
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

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

门铃订单管理

查询订单详情

接口地址:/order/getOrderDetails

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
orderNum	orderNum	query	true	string

响应状态:

状态码	说明	schema
200	OK	接口返回对象«订单详情VO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	订单详情VO	订单详情VO
order	用户能量会员订单	UserEnergyVipOrder对象	UserEnergyVipOrder对象
applyRefundTime	申请退款时间	string
createdAt	创建时间	string
id		integer
inviteUserId	邀请人id	integer
orderNum	订单号	string
originalAmount	原价	number
outTradeNo	商户订单号	string
payAmount	实付金额	number
payTime	支付时间	string
payType	0余额支付 1风铃支付 2支付宝 3微信 4斗拱	integer
reason	申请退款原因（json）	string
refundMoney	退款金额	number
refundTime	退款时间	string
status	状态（0：待支付 1：支付成功 2：退款成功 10订单取消）	integer
tradeNum	交易流水号(上游订单号)	string
type	类型（1：能量会员 365元 2：体验卡 3.9元 3：体验卡包 100元）	integer
userId	用户ID	integer
user	用户	OrderUserInfo	OrderUserInfo
gender		string
id		integer
nickname		string
phone		string
portraitUri		string
region		string
vip	用户能量会员	UserEnergyVip对象	UserEnergyVip对象
createTime	创建时间	string
endTime	会员结束时间	string
giveAcceleratorCard	已发放的能量体验卡次数	integer
giveWindChimeNum	已发放的风铃数量	integer
id		integer
inviteUserId	邀请人id	integer
privilegeIds	权益id (1,2,3,4,5,6,7,8,9)	string
renewalNum	续费次数	integer
startTime	会员开始时间	string
status	状态(0：过期 1：有效 )	integer
userId	用户ID（关联表users >>> id）	integer
vipId	会员卡ID	string
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "order": {
            "applyRefundTime": "",
            "createdAt": "",
            "id": 0,
            "inviteUserId": 0,
            "orderNum": "",
            "originalAmount": 0,
            "outTradeNo": "",
            "payAmount": 0,
            "payTime": "",
            "payType": 0,
            "reason": "",
            "refundMoney": 0,
            "refundTime": "",
            "status": 0,
            "tradeNum": "",
            "type": 0,
            "userId": 0
        },
        "user": {
            "gender": "",
            "id": 0,
            "nickname": "",
            "phone": "",
            "portraitUri": "",
            "region": ""
        },
        "vip": {
            "createTime": "",
            "endTime": "",
            "giveAcceleratorCard": 0,
            "giveWindChimeNum": 0,
            "id": 0,
            "inviteUserId": 0,
            "privilegeIds": "",
            "renewalNum": 0,
            "startTime": "",
            "status": 0,
            "userId": 0,
            "vipId": ""
        }
    },
    "message": "",
    "success": true,
    "timestamp": 0
}

分页查询订单

接口地址:/order/pageOrder

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

查询类型说明: 1:用户ID/用户名/订单号
排序类型说明: 1:支付时间, 2:支付金额

请求示例:

{
  "endDate": "",
  "keyword": "",
  "keywordType": 0,
  "page": {
    "current": 0,
    "pageSize": 0
  },
  "sortIsDesc": 0,
  "sortType": 0,
  "startDate": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
params	请求参数	body	false	请求参数	请求参数
endDate	截至日期(如:2024-01-08		false	string(date)
keyword	搜索关键字(模糊查询		false	string
keywordType	关键字类型(不同接口不同搜索类型		false	integer(int32)
page	分页参数		false	分页参数	分页参数
current	页码(默认为1		false	integer
pageSize	页长(默认为10		false	integer
sortIsDesc	排序是否倒序(1倒序大到小0正序小到大		false	integer(int32)
sortType	排序类型(不同接口不同排序类型		false	integer(int32)
startDate	开始日期(如:2024-01-08		false	string(date)
payStatus	支付状态	query	false	integer(int32)
payType	支付方式	query	false	integer(int32)
productType	商品类型	query	false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	接口返回对象«PageDto«分页查询订单VO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code	返回代码	integer(int32)	integer(int32)
data	返回数据对象	PageDto«分页查询订单VO»	PageDto«分页查询订单VO»
dataCount	所有数据条数	integer(int64)
dataList	查询数据列表	array	分页查询订单VO
orderId	订单id	string
orderNum	订单号	string
payStatus	支付状态(0待支付 1支付成功 2退款成功 10订单取消)	integer
payTime	支付时间	string
payType	支付类型(0余额支付 1风铃支付 2支付宝 3微信 4斗拱)	integer
productPrice	商品价格	number
productType	商品类型(1能量会员365元 2体验卡3.9元 3体验卡包100元)	integer
userAvatar	用户头像	string
userId	用户id	string
userName	用户名称	string
pageCount	所有页数	integer(int64)
pageCurrent	当前页数	integer(int64)
pageSize	当前页大小	integer(int64)
message	返回处理消息	string
success	成功标志	boolean
timestamp	时间戳	integer(int64)	integer(int64)

响应示例:

{
    "code": 0,
    "data": {
        "dataCount": 0,
        "dataList": [
            {
                "orderId": "",
                "orderNum": "",
                "payStatus": 0,
                "payTime": "",
                "payType": 0,
                "productPrice": 0,
                "productType": 0,
                "userAvatar": "",
                "userId": "",
                "userName": ""
            }
        ],
        "pageCount": 0,
        "pageCurrent": 0,
        "pageSize": 0
    },
    "message": "",
    "success": true,
    "timestamp": 0
}