Files
go-sms-V2/internal/pkg/errors/codes.go
T

149 lines
8.5 KiB
Go

// Package errors 平台错误码体系。
// 格式:ISC:xxx(ISC 为平台标识,xxx 三位数字);000 成功。
// 段位:001-099 发送链路(网关/账号/通道准入、回执与终端状态、路由与内容合规);
//
// 400 段通用请求错误;500 段系统错误。
//
// 权威业务码表由产品侧定义(Day 15 修订),与 system_error_code 表
// 经 v4 迁移以本包 All() 为单一事实来源对齐。
package errors
import (
"net/http"
"regexp"
)
// Error 平台错误:错误码 + 中英文描述 + 建议 HTTP 状态码。
type Error struct {
Code string `json:"code"`
Msg string `json:"msg"`
MsgEn string `json:"msg_en"`
HTTPStatus int `json:"-"`
}
// Error 实现 error 接口。
func (e *Error) Error() string { return e.Code + " " + e.Msg }
// WithMsg 派生错误:保留错误码,覆盖中文消息(场景化提示)。
func (e *Error) WithMsg(msg string) *Error {
return &Error{Code: e.Code, Msg: msg, MsgEn: e.MsgEn, HTTPStatus: e.HTTPStatus}
}
var codePattern = regexp.MustCompile(`^ISC:\d{3}$`)
// IsValidCode 校验错误码格式(ISC:xxx,三位数字)。
func IsValidCode(code string) bool { return codePattern.MatchString(code) }
var (
OK = &Error{Code: "ISC:000", Msg: "成功", MsgEn: "OK", HTTPStatus: http.StatusOK}
// ---- 网关/账号/通道准入(001-009,权威码表)----
GatewayError = &Error{"ISC:001", "网关错误", "gateway error", http.StatusBadGateway}
AccountDisabled = &Error{"ISC:002", "账号被禁用", "account disabled", http.StatusForbidden}
SignatureDisabled = &Error{"ISC:003", "签名被禁用", "signature disabled", http.StatusForbidden}
SignatureInvalid = &Error{"ISC:004", "签名非法", "invalid signature", http.StatusBadRequest}
ChannelInvalid = &Error{"ISC:005", "通道非法", "invalid channel", http.StatusBadRequest}
Blacklist = &Error{"ISC:006", "黑名单", "blacklisted number", http.StatusForbidden}
Arrears = &Error{"ISC:007", "欠费", "arrears / insufficient balance", http.StatusPaymentRequired}
SMSCInternalError = &Error{"ISC:009", "短信网关内部错误", "SMSC internal error", http.StatusBadGateway}
// ---- 回执与终端状态(010-026,权威码表)----
ReportTimeout = &Error{"ISC:010", "发送回执超时", "report timeout", http.StatusGatewayTimeout}
UserOffline = &Error{"ISC:011", "用户不在线", "user offline", http.StatusOK}
UserSuspended = &Error{"ISC:012", "用户停机", "user suspended", http.StatusOK}
NoRoutePortability = &Error{"ISC:013", "没有路由,携号转网", "no route, number portability", http.StatusOK}
UserOutOfService = &Error{"ISC:014", "用户不在服务区", "user out of service area", http.StatusOK}
PortOffline = &Error{"ISC:015", "端口下线", "port offline", http.StatusBadGateway}
TerminalRespTimeout = &Error{"ISC:016", "等待5G消息终端响应超时", "5G terminal response timeout", http.StatusGatewayTimeout}
EncodingInvalid = &Error{"ISC:017", "消息编码非法", "invalid message encoding", http.StatusBadRequest}
FiveGNotEnabled = &Error{"ISC:018", "用户未开通5G消息", "5G messaging not enabled", http.StatusOK}
MMSDownloadTimeout = &Error{"ISC:019", "彩信下发成功,下载超时", "MMS delivered, download timeout", http.StatusOK}
TerminalStorageFull = &Error{"ISC:020", "终端存储空间满", "terminal storage full", http.StatusOK}
MMSFallbackDelayed = &Error{"ISC:021", "回落彩信延迟获取", "fallback MMS delayed", http.StatusOK}
MMSNotSupported = &Error{"ISC:022", "不支持彩信", "MMS not supported", http.StatusOK}
NumberingDataError = &Error{"ISC:023", "码号局数据错误", "numbering plan data error", http.StatusBadGateway}
TerminalFailure = &Error{"ISC:024", "短信已下发,但是终端故障", "delivered but terminal failure", http.StatusOK}
CarrierUnknown = &Error{"ISC:025", "找不到归属运营商,可能是新号段", "carrier unknown, possibly new number segment", http.StatusBadRequest}
MMSReportUnrecognized = &Error{"ISC:026", "无法识别彩信回执", "unrecognized MMS report", http.StatusBadGateway}
EmptyNumber = &Error{"ISC:027", "空号", "empty number", http.StatusBadRequest}
// ---- 路由与内容合规(029-043,权威码表)----
NoChannelRoute = &Error{"ISC:029", "无通道路由", "no channel route", http.StatusServiceUnavailable}
ChannelRejected = &Error{"ISC:030", "通道拒绝", "channel rejected", http.StatusForbidden}
ContentNonCompliant = &Error{"ISC:031", "内容不合规拦截", "non-compliant content blocked", http.StatusForbidden}
SendLimited = &Error{"ISC:032", "发送限制", "send limit exceeded", http.StatusTooManyRequests}
TextTooLong = &Error{"ISC:033", "超出账号设置的最大文本长度", "text exceeds account max length", http.StatusBadRequest}
DailyLimitExceeded = &Error{"ISC:034", "超出账号每天发送量限制", "account daily limit exceeded", http.StatusTooManyRequests}
CreditLimitExceeded = &Error{"ISC:035", "超出账号授信额限制", "account credit limit exceeded", http.StatusPaymentRequired}
NightRateLimited = &Error{"ISC:040", "夜间频控", "nightly rate control", http.StatusTooManyRequests}
FiveGBlocked = &Error{"ISC:043", "5G消息拦截", "5G message blocked", http.StatusForbidden}
BlockedRegion = &Error{"ISC:036", "地区屏蔽", "region blocked", http.StatusForbidden}
AuditStatusConflict = &Error{"ISC:037", "审核状态冲突(非待审)", "audit status conflict", http.StatusConflict}
TaskStatusConflict = &Error{"ISC:038", "任务状态冲突(不可取消/改期)", "task status conflict", http.StatusConflict}
// ---- 通用请求错误(400 段,段值与 HTTP 语义对齐)----
InvalidParam = &Error{"ISC:400", "参数错误", "invalid parameter", http.StatusBadRequest}
Unauthorized = &Error{"ISC:401", "未认证", "unauthorized", http.StatusUnauthorized}
TokenExpired = &Error{"ISC:402", "Token 已过期", "token expired", http.StatusUnauthorized}
Forbidden = &Error{"ISC:403", "无权限", "forbidden", http.StatusForbidden}
NotFound = &Error{"ISC:404", "资源不存在", "not found", http.StatusNotFound}
MethodNotAllowed = &Error{"ISC:405", "方法不允许", "method not allowed", http.StatusMethodNotAllowed}
RateLimited = &Error{"ISC:429", "请求过于频繁", "rate limited", http.StatusTooManyRequests}
// ---- 系统错误(500 段,500 语义为权威码表定义)----
InternalError = &Error{"ISC:500", "其他错误,需要人工核查", "other error, manual review required", http.StatusInternalServerError}
DBError = &Error{"ISC:501", "数据库错误", "database error", http.StatusInternalServerError}
CacheError = &Error{"ISC:502", "缓存错误", "cache error", http.StatusInternalServerError}
QueueError = &Error{"ISC:503", "消息队列错误", "message queue error", http.StatusInternalServerError}
ServiceUnavailable = &Error{"ISC:504", "服务暂不可用", "service unavailable", http.StatusServiceUnavailable}
)
// registry 全量注册(ByCode 查询)。
var registry = func() map[string]*Error {
all := []*Error{
OK,
// 准入
GatewayError, AccountDisabled, SignatureDisabled, SignatureInvalid,
ChannelInvalid, Blacklist, Arrears, SMSCInternalError,
// 回执与终端
ReportTimeout, UserOffline, UserSuspended, NoRoutePortability,
UserOutOfService, PortOffline, TerminalRespTimeout, EncodingInvalid,
FiveGNotEnabled, MMSDownloadTimeout, TerminalStorageFull, MMSFallbackDelayed,
MMSNotSupported, NumberingDataError, TerminalFailure, CarrierUnknown,
MMSReportUnrecognized, EmptyNumber,
// 路由与内容
NoChannelRoute, ChannelRejected, ContentNonCompliant, SendLimited,
TextTooLong, DailyLimitExceeded, CreditLimitExceeded, NightRateLimited, FiveGBlocked,
BlockedRegion,
// 审核与任务(Day 43)
AuditStatusConflict, TaskStatusConflict,
// 通用
InvalidParam, Unauthorized, TokenExpired, Forbidden, NotFound,
MethodNotAllowed, RateLimited,
// 系统
InternalError, DBError, CacheError, QueueError, ServiceUnavailable,
}
m := make(map[string]*Error, len(all))
for _, e := range all {
m[e.Code] = e
}
return m
}()
// ByCode 按错误码查询(未知码返回 InternalError)。
func ByCode(code string) *Error {
if e, ok := registry[code]; ok {
return e
}
return InternalError
}
// All 返回全部预定义错误(管理接口/迁移种子/对账用)。
func All() []*Error {
out := make([]*Error, 0, len(registry))
for _, e := range registry {
out = append(out, e)
}
return out
}