错误码明细
本页汇总当前服务已定义并可见的错误码,按来源分层维护。
公共基础错误码
来源:github.com/openimsdk/tools/errs。
| errCode | 名称 | 说明 |
|---|---|---|
| 500 | ServerInternalError | 服务内部错误 |
| 1001 | ArgsError | 参数错误 |
| 1002 | NoPermissionError | 权限不足 |
| 1003 | DuplicateKeyError | 唯一键冲突 |
| 1004 | RecordNotFoundError | 记录不存在 |
| 1501 | TokenExpiredError | Token 已过期 |
| 1502 | TokenInvalidError | Token 无效 |
| 1503 | TokenMalformedError | Token 格式错误 |
| 1504 | TokenNotValidYetError | Token 未生效 |
| 1505 | TokenUnknownError | Token 未知错误 |
| 1506 | TokenKickedError | Token 已被踢下线 |
| 1507 | TokenNotExistError | Token 不存在 |
| 1520 | OrgUserNoPermissionError | 组织用户权限不足 |
Chat 业务错误码
来源:pkg/eerrs/predefine.go。
| errCode | 名称 | 说明 |
|---|---|---|
| 20001 | PasswordError | 密码错误 |
| 20002 | AccountNotFound | 账号不存在 |
| 20003 | PhoneAlreadyRegister | 手机号已注册 |
| 20004 | AccountAlreadyRegister | 账号已注册 |
| 20005 | VerifyCodeSendFrequently | 验证码发送过于频繁 |
| 20006 | VerifyCodeNotMatch | 验证码不匹配 |
| 20007 | VerifyCodeExpired | 验证码已过期 |
| 20008 | VerifyCodeMaxCount | 验证码校验次数超限 |
| 20009 | VerifyCodeUsed | 验证码已使用 |
| 20010 | InvitationCodeUsed | 邀请码已使用 |
| 20011 | InvitationNotFound | 邀请码不存在 |
| 20012 | Forbidden | 禁止访问/操作 |
| 20013 | RefuseFriend | 拒绝好友操作 |
| 20014 | EmailAlreadyRegister | 邮箱已注册 |
| 20101 | ErrTokenNotExist | 业务侧 Token 不存在 |
外部透传错误码
当调用外部 IM API 失败时,系统会将对端返回的错误码透传到 errCode。
- 这类错误码不固定,取决于上游服务返回。
- 建议联调时结合
errMsg与errDlt一并排查。 - 上游错误码文档(OpenIM Server):https://docs.openim.io/restapi/errcode
说明:该链接主要用于排障和深度定位,不作为普通调用方的必读内容。 对调用方而言,优先按本页的统一错误处理规则处理即可。
处理建议
errCode = 0:按成功分支读取data。errCode != 0:按失败分支处理,优先展示errMsg,日志落errDlt。- 对重试型调用,建议仅对白名单错误码做重试,避免无意义重放。