Android API 常见错误码

更新时间:2021-12-31 该文档已不再维护,请看新版 3.X 文档。

新版文档见:Android 常见错误代码


在 Android SDK 中异常机制通过错误码来判断具体错误,可以根据具体错误码查阅错误原因。

Android 中错误码的类为 EMError。

如:注册时用户返回已存在的错误可以这样检测:EMError.USER_ALREADY_EXISTS

具体详情见V3.X Java Doc

错误码 错误信息 错误描述 可能原因
0 EM_NO_ERROR 操作成功 提示操作成功。
1 GENERAL_ERROR 默认未区分类型的错误提示 SDK 内部未正确初始化,或者请求服务器时未识别出具体原因的错误。
2 NETWORK_ERROR 网络错误无网络服务时会回调此错误,表示 SDK 与服务器的连接已断开。
4 EXCEED_SERVICE_LIMIT 超过服务限制超过服务版本的数量限制,比如创建的用户 ID 数量超过购买服务的限制时提示该错误。
5 SERVICE_ARREARAGES 服务欠费该错误码已废弃。
100 INVALID_APP_KEY App Key 不合法用户的 App Key 格式不正确。
101 INVALID_USER_NAME 用户 ID 不正确一般是用户 ID 为空时提示该错误,比如使用邀请好友 API 时 username 参数为空字符。
102 INVALID_PASSWORD 用户密码不正确登录时提供的密码为空或不正确。
103 INVALID_URL URL 不正确该错误码已废弃。
104 INVALID_TOKEN 用户 token 不正确登录时提供的 token 为空或不正确。
105 USER_NAME_TOO_LONG 用户名过长用户名长度限制 64 个字节。
108 TOKEN_EXPIRED token 已过期超出 token 有效期时间。
109 TOKEN_WILL_EXPIRE token 即将过期超出 token 有效期一半时间时会开始回调此错误码。
200 USER_ALREADY_LOGIN 用户已经登录同一个用户 ID 已经登录。
201 USER_NOT_LOGIN 用户未登录如果未登录成功时发送消息,或者使用群组操作的 API,SDK 会提示该错误。
202 USER_AUTHENTICATION_FAILED 用户鉴权失败一般是 token 鉴权失败或者 token 已经过期。
203 USER_ALREADY_EXIST 用户已经存在注册用户 ID 时如果该 ID 已经存在会提示该错误。
204 USER_NOT_FOUND 用户不存在比如登录或者获取用户会话列表时用户 ID 不存在。
205 USER_ILLEGAL_ARGUMENT 用户参数不正确比如创建用户 ID 时不符合格式要求, 或者更新用户属性时用户参数为空等。
206 USER_LOGIN_ANOTHER_DEVICE 用户在其他设备登录如果未开启多设备登录,则在其他设备登录会将当前登录的设备踢下线,用户会收到此错误。
207 USER_REMOVED 用户已经被注销如果登录用户被从管理后台删除 ID 则会收到此错误。
208 USER_REG_FAILED 用户注册失败注册用户 ID 时失败,比如未开启开放注册功能等原因。
209 PUSH_UPDATECONFIGS_FAILED 更新推送配置错误用户更新推送昵称,设置免推送配置时失败。
210 USER_PERMISSION_DENIED 用户无权限例如如果用户被封禁,发送消息时会提示该错误。
211 USER_BINDDEVICETOKEN_FAILED 用户更新推送 token 错误该错误码已废弃。
212 USER_UNBIND_DEVICETOKEN_FAILED 用户更新推送 token 错误该错误码已废弃。
213 USER_BIND_ANOTHER_DEVICE 用户已经在另外设备登录如果用户设置为先登录的设备优先,则后登录设备登录失败并提示该错误。
214 USER_LOGIN_TOO_MANY_DEVICES 用户登录设备数超过限制用户同一 ID 登录设备数量超过限制提示该错误。
215 USER_MUTED 用户在群组聊天室中被禁言用户被禁言后发送消息时提示该错误。
216 USER_KICKED_BY_CHANGE_PASSWORD 用户密码更新当前登录的用户密码被修改后,当前登录会断开并提示该错误。
217 USER_KICKED_BY_OTHER_DEVICE 用户被踢下线开启多设备后,如果用户在其他设备上通过调用 API 或者管理后台将当前设备登录的 ID 强制退出登录,SDK 会提示该错误。
218 USER_ALREADY_LOGIN_ANOTHER 其他用户已登录SDK 未退出登录前又被使用不同的账户登录。
219 USER_MUTED_BY_ADMIN 用户被禁言用户在当前 app key 被禁言后发送消息时提示该错误。
220 USER_DEVICE_CHANGED 用户登录设备与上次不一致用户登录设备与上次登录设备不一致,需要用户重新登录,注意:默认会允许用户登录,踢掉另一个设备上的登录,此 error 在打开不踢掉另外设备上的登录开关后才会生效。
300 SERVER_NOT_REACHABLE 请求服务失败发送或撤回消息时,如果 SDK 与消息服务器未保持连接,会返回该错误;操作群组、好友等请求时,如果因网络连接太差而不成功,也会返回该错误。
301 SERVER_TIMEOUT 请求服务超时如果调用 API 在特定时间内服务器未响应则返回该错误,一般是 30 秒或者 60 秒。
302 SERVER_BUSY 服务器忙碌服务器当前忙碌会返回该错误,建议稍后再尝试请求。
303 SERVER_UNKNOWN_ERROR 服务请求的通用错误码当请求服务器未成功时的默认错误,该错误发生情况较多,需要根据日志进一步排查。
304 SERVER_GET_DNSLIST_FAILED 获取服务器配置信息错误SDK 获取当前应用的服务器配置时失败。
305 SERVER_SERVICE_RESTRICTED 当前 app 被禁用如果 app 因为某种原因被禁用时会返回该错误。
400 FILE_NOT_FOUND 文件未找到当用户获取不到日志文件,或者下载附件失败时提示该错误。
401 FILE_INVALID 文件异常当上传消息附件或者群组共享文件时可能会提示该错误。
402 FILE_UPLOAD_FAILED 上传文件错误上传消息附件失败时提示该错误。
403 FILE_DOWNLOAD_FAILED 下载文件错误下载消息附件失败时提示该错误。
404 FILE_DELETE_FAILED 删除文件错误通过 API 获取日志文件时会将旧的日志文件删除,如果删除失败提示该错误。
405 FILE_TOO_LARGE 文件太大消息附件或群共享文件超过文件大小限制时提示该错误。
406 FILE_CONTENT_IMPROPER 文件内容不合规消息附件或群共享文件内容不合规时提示该错误。
500 MESSAGE_INVALID 消息异常错误如果要发送的消息为空,或者消息 ID 为空,或者消息的发送方 ID 与当前登录 ID 不同则会提示该错误。
501 MESSAGE_INCLUDE_ILLEGAL_CONTENT 消息含有非法内容如果消息被过滤系统识别为非法消息时返回该错误。
502 MESSAGE_SEND_TRAFFIC_LIMIT 消息限流发送消息过快时提示该错误,建议降低频率或者减少消息内容的大小。
503 MESSAGE_ENCRYPTION_ERROR 消息加密错误该错误码已废弃。
504 MESSAGE_RECALL_TIME_LIMIT 消息撤回超时错误如果超过消息撤回允许的时间尝试撤回时提示该错误。
505 SERVICE_NOT_ENABLED 服务未开启尝试使用某些未开通的功能时提示该错误。
506 MESSAGE_EXPIRED 消息已过期发送群组回执时如果已经超过时间限制 (默认 3 天) 会提示该错误。
507 MESSAGE_ILLEGAL_WHITELIST 用户未在白名单中如果群组聊天室开启全员禁言,且用户未在白名单中发送消息时提示该错误。
508 MESSAGE_EXTERNAL_LOGIC_BLOCKED 消息执行发送前回调,被用户自己的逻辑拦截发送的消息被用户自己的服务器定义的规则拦截掉时提示该错误。
600 GROUP_INVALID_ID 群组 ID 异常使用群组相关 API,提供的群组 ID 为空时提示该错误。
601 GROUP_ALREADY_JOINED 已在该群组中调用加入群组的 API 时如果已经在该群组中则提示该错误。
602 GROUP_NOT_JOINED 未加入该群组尝试在未加入的群组中发送消息或进行群组操作时提示该错误。
603 GROUP_PERMISSION_DENIED 无权限的群组操作没有权限进行群组操作,比如群组成员不能设置群组管理员。
604 GROUP_MEMBERS_FULL 群组已满群组已经达到人数上限。
605 GROUP_NOT_EXIST 群组不存在尝试对不存在的群组进行操作时提示该错误。
700 CHATROOM_INVALID_ID 聊天室 ID 异常使用聊天室相关 API,提供的聊天室 ID 为空时提示该错误。
701 CHATROOM_ALREADY_JOINED 已在该聊天室中调用加入聊天室的 API 时如果已经在该聊天室中则提示该错误。
702 CHATROOM_NOT_JOINED 未加入该聊天室尝试在未加入的聊天室中发送消息或进行聊天室操作时提示该错误。
703 CHATROOM_PERMISSION_DENIED 无权限的聊天室操作没有权限进行聊天室操作,比如聊天室成员不能设置聊天室管理员。
704 CHATROOM_MEMBERS_FULL 聊天室已满聊天室已经达到人数上限。
705 CHATROOM_NOT_EXIST 聊天室不存在尝试对不存在的聊天室进行操作时提示该错误。
900 PUSH_NOT_SUPPORT 第三方推送不支持如果用户配置的第三方推送在当前设备上不支持,会提示该错误。
901 PUSH_BIND_FAILED 绑定第三方推送 token 失败如果将第三方推送 token 上传到服务器失败时会返回该错误。
902 PUSH_UNBIND_FAILED 解绑第三方推送 token 失败如果解绑第三方推送 token 失败会提示该错误。