常见错误代码

大约 11 分钟

常见错误代码

本文主要介绍在调用环信即时通讯的接口过程中，SDK 返回的错误码和错误信息。

你可以根据如下错误码及错误信息了解出错的可能原因，并采取响应措施。

环信即时通讯 SDK 在运行过程中，可能通过如下方式返回错误码和错误信息：

  • 调用方法失败时的返回值。
  • 通过 onError 回调报告错误码。

例如，注册时用户返回已存在的错误可以这样检测：

SDKClient.Instance.Login(username, passwd,
    callback: new CallBack(
        onSuccess: () =>
        {
        },
        onError: (code, desc) =>
        {
            //注册失败，回调函数会返回错误码和错误描述
            //如：code为：USER_ALREADY_EXIST(203)
            //desc : User already exist.
        }
    )
);

错误码定义如下：

错误码错误信息描述和可能原因
0EM_NO_ERROR操作成功。
1GENERAL_ERRORSDK 或请求相关的默认错误，未区分具体错误类型：例如，SDK 内部未正确初始化，或者请求服务器时未识别出具体原因的错误。
2NETWORK_ERROR网络错误：无网络服务时会回调此错误，表示 SDK 与服务器的连接已断开。
3DATABASE_ERROR数据库操作失败：打开本地数据库失败。
4EXCEED_SERVICE_LIMIT超过服务限制：超过当前服务版本的数量限制，例如，创建的用户 ID 数量超过购买服务的限制时提示该错误。
8APP_ACTIVE_NUMBER_REACH_LIMITATION应用程序的日活跃用户数量（DAU）或月活跃用户数量（MAU）达到上限。
100INVALID_APP_KEYApp Key 不合法：用户的 App Key 格式不正确。可在环信控制台open in new window的 应用详情 页面查看 App Key。
101INVALID_USER_NAME用户 ID 不正确：一般情况下，用户 ID 为空时提示该错误，例如，邀请好友时 username 参数为空字符。
102INVALID_PASSWORD用户密码不正确：登录时提供的密码为空或不正确。
104INVALID_TOKEN用户 token 不正确：登录时提供的 token 为空或不正确。
105USER_NAME_TOO_LONG用户 ID 过长：用户 ID 长度不能超过 64 字节。
108TOKEN_EXPIRED用户 token 已过期：超出 token 有效期。
109TOKEN_WILL_EXPIRE用户 token 即将过期：超出 token 的一半有效期时会开始回调此错误码。
110INVALID_PARAM参数无效。
200USER_ALREADY_LOGIN用户已登录：该用户 ID 已经登录。
201USER_NOT_LOGIN用户未登录：例如，如果未登录成功时发送消息或者使用群组操作的 API，SDK 会提示该错误。
202USER_AUTHENTICATION_FAILED用户鉴权失败：
- 若使用用户 ID 和密码登录，用户 ID 或密码不正确时会上报改错误；
- 若使用用户 ID 和用户 token 登录，一般为用户 token 无效或已过期。
203USER_ALREADY_EXIST用户已经存在：注册用户时，传入的的用户 ID 已经存在会提示该错误。
204USER_NOT_FOUND用户不存在：例如，登录或获取用户会话列表时，用户 ID 不存在。
205USER_ILLEGAL_ARGUMENT用户参数不正确：例如，创建用户或更新用户属性时，用户 ID 为空或无效。
206USER_LOGIN_ANOTHER_DEVICE用户在其他设备登录：如果未开启多设备登录，则在其他设备登录会将当前登录设备踢下线，用户会在当前设备收到该错误。
207USER_REMOVED用户已被注销：当前的登录用户 ID 从环信控制台open in new window删除会收到该错误。
208USER_REG_FAILED用户注册失败：例如，注册用户之前未开启开放注册功能等原因。
210USER_PERMISSION_DENIED用户无权限：例如，如果用户被添加到黑名单后，发送消息时会提示该错误。其他报错情况包括用户修改其他用户发出的消息、修改其他用户设置的群成员属性以及普通群成员试图解散子区（仅子区所在群组的群主和群管理员有权解散子区）。
213USER_BIND_ANOTHER_DEVICE用户已在其他设备登录：在单设备登录场景中，默认情况下，后登录的设备会踢掉当前设备的登录。若设置为先登录的设备优先，则后登录设备登录失败并提示该错误。
214USER_LOGIN_TOO_MANY_DEVICES用户登录设备数超过限制：该错误在多设备自动登录场景中且打开不踢掉其他设备上的登录的开关时超过登录设备数量的限制才会出现。例如，用户最多可同时登录 4 台设备， A（开启了自动登录）、B、C 和 D。最初，用户在这四个设备上均为登录状态，但由于网络连接原因登出了设备 A，然后手动登录了设备 E。这种情况下，设备 A 的网络恢复正常时会自动登录，这时登录失败且提示该错误。
215USER_MUTED用户在群组或聊天室中被禁言：用户被禁言后发送消息时提示该错误。
216USER_KICKED_BY_CHANGE_PASSWORD用户密码更新：当前登录的用户密码被修改后，当前登录会断开并提示该错误。
217USER_KICKED_BY_OTHER_DEVICE用户被踢下线：开启多设备服务后，如果用户在其他设备上通过调用 API 或者管理后台将当前设备登录的 ID 强制退出登录，SDK 会提示该错误。
218USER_ALREADY_LOGIN_ANOTHER其他用户已登录：用户在同一台设备上退出登录前又使用另一账户登录。
219USER_MUTED_BY_ADMIN用户被禁言：用户被全局禁言后发送消息时提示该错误。
220USER_DEVICE_CHANGED用户的登录设备与上次不一致。该错误在单设备自动登录场景中且打开不踢掉其他设备上的登录的开关时才会出现。例如，用户自动登录设备 A，之后手动登录设备 B。用户再次自动登录设备 A 时登录失败且提示该错误。
221USER_NOT_FRIEND非好友禁止发消息：开通非好友禁止发消息后，非好友间发消息提示此错误。你可以在环信控制台open in new window的即时通讯 > 服务概览页面的设置区域开启好友关系检查功能。
300SERVER_NOT_REACHABLE服务器不可达：例如，发送或撤回消息时，如果 SDK 与消息服务器未保持连接，会返回该错误；操作群组、好友等请求时因网络不稳定导致失败，也会返回该错误。
301SERVER_TIMEOUT请求服务超时：如果调用 API 在特定时间内服务器未响应则返回该错误，一般为 30 秒或 60 秒。
302SERVER_BUSY服务器忙碌：服务器当前忙碌会返回该错误，建议稍后再尝试请求。
303SERVER_UNKNOWN_ERROR服务请求的通用错误：请求服务器未成功时的默认错误。
304SERVER_GET_DNSLIST_FAILED获取服务器配置信息失败：SDK 获取当前应用的服务器配置时失败。
305SERVER_SERVICE_RESTRICTED当前 app 被禁用：若在 app 被禁用时调用 API 会返回该错误。
400FILE_NOT_FOUND文件未找到：例如，用户获取不到日志文件，或者下载附件失败时提示该错误。
401FILE_INVALID文件异常：例如，当上传消息附件或者群组共享文件时可能会提示该错误。
402FILE_UPLOAD_FAILED上传文件错误：例如，上传消息附件失败时提示该错误。
403FILE_DOWNLOAD_FAILED下载文件错误：例如，下载消息附件失败时提示该错误。
404FILE_DELETE_FAILED删除日志文件错误：通过 API 获取日志文件时会将旧的日志文件删除，然后生成新的日志文件。如果删除旧日志文件失败会提示该错误。
405FILE_TOO_LARGE文件太大：例如，消息附件或群共享文件超过文件大小限制时提示该错误。
406FILE_CONTENT_IMPROPER文件内容不合规：例如，消息附件或群共享文件内容不合规时提示该错误。
500MESSAGE_INVALID消息异常：例如，发送消息时，若消息对象或消息 ID 为空或者消息的发送方 ID 与当前登录 ID 不同则会提示该错误。
501MESSAGE_INCLUDE_ILLEGAL_CONTENT消息含有非法内容：如果消息被过滤系统识别为非法消息时返回该错误。
502MESSAGE_SEND_TRAFFIC_LIMIT消息限流：发送消息过快时提示该错误，建议降低发送频率或者减少消息内容的大小。
504MESSAGE_RECALL_TIME_LIMIT消息撤回超时错误：消息撤回超过时间限制时会提示该错误。
505SERVICE_NOT_ENABLED服务未开启：尝试使用某些未开通的功能时提示该错误。
506MESSAGE_EXPIRED消息已过期：发送群组消息的已读回执时若超过时间限制 (默认 3 天) 会提示该错误。
507MESSAGE_ILLEGAL_WHITELIST用户未在白名单中：如果群组聊天室开启全员禁言，且用户未在白名单中发送消息时提示该错误。
508MESSAGE_EXTERNAL_LOGIC_BLOCKED发送前回调拦截：发送的消息被用户自己的服务器定义的规则拦截掉时提示该错误。
509MESSAGE_CURRENT_LIMITING单个用户 ID 发送消息超出频率限制。默认情况下，SDK 对单个用户 ID 发送群消息未做频率限制。如果你联系了环信商务设置了该限制，一旦在在单聊、群聊或聊天室中单个用户的消息发送频率超过设定的上限，则会提示该错误。
510MESSAGE_SIZE_LIMIT发送消息时消息体大小超过上限。
511MESSAGE_EDIT_FAILED消息修改失败。
600GROUP_INVALID_ID群组 ID 异常：使用群组相关 API，提供的群组 ID 为空或无效。
601GROUP_ALREADY_JOINED已在该群组中：例如，调用加入群组的 API 时如果已经在该群组中则提示该错误。
602GROUP_NOT_JOINED未加入该群组：尝试在未加入的群组中发送消息或进行群组操作时提示该错误。
603GROUP_PERMISSION_DENIED无权限的群组操作：例如，群组普通成员没有权限设置群组管理员。
604GROUP_MEMBERS_FULL群组已满：群组成员数量已达到创建群组时设置的最大人数。
605GROUP_SHARED_FILE_INVALIDID群组共享文件 ID 不合法。
606GROUP_NOT_EXIST群组不存在：尝试对不存在的群组进行操作时提示该错误。
607GROUP_DISABLED群组被禁用。
608GROUP_NAME_VIOLATION群组名称无效。
609GROUP_MEMBER_ATTRIBUTES_REACH_LIMIT群组成员自定义属性个数达到上限。
610GROUP_MEMBER_ATTRIBUTES_UPDATE_FAILED设置群成员自定义属性失败。
611GROUP_MEMBER_ATTRIBUTES_KEY_REACH_LIMIT设置的群成员自定义属性 key 长度（不能超过 16 字节）超限。
612GROUP_MEMBER_ATTRIBUTES_VALUE_REACH_LIMIT设置的群成员自定义属性 value 长度（不能超过 512 字节）超限。
700CHATROOM_INVALID_ID聊天室 ID 无效：调用聊天室相关 API，传入的聊天室 ID 为空时提示该错误。
701CHATROOM_ALREADY_JOINED已在该聊天室中：调用加入聊天室的 API 时如果已经在该聊天室中则提示该错误。
702CHATROOM_NOT_JOINED未加入该聊天室：用户在未加入的聊天室中发送消息或进行聊天室操作时提示该错误。
703CHATROOM_PERMISSION_DENIED无权限的聊天室操作：例如，聊天室普通成员没有权限设置聊天室管理员。
704CHATROOM_MEMBERS_FULL聊天室已满：聊天室成员数量已达到创建聊天室时设置的最大人数。
705CHATROOM_NOT_EXIST聊天室不存在：尝试对不存在的聊天室进行操作时提示该错误。
706CHATROOM_OWNER_NOT_ALLOW_LEAVE聊天室所有者不允许离开聊天室。若初始化时，Options#IsRoomOwnerLeaveAllowed 参数设置为 false，聊天室所有者调用 LeaveRoom 方法离开聊天室时会提示该错误。
900USERINFO_USERCOUNT_EXCEED获取用户属性的用户个数超过 100。
901USERINFO_DATALENGTH_EXCEED设置的用户属性太长。单个用户的所有属性数据不能超过 2 KB，单个 app 所有用户属性数据不能超过 10 GB。
1000CONTACT_ADD_FAILED添加联系人失败。
1001CONTACT_REACH_LIMIT邀请者的联系人数量已达到上限。
1002CONTACT_REACH_LIMIT_PEER受邀者的联系人数量已达到上限。
1100PRESENCE_PARAM_LENGTH_EXCEED调用 Presence 相关方法时参数长度超出限制。
1101PRESENCE_CANNOT_SUBSCRIBE_YOURSELF不能订阅你自己的状态。
1110TRANSLATE_PARAM_INVALID翻译参数错误。
1111TRANSLATE_SERVICE_NOT_ENABLE翻译服务未启用。使用翻译服务前，应在环信控制台open in new window开启该服务。
1112TRANSLATE_USAGE_LIMIT翻译用量达到上限。
1113TRANSLATE_MESSAGE_FAIL消息翻译失败。
1200THIRD_MODERATION_FAILED第三方内容审核服务的消息审核结果为“拒绝”。
1299THIRD_DEFAULT_FAILED除第三方内容审核服务的其他服务的消息审核结果为“拒绝”。
1300REACTION_REACH_LIMIT该消息的 Reaction 数量已达到限制。
1301REACTION_HAS_BEEN_OPERATED用户已添加该 Reaction，不能重复添加。
1302REACTION_OPERATION_IS_ILLEGAL用户对该 Reaction 没有操作权限。例如，未添加过该 Reaction 的用户进行删除操作，或者既非单聊消息的发送方也不是非接收方的用户对消息添加 Reaction。
1400THREAD_NOT_EXIST该子区不存在。
1401THREAD_ALREADY_EXIST该消息 ID 下子区已存在，不能重复添加。
1402THREAD_CREATE_MESSAGE_ILLEGAL创建子区的消息无效：例如，创建子区时父消息被撤回了或者无法使用。
环信 IM 文档 Version: 1.0.0 ©️环信