2. 欠费催缴API
API列表
编号 | API名称 |
---|---|
2.1 | APP查询欠费催缴业主记录列表 |
2.2 | APP发送欠费催缴短信 |
2.3 | 中台欠费催缴短信发送列表 |
2.4 | APP新增欠费催缴白名单 |
2.5 | 中台导出欠费催缴短信记录 |
HTTP协议:
HTTP,HTTPS
API调用
2.1:APP查询欠费催缴业主记录列表
APP获取欠费催缴业主记录列表
请求信息
URI:https://biz-running-uat.smartmideazy.com/charge/arrear-history/can-send/list
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | BODY | STRING | 否 | 项目ID |
userName | BODY | STRING | 是 | 管家账号 |
keywords | BODY | STRING | 否 | 业名称和房屋名称模糊查询 |
pageNo | HEADER | Integer | 否 | 页码 |
pageSize | HEADER | Integer | 否 | 分页数 |
请求Body描述(非Form表单数据)
{
"communityId": "1003837",
"userName": "lipl4",
"keywords":"1401",
"pageNo":1,
"pageSize":20
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
total | data | INTEGER | 是 | 总记录数 |
pages | data | INTEGER | 是 | 页数 |
arrearHistoryInfos | data | JSONArray | 是 | 欠费催缴的业主信息 |
historyInfoId | arrearHistoryInfos | Integer | 否 | 欠费记录ID |
communityName | arrearHistoryInfos | String | 否 | 项目名称 |
communityId | arrearHistoryInfos | Integer | 否 | 项目ID |
houseName | arrearHistoryInfos | String | 否 | 房屋名称 |
houseId | arrearHistoryInfos | Integer | 否 | 房屋ID |
buildName | arrearHistoryInfos | String | 否 | 楼栋名称 |
buildId | arrearHistoryInfos | Integer | 否 | 楼栋ID |
unitName | arrearHistoryInfos | String | 否 | 单元名称 |
unitId | arrearHistoryInfos | Integer | 否 | 单元ID |
userId | arrearHistoryInfos | Long | 否 | 用户ID |
userName | arrearHistoryInfos | String | 否 | 用户名称 |
contactPhone | arrearHistoryInfos | String | 否 | 用户手机号 |
acctAmount | arrearHistoryInfos | BigDecimal | 否 | 欠费金额(元) |
costCycle | arrearHistoryInfos | Integer | 否 | 费用周期 |
costTotal | arrearHistoryInfos | String | 否 | 费用总期数 |
createTimeStr | arrearHistoryInfos | String | 否 | 创建时间 |
updateTimeStr | arrearHistoryInfos | String | 否 | 更新时间 |
contactPhone | arrearHistoryInfos | String | 否 | 用户手机 |
managerId | arrearHistoryInfos | Long | 否 | 管家ID |
managerUserName | arrearHistoryInfos | String | 否 | 管家名称 |
managerContactPhone | arrearHistoryInfos | String | 否 | 管家手机号 |
sendDate | arrearHistoryInfos | String | 否 | 上一次催缴发送短信时间 |
返回结果示例
{
"code": 200,
"data": {
"total": 1,
"pages": 1,
"arrearHistoryInfos": [
{
"historyInfoId": 1,
"communityName": "美的翰诚嘉园",
"communityId": 1003837,
"houseName": "6栋1单元2102",
"houseId": 537011,
"buildName": null,
"buildId": null,
"unitName": null,
"unitId": null,
"userId": 32,
"userName": "郑雲玲",
"contactPhone": "18269242824",
"acctAmount": 3434.22,
"costCycle": "2020-01,2020-02,2020-03,2020-04,2020-05,2020-06,2020-07,2020-08,2020-09,2020-10,2020-11,2020-12",
"costTotal": 12,
"isDealWith": "N",
"createTime": "2021-07-05T09:51:35.000+0000",
"updateTime": "2021-07-07T06:27:17.000+0000",
"createBy": null,
"updateBy": null,
"versionNum": 0,
"deleteFlag": 0,
"createTimeStr": "2021-07-05 17:51:35",
"updateTimeStr": "2021-07-07 14:27:17",
"managerId": null,
"managerUserName": null,
"managerContactPhone": null,
"sendDate": "2021-07-07 14:27:44"
}
],
"pageNo": 1,
"pageSize": 10
},
"message": "success"
}
{
"code": 200,
"data": {
"total": 0,
"pages": 0,
"arrearHistoryInfos": [],
"pageNo": 1,
"pageSize": 10
},
"message": "success"
}
异常返回示例
{"code":401,"message":"Invalid Signature"}
2.2:APP发送欠费催缴短信
描述
请求信息
URI:https://biz-running-uat.smartmideazy.com/charge/arrear-history/can-send/send
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | BODY | STRING | 是 | 项目ID |
isCheckAll | BODY | STRING | 是 | 是否全部发送:Y:全选发,当值为N时:ids不能为空 |
ids | BODY | STRING | 否 | 选择需要发送的欠费记录ID,逗号隔开 |
userId | BODY | STRING | 是 | 管家用户ID |
请求Body描述(非Form表单数据)
情况一:
{
"communityId": "1003837",
"userName": "lipl4",
"isCheckAll":"Y",
"mobile":"13600009603",
"userId":1945728
}
情况二
{
"communityId": "1003837",
"userName": "lipl4",
"isCheckAll":"N",
"ids":"1,2,3,4,5,6",
"mobile":"13600009603",
"userId":1945728
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
注意:因为是利用MQ发送的,所以会直接返回成功,其实返回成功的时候,还没处理完
{
"code": 200,
"data": {},
"message": "success"
}
异常返回示例
{"code":401,"message":"Invalid Signature"}
2.3:中台欠费催缴短信发送列表
描述
请求信息
URI:https://biz-running-uat.smartmideazy.com/charge/arrear-api/api/query/list
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | BODY | STRING | 否 | 项目ID |
communityName | BODY | STRING | 否 | 项目名称 |
mobile | BODY | STRING | 否 | 业主手机号或管家手机号模糊查询 |
fromTime | BODY | Date | 是 | 开始时间 |
toTime | BODY | Date | 是 | 结束时间 |
pageNo | HEADER | Integer | 否 | 页码 |
pageSize | HEADER | Integer | 否 | 分页数 |
请求Body描述(非Form表单数据)
{
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
total | data | INTEGER | 是 | 总记录数 |
pages | data | INTEGER | 是 | 页数 |
arrearRemindMsg | data | JSONArray | 是 | 欠费催缴的业主信息 |
remindMsgId | arrearRemindMsg | Integer | 否 | 记录ID |
communityName | arrearRemindMsg | String | 否 | 项目名称 |
communityId | arrearRemindMsg | Integer | 否 | 项目ID |
houseName | arrearRemindMsg | JSONObject | 否 | 接受客户房屋 |
houseId | arrearRemindMsg | Integer | 否 | 房屋ID |
buildName | arrearRemindMsg | String | 否 | 楼栋名称 |
buildId | arrearRemindMsg | Integer | 否 | 楼栋ID |
unitName | arrearRemindMsg | String | 否 | 单元名称 |
unitId | arrearRemindMsg | Integer | 否 | 单元ID |
userId | arrearRemindMsg | Long | 否 | 用户ID |
userName | arrearRemindMsg | String | 否 | 接受客户 |
contactPhone | arrearRemindMsg | String | 否 | 接受客户手机号 |
createTimeStr | arrearRemindMsg | String | 否 | 创建时间 |
updateTimeStr | arrearRemindMsg | String | 否 | 更新时间 |
managerId | arrearRemindMsg | Long | 否 | 管家ID |
managerUserName | arrearRemindMsg | String | 否 | 发送管家 |
managerContactPhone | arrearRemindMsg | String | 否 | 发送管家电话 |
sendDateStr | arrearRemindMsg | String | 否 | 短信发送时间 |
返回结果示例
{
"code": 200,
"data": {
"arrearRemindMsg": [
{
"remindMsgId": 2,
"communityName": "美的翰诚嘉园",
"communityId": 1003837,
"houseName": "6栋1单元2102",
"houseId": 537011,
"buildName": null,
"unitName": null,
"userId": 32,
"userName": "郑雲玲",
"contactPhone": "18269242824",
"managerId": 1945728,
"managerUserName": "lipl4",
"managerContactPhone": "13600009603",
"sendDate": "2021-07-07T06:27:44.000+0000",
"sendStatus": "OK",
"msgSubject": null,
"msgContent": null,
"createTime": "2021-07-07T06:27:44.000+0000",
"updateTime": "2021-07-07T06:27:44.000+0000",
"createBy": 1945728,
"updateBy": 1945728,
"versionNum": 0,
"deleteFlag": 0,
"createTimeStr": "2021-07-07 14:27:44",
"updateTimeStr": "2021-07-07 14:27:44",
"sendDateStr": "2021-07-07 14:27:44"
}
],
"total": 1,
"pages": 1,
"pageNo": 1,
"pageSize": 5
},
"message": "success"
}
异常返回示例
{"code":401,"message":"Invalid Signature"}
2.4:APP新增欠费催缴白名单
描述
请求信息
URI:https://biz-running-uat.smartmideazy.com/charge/arrear-remind/white-list/create
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
arWhitelist | BODY | JSONObject | 是 | 系统参数信息 |
whitelistType | arWhitelist | STRING | 是 | 白名单类型:在欠费催缴中固定:arrear_remind_msg |
businessType | arWhitelist | STRING | 是 | 白名单业务类型:根据什么判断白名单:在欠费催缴中固定:community_house_user |
communityId | arWhitelist | STRING | 是 | 项目ID |
houseId | arWhitelist | STRING | 是 | 房屋ID |
userId | arWhitelist | DATE | 是 | 业主ID |
managerId | arWhitelist | DATE | 是 | 管家ID |
请求Body描述(非Form表单数据)
{
"arWhitelist":{
"whitelistType": "arrear_remind_msg",
"businessType": "community_house_user",
"communityId": 21441121,
"houseId": "35651289",
"userId": 14,
"managerId": "1865616"
}
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | INTEGER | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": 200,
"data": {},
"message": "success"
}
异常返回示例
{"code":401,"message":"Invalid Signature"}
2.5:导出缴费记录
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:https://biz-running-uat.smartmideazy.com/biz/mob/report/csv/exportCsvArrearRemindMsg
方法:POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 | | 名称 | 位置 | 类型 | 必填 | 描述 | | ---------------- | ------------ | ------- | ---- | ------------------------------------------------------------ | | communityId | BODY | STRING | 否 | 项目ID | | communityName | BODY | STRING | 否 | 项目名称 | | mobile | BODY | STRING | 否 | 业主手机号或管家手机号模糊查询 | | fromTime | BODY | Date | 是 | 开始时间 | | toTime | BODY | Date | 是 | 结束时间 |
请求Body描述(非Form表单数据)
返回信息
返回参数类型
返回参数
返回结果示例
导出
异常返回示例
{"code":400,"message":"暂无信息","data":{}}