常见错误代码

大约 6 分钟

常见错误代码

本文介绍环信即时通讯 IM SDK 中接口调用或者回调中的错误码。可以根据具体错误码判断具体错误原因。

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

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

错误码
错误信息描述和可能原因
0REQUEST_SUCCESS提示操作成功,没有错误。
-1REQUEST_TIMEOUT请求服务超时。
-2REQUEST_UNKNOWN默认未区分类型的错误。
-3REQUEST_PARAMETER_ERROR参数错误。
-4REQUEST_ABORT取消请求。
1WEBIM_CONNCTION_OPEN_ERROR登录失败:获取 token 接口请求失败或 Token 无效。
2WEBIM_CONNCTION_AUTH_ERROR登录鉴权失败。
12WEBIM_CONNCTION_GETROSTER_ERROR获取 Chat token 失败:通过 Agora token 置换 Chat token 失败。
16WEBIM_CONNCTION_DISCONNECTEDWebSocket 断开连接:由于断网等原因 WebSocket 已经断开。
17WEBIM_CONNCTION_AJAX_ERROR服务请求的通用错误:请求服务器未成功时的默认错误。
27WEBIM_CONNCTION_APPKEY_NOT_ASSIGN_ERROR未设置 App Key:设置的 App Key 错误,登录时会报此错误。
28WEBIM_CONNCTION_TOKEN_NOT_ASSIGN_ERROR未传 token:调用 API 时没有携带 token,一般没登录时调用 API 会提示这个错误。
31WEBIM_CONNCTION_CALLBACK_INNER_ERROR消息发送回调函数内部错误:在接收消息的回调及后续处理的函数中有错误。
32WEBIM_CONNCTION_CLIENT_OFFLINE当前用户未登录。
39WEBIM_CONNECTION_CLOSED退出或未登录:未登录或掉线后发送消息。
40WEBIM_CONNECTION_ERROR用户鉴权失败。
50MAX_LIMIT达到上限,例如 Reaction 数量已达到限制、翻译用量达到上限、应用的日活跃用户数(DAU)超限、在线用户数量超限和月活跃用户数(MAU)。
51MESSAGE_NOT_FOUND没查到消息,如:没有查询到要举报的消息。
52NO_PERMISSION用户对当前操作没有权限。
53OPERATION_UNSUPPORTED不支持的操作。
101WEBIM_UPLOADFILE_ERROR上传文件失败:如文件过大等。
102WEBIM_UPLOADFILE_NO_LOGIN上传文件的请求中未携带用户 token:如未登录就上传文件。
200WEBIM_DOWNLOADFILE_ERROR下载文件失败:如超时、网络错误。
204USER_NOT_FOUND用户不存在,如创建群拉人时不存在的用户报错。
205MESSAGE_PARAMETER_ERROR消息参数错误。如撤回消息时未传消息 ID 或者发送消息时未传消息接收方的用户 ID。
206WEBIM_CONNCTION_USER_LOGIN_ANOTHER_DEVICE用户在其他设备登录:如果没有开启多设备登录,则在其他设备登录会将当前登录的设备踢下线,用户会收到此错误。
207WEBIM_CONNCTION_USER_REMOVED用户已经被注销:如果登录用户的 ID 被管理员从管理后台删除则会收到此错误。
208WEBIM_USER_ALREADY_LOGIN用户已登录。单设备登录时,若调用 open 方法用户已经登录,会提示该错误。
216WEBIM_CONNCTION_USER_KICKED_BY_CHANGE_PASSWORD用户密码更新:当前登录的用户密码被修改后,当前登录会断开并提示该错误。
217WEBIM_CONNCTION_USER_KICKED_BY_OTHER_DEVICE用户被踢下线:开启多设备登录后,如果用户在其他设备上调用 API 或者通过管理后台踢出当前设备登录的 ID,SDK 会提示该错误。
219USER_MUTED_BY_ADMIN用户被全局禁言:在管理后台禁言了此用户后,该用户发送消息时会提示该错误。
221USER_NOT_FRIEND非好友禁止发消息:开通非好友禁止发消息后,非好友间发消息提示此错误。该功能可在控制台开通。
500SERVER_BUSY服务器忙碌。
501MESSAGE_INCLUDE_ILLEGAL_CONTENT消息含有非法内容:如果消息被过滤系统识别为非法消息时返回该错误。
502MESSAGE_EXTERNAL_LOGIC_BLOCKED消息被拦截:开通反垃圾服务后,消息被拦截报此错误。
503SERVER_UNKNOWN_ERROR消息发送失败未知错误:服务端返回的错误信息超出 SDK 处理范围。
504MESSAGE_RECALL_TIME_LIMIT撤回消息时超出限定时间。
505SERVICE_NOT_ENABLED服务未开启:要使用的某些功能未开通。
506SERVICE_NOT_ALLOW_MESSAGING用户未在白名单中:群组或聊天室开启全员禁言时,若用户未在白名单中发送消息时提示该错误。
507SERVICE_NOT_ALLOW_MESSAGING_MUTE当前用户被禁言:在群组或者聊天室中被禁言后发消息报此错误。
508MESSAGE_MODERATION_BLOCKED第三方内容审核服务的消息审核结果为“拒绝”时提示该错误。
509MESSAGE_CURRENT_LIMITING单个用户 ID 发送消息超出频率限制。默认情况下,SDK 对单个用户 ID 发送群消息未做频率限制。如果你联系了环信商务设置了该限制,一旦在在单聊、群聊或聊天室中单个用户的消息发送频率超过设定的上限,则会提示该错误。
510MESSAGE_WEBSOCKET_DISCONNECTED消息发送失败,例如网络断开、重连失败等情况下导致发送失败。
511MESSAGE_SIZE_LIMIT消息体大小超过限制。关于各端消息体大小的限制,详见消息管理概述中的描述
512MESSAGE_SEND_TIMEOUT发送消息超时。例如,发消息时连接断开,会提示该错误。
601GROUP_ALREADY_JOINED已在群组内:当前用户已在该群组中。
602GROUP_NOT_JOINED不在群组内:用户发送群消息或进行群操作时未加入该群组。
603PERMISSION_DENIED用户无权限:例如,如果用户被添加到黑名单后,发送消息时会提示该错误。其他报错情况包括用户修改其他用户发出的消息、修改其他用户设置的群成员属性以及普通群成员试图解散子区(仅子区所在群组的群主和群管理员有权解散子区)。
604WEBIM_LOAD_MSG_ERROR消息回调函数内部错误。
605GROUP_NOT_EXIST群组不存在:发送消息时群组 ID 不正确。
606GROUP_MEMBERS_FULL群组已满:群组成员数量已达到创建群组时设置的最大人数。
607GROUP_MEMBERS_LIMIT创建群组时设置的群成员最大数量超过 IM 套餐包中的上限。各版本的即时通讯套餐包支持的群组成员最大数量,详见产品价格
609GROUP_MEMBER_ATTRIBUTES_SET_FAILED群成员属性设置失败。
700REST_PARAMS_STATUS用户 token 或 App Key 不存在或不正确导致 API 调用失败。
702CHATROOM_NOT_JOINED被操作的人员不在聊天室。
704CHATROOM_MEMBERS_FULL聊天室已满:聊天室已经达到人数上限。
705CHATROOM_NOT_EXIST聊天室不存在:尝试对不存在的聊天室进行操作时提示该错误。
800LOCAL_DB_OPERATION_FAILED本地数据库操作失败。
999SDK_RUNTIME_ERRORWebsocket 发送消息错误。
1100PRESENCE_PARAM_EXCEED发布自定义在线状态时,参数长度超出限制。
1101REACTION_ALREADY_ADDEDReaction 重复添加。
1102REACTION_CREATING创建 Reaction 时,其他人正在创建。
1103REACTION_OPERATION_IS_ILLEGAL用户对该 Reaction 没有操作权限:没有添加过该 Reaction 的用户进行删除操作,或者单聊消息非发送者和非接受者进行添加 Reaction 操作。
1200TRANSLATION_NOT_VALID传入的语言 code 不合法。
1201TRANSLATION_TEXT_TOO_LONG翻译的文本过长。
1204TRANSLATION_FAILED获取翻译服务失败。
1300THREAD_NOT_EXIST子区不存在:未找到该子区。
1301THREAD_ALREADY_EXIST该消息 ID 下子区已存在,重复添加子区。
1302MODIFY_MESSAGE_NOT_EXIST修改的消息不存在。
1304MODIFY_MESSAGE_FAILED消息修改失败。