HC小区接口文档

投诉提交接口文档

投诉
查询投诉

一、接口名称

提交投诉

二、接口描述

该接口用于用户提交投诉信息,包括投诉类型、投诉内容、联系方式等,并支持上传投诉相关的图片。

三、接口路径

http://ip:port/app/complaint.SaveComplaint

四、请求方法

POST

五、请求头

参数名称 必填 类型 描述
Authorization 是 String 用户认证token,Base token 通过登录接口获取
app-id 是 String 应用ID,系统dev账户分配
transaction-id 是 String 请求流水号,不能重复,格式:1000000000+YYYYMMDDhhmmss+6位序列
sign 是 String 签名
req-time 是 String 请求时间,格式:YYYYMMDDhhmmss

六、请求参数

6.1 请求体参数(JSON格式)

参数名称 必填 类型 描述 示例
complaintName 是 String 投诉标题 "噪音扰民"
typeCd 是 String 投诉类型编码 "1001"
communityId 是 String 小区ID "123456"
roomId 是 String 房间ID "789012"
tel 是 String 联系电话 "13800138000"
context 是 String 投诉内容 "楼上住户深夜噪音过大"
photos 否 Array<String> 投诉相关图片(Base64编码或URL) ["data:image/jpeg;base64,..."]

七、返回值

7.1 返回值(JSON格式)

参数名称 必填 类型 描述
code 是 String 返回码,0 表示成功,其他表示失败
msg 是 String 返回信息
data 否 Object 返回数据(成功时可能包含投诉ID等信息)

八、示例请求

8.1 请求示例

POST /app/complaint.SaveComplaint HTTP/1.1
Host: localhost:8080
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
app-id: micro-community
transaction-id: 100000000020240301123456000001
sign: 7a89f8d7a6f5d4c3b2a1
req-time: 20240301123456
Content-Type: application/json

{
  "complaintName": "噪音扰民",
  "typeCd": "1001",
  "communityId": "123456",
  "roomId": "789012",
  "tel": "13800138000",
  "context": "楼上住户深夜噪音过大",
  "photos": ["data:image/jpeg;base64,..."]
}

8.2 响应示例

成功响应

{
  "code": "0",
  "msg": "投诉提交成功",
  "data": {
    "complaintId": "10000001"
  }
}

失败响应

{
  "code": "1001",
  "msg": "投诉类型不存在"
}

九、业务逻辑说明

  1. 参数校验

    • 检查必填字段是否完整(complaintName、typeCd、communityId、roomId、tel、context)。
    • 校验投诉类型是否存在。
    • 校验房间信息是否存在。
  2. 数据存储

    • 生成投诉ID(complaintId)。
    • 保存投诉信息到数据库(complaint 表)。
    • 记录投诉事件(complaint_event 表)。
    • 如果包含图片,保存图片信息(file 和 file_rel 表)。
  3. 消息通知

    • 发送消息通知相关工作人员处理投诉。

十、注意事项

  1. 权限要求

    • 用户必须登录(携带有效 Authorization)。
    • 用户必须属于指定小区。
  2. 图片处理

    • 图片可以是 Base64 编码或 URL,超过 512 字节的图片会自动存储到文件服务器。
  3. 事务管理

    • 该接口采用事务管理,确保数据一致性。
  4. 错误码

    • 0:成功
    • 1001:投诉类型不存在
    • 1002:房间不存在
    • 1003:用户未登录
    • 1004:小区未入驻
    • 1005:数据保存失败

以上为完整的 API 接口文档,适用于开发者集成投诉提交功能。