====== Web 常见错误代码 ======

''该文档已不再维护，新版文档见：[[ccim:web:errorcode|Web 常见错误代码]]。''

--------

本篇主要介绍环信 Web SDK 中接口调用或者回调中的错误码。可以根据具体错误码判断具体错误原因。

你可以在 listen 方法中通过 options 参数注册 onError 回调，然后通过该回调返回的参数，或其他 API 调用失败回调中返回的参数判断出错的原因。示例代码如下：

error.type === statusCode.WEBIM_CONNCTION_USER_NOT_ASSIGN_ERROR 其中 error 为回调返回的参数，statusCode 为 SDK 定义的错误信息。

^   错误码    ^    错误信息                 ^   描述             ^ 可能原因                                     ^
| 0     | WEBIM_CONNCTION_USER_NOT_ASSIGN_ERROR |未登录 | 未输入 user ID。 |
| 1   | WEBIM_CONNCTION_OPEN_ERROR | 登录失败 | 用户不存在或密码错误。 |
| 2    | WEBIM_CONNCTION_AUTH_ERROR | 鉴权失败 | SDK 未初始化或用户未登录就调用 API 进行其他操作。 |
| 12   | WEBIM_CONNCTION_GETROSTER_ERROR | 获取 Chat token 失败 | 通过 Agora token 置换 Chat token 失败。 |
| 16   | WEBIM_CONNCTION_DISCONNECTED | WebSocket 断开连接 | 在 WebSocket 断开或者未登录情况下发送消息。 |
| 17   | WEBIM_CONNCTION_AJAX_ERROR | AJAX 请求非成功状态 | 网络请求异常。 |
| 27   | WEBIM_CONNCTION_APPKEY_NOT_ASSIGN_ERROR | 未设置 App Key | 设置的 App Key 错误，调用 API 时会报此错误。 |
| 28   | WEBIM_CONNCTION_TOKEN_NOT_ASSIGN_ERROR | 未传 token | 未登录时调用 API 会报此错误。 |
| 31   | WEBIM_CONNCTION_CALLBACK_INNER_ERROR | 消息发送成功的回调函数内部错误 | 在接收消息的回调及后续处理的函数中有错误。 |
| 32   | WEBIM_CONNCTION_CLIENT_OFFLINE | 未登录就发送消息 | 用户未登录就发送消息。 |
| 39   | WEBIM_CONNECTION_CLOSED | 退出或未登录 | 未登录或掉线后发送消息。|
| 40   | WEBIM_CONNECTION_ERROR | 用户鉴权失败 | 一般是 token 鉴权失败或者 token 过期。 |
| 101  | WEBIM_UPLOADFILE_ERROR | 上传文件失败 | 如文件过大等。 |
| 102  | WEBIM_UPLOADFILE_NO_LOGIN | 未登录上传文件 | 未登录就上传文件。 |
| 200   | WEBIM_DOWNLOADFILE_ERROR | 下载文件失败 | 如超时、网络错误。|
| 206   | WEBIM_CONNCTION_USER_LOGIN_ANOTHER_DEVICE | 用户在其他设备登录 | 如果没有开启多设备登录，则在其他设备登录会将当前登录的设备踢下线，用户会收到此错误。|
| 207   | WEBIM_CONNCTION_USER_REMOVED | 用户已经被注销 | 如果登录用户的 ID 被管理员从管理后台删除则会收到此错误。|
| 216   | WEBIM_CONNCTION_USER_KICKED_BY_CHANGE_PASSWORD | 用户密码更新 | 当前登录的用户密码被修改后，当前登录会断开并提示该错误。|
| 217   | WEBIM_CONNCTION_USER_KICKED_BY_OTHER_DEVICE | 用户被踢下线 | 开启多设备登录后，如果用户在其他设备上调用 API 或者通过管理后台踢出当前设备登录的 ID，SDK 会提示该错误。|
| 501   | MESSAGE_INCLUDE_ILLEGAL_CONTENT | 敏感词 | 发送的消息包含敏感词时报此错误。|
| 502   | MESSAGE_EXTERNAL_LOGIC_BLOCKED | 消息被拦截 | 开通反垃圾服务后，消息被拦截报此错误。 |
| 503   | SERVER_UNKNOWN_ERROR | 消息发送失败未知错误 |消息发送时出现未知错误。 |
| 504   | MESSAGE_RECALL_TIME_LIMIT | 撤回消息超时 | 撤回消息时超出限定时间。 |
| 505   | SERVICE_NOT_ENABLED | 服务未开启 | 尝试使用某些未开通的功能时提示该错误。 |
| 506   | SERVICE_NOT_ALLOW_MESSAGING | 用户未在白名单中 |群组或聊天室开启全员禁言时，若用户未在白名单中发送消息时提示该错误。 |
| 507   | SERVICE_NOT_ALLOW_MESSAGING_MUTE | 被禁言 | 在群组或者聊天室中被禁言后发消息报此错误。|
| 602   | GROUP_NOT_JOINED | 不在群组内 | 用户发送群消息时未加入该群组。 |
| 603   | PERMISSION_DENIED | 用户无权限 | 例如如果用户被封禁，发送消息时会提示该错误。 |
| 604   | WEBIM_LOAD_MSG_ERROR | 消息回调函数内部错误 | 在接收消息的回调及后续处理的函数中有错误。 |
| 605   | GROUP_NOT_EXIST | 群组不存在 | 发送消息时群组 ID 不正确。 |