Files
ycc-proxy-server/app/main/api/desc/admin/admin_complaint.api
2026-01-25 19:07:24 +08:00

179 lines
8.1 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

syntax = "v1"
info (
title: "投诉管理服务"
desc: "投诉管理相关接口"
version: "v1"
)
@server (
prefix: api/v1/admin/complaint
group: admin_complaint
middleware: AdminAuthInterceptor
)
service main {
@doc "获取投诉列表"
@handler AdminGetComplaintList
get /list (AdminGetComplaintListReq) returns (AdminGetComplaintListResp)
@doc "获取投诉详情"
@handler AdminGetComplaintDetail
get /detail/:id (AdminGetComplaintDetailReq) returns (AdminGetComplaintDetailResp)
@doc "更新投诉状态"
@handler AdminUpdateComplaintStatus
put /update-status/:id (AdminUpdateComplaintStatusReq) returns (AdminUpdateComplaintStatusResp)
@doc "更新投诉备注"
@handler AdminUpdateComplaintRemark
put /update-remark/:id (AdminUpdateComplaintRemarkReq) returns (AdminUpdateComplaintRemarkResp)
}
type (
// 列表请求
AdminGetComplaintListReq {
Page int64 `form:"page,default=1"` // 页码
PageSize int64 `form:"pageSize,default=20"` // 每页数量
Type string `form:"type,optional"` // 投诉类型alipay-支付宝投诉manual-主动投诉
Status string `form:"status,optional"` // 投诉状态pending-待处理processing-处理中resolved-已解决closed-已关闭
Name string `form:"name,optional"` // 投诉人姓名
Contact string `form:"contact,optional"` // 联系方式
OrderId string `form:"order_id,optional"` // 关联订单ID
CreateTimeStart string `form:"create_time_start,optional"` // 创建时间开始
CreateTimeEnd string `form:"create_time_end,optional"` // 创建时间结束
HandleTimeStart string `form:"handle_time_start,optional"` // 处理时间开始
HandleTimeEnd string `form:"handle_time_end,optional"` // 处理时间结束
}
// 列表响应
AdminGetComplaintListResp {
Total int64 `json:"total"` // 总数
Items []ComplaintListItem `json:"items"` // 列表
}
// 列表项
ComplaintListItem {
Id string `json:"id"` // 投诉ID
Type string `json:"type"` // 投诉类型alipay-支付宝投诉manual-主动投诉
OrderId string `json:"order_id"` // 关联订单ID
Name string `json:"name"` // 投诉人姓名
Contact string `json:"contact"` // 联系方式
Content string `json:"content"` // 投诉内容
Status string `json:"status"` // 投诉状态
StatusDescription string `json:"status_description"` // 状态描述
Remark string `json:"remark"` // 处理备注
HandlerId string `json:"handler_id"` // 处理人ID
HandleTime string `json:"handle_time"` // 处理时间
CreateTime string `json:"create_time"` // 创建时间
UpdateTime string `json:"update_time"` // 更新时间
// 支付宝投诉特有字段
TaskId string `json:"task_id"` // 支付宝投诉单号
TradeNo string `json:"trade_no"` // 支付宝交易单号
ComplainAmount string `json:"complain_amount"` // 投诉金额
GmtComplain string `json:"gmt_complain"` // 投诉时间
// 主动投诉特有字段
Subject string `json:"subject"` // 投诉主题
Priority string `json:"priority"` // 优先级
Source string `json:"source"` // 投诉来源
}
// 详情请求
AdminGetComplaintDetailReq {
Id string `path:"id"` // 投诉ID
}
// 详情响应
AdminGetComplaintDetailResp {
Id string `json:"id"` // 投诉ID
Type string `json:"type"` // 投诉类型alipay-支付宝投诉manual-主动投诉
OrderId string `json:"order_id"` // 关联订单ID
Name string `json:"name"` // 投诉人姓名
Contact string `json:"contact"` // 联系方式
Content string `json:"content"` // 投诉内容
Status string `json:"status"` // 投诉状态
StatusDescription string `json:"status_description"` // 状态描述
Remark string `json:"remark"` // 处理备注
HandlerId string `json:"handler_id"` // 处理人ID
HandleTime string `json:"handle_time"` // 处理时间
CreateTime string `json:"create_time"` // 创建时间
UpdateTime string `json:"update_time"` // 更新时间
// 支付宝投诉详情
AlipayComplaint *AlipayComplaintDetail `json:"alipay_complaint,optional"` // 支付宝投诉详情
// 主动投诉详情
ManualComplaint *ManualComplaintDetail `json:"manual_complaint,optional"` // 主动投诉详情
}
// 支付宝投诉详情
AlipayComplaintDetail {
Id string `json:"id"` // 支付宝投诉表ID
AlipayId int64 `json:"alipay_id"` // 支付宝投诉主表的主键id
TaskId string `json:"task_id"` // 投诉单号id
OppositePid string `json:"opposite_pid"` // 被投诉人pid
OppositeName string `json:"opposite_name"` // 被投诉方名称
ComplainAmount string `json:"complain_amount"` // 投诉单涉及交易总金额
GmtComplain string `json:"gmt_complain"` // 投诉时间
GmtProcess string `json:"gmt_process"` // 处理时间
ComplainContent string `json:"complain_content"` // 用户投诉内容
TradeNo string `json:"trade_no"` // 投诉交易单号
Status string `json:"status"` // 投诉状态
StatusDescription string `json:"status_description"` // 投诉单状态枚举值描述
ProcessCode string `json:"process_code"` // 商家处理结果码
ProcessMessage string `json:"process_message"` // 商家处理结果码对应描述
ProcessRemark string `json:"process_remark"` // 商家处理备注
ProcessImgUrlList []string `json:"process_img_url_list"` // 商家处理备注图片url列表
GmtRiskFinishTime string `json:"gmt_risk_finish_time"` // 推送时间
ComplainUrl string `json:"complain_url"` // 投诉网址
CertifyInfo []string `json:"certify_info"` // 投诉凭证图片信息
TradeInfoList []AlipayComplaintTradeInfo `json:"trade_info_list"` // 交易信息列表
}
// 支付宝投诉交易信息
AlipayComplaintTradeInfo {
Id string `json:"id"` // 交易信息表ID
AlipayTradeId string `json:"alipay_trade_id"` // 交易信息表主键id
AlipayComplaintRecordId string `json:"alipay_complaint_record_id"` // 投诉主表id
TradeNo string `json:"trade_no"` // 支付宝交易单号
OutNo string `json:"out_no"` // 商家订单号
GmtTrade string `json:"gmt_trade"` // 交易时间
GmtRefund string `json:"gmt_refund"` // 退款时间
Status string `json:"status"` // 交易投诉状态
StatusDescription string `json:"status_description"` // 交易投诉状态描述
Amount string `json:"amount"` // 交易单金额
}
// 主动投诉详情
ManualComplaintDetail {
Id string `json:"id"` // 主动投诉表ID
UserId string `json:"user_id"` // 关联用户ID
Subject string `json:"subject"` // 投诉主题
Priority string `json:"priority"` // 优先级low-低medium-中high-高urgent-紧急
Source string `json:"source"` // 投诉来源web-网站phone-电话email-邮件other-其他
AttachmentUrls []string `json:"attachment_urls"` // 附件URL列表
}
// 更新投诉状态请求
AdminUpdateComplaintStatusReq {
Id string `path:"id"` // 投诉ID
Status string `json:"status"` // 投诉状态pending-待处理processing-处理中resolved-已解决closed-已关闭
StatusDescription string `json:"status_description,optional"` // 状态描述
HandlerId string `json:"handler_id,optional"` // 处理人ID
}
// 更新投诉状态响应
AdminUpdateComplaintStatusResp {
Success bool `json:"success"` // 是否成功
}
// 更新投诉备注请求
AdminUpdateComplaintRemarkReq {
Id string `path:"id"` // 投诉ID
Remark string `json:"remark"` // 处理备注
}
// 更新投诉备注响应
AdminUpdateComplaintRemarkResp {
Success bool `json:"success"` // 是否成功
}
)