ZIM 错误码
注意
即时通讯产品在 2.0.0
版本(版本说明请参考 发布日志)有较大程度的更新,如果您使用的版本低于 2.0.0
,请参考 1.x.x 版本错误码 处理。
为了给开发者带来更好的体验,ZEGO 推荐开发者使用最新版本的 SDK。
概览
开发者如果使用的是最新版本的 SDK,当 SDK 运行出现网络、媒体相关等错误时,SDK 无法自动恢复,请参考本文档进行处理。
调用接口后如果返回结果 errorInfo
中存在的 code
值非零,则表示该接口调用异常。示例代码如下:
Untitled
// 监听 onerror 事件
zim.on('error', function(zim, errorInfo) {
console.error('code:' + errorInfo.code + ', message:' + errorInfo.message);
});
// 接口调用时出现错误
zim.login({ userID: '', userName: '' }, '')
.then(function() {
// 操作成功
})
.catch(function(err) {
// 操作失败
})
1
公共错误码
错误码 | 说明 | 处理建议 |
---|---|---|
0 | 执行成功。 | - |
1 | 执行失败。 | - |
6000001 | 传入参数非法,参数名称或值不对。 | 请确认参数名称和值是否正确。 |
6000002 | 未初始化 SDK。 | 请先初始化 SDK。 |
6000003 | 无效 AppID,AppID 错误或已失效。 | 请先行检查是否 AppID 输入有误,若确实无误,请联系技术支持处理。 |
6000004 | 触发 SDK 内部限频。 | 请勿高频操作。 |
6000005 | 触发后台业务限频,接口调用频率过高。 | 请勿高频率调用相关接口。 |
6000006 | 触发后台业务限频,Switch 服务器报错。 | 请联系 ZEGO 技术支持处理。 |
6000007 | ZIM 服务内部错误。 | 请联系 ZEGO 技术支持处理。 |
6000008 | ZIM 内部数据库错误。 | 请联系 ZEGO 技术支持处理。 |
6000009 | 发送请求时断开了连接。 | 请重新连接。 |
6000010 | 上传日志失败。 | 请联系 ZEGO 技术支持处理。 |
6000011 | 用户不存在。 | 请确认 userID 是否存在。 |
6000012 | 查询用户信息时,触发限频。 | 请确认:
|
6000013 | 当前套餐不支持该操作。 | 请确认您的套餐权限,详情请参考 计费说明。 |
6000015 | 超出了该 AppID 日活用户上限。 | 请升级套餐。 |
6000016 | 超出了该 AppID 月活用户上限。 | 请升级套餐。 |
登录连接相关错误码
错误码 | 说明 | 处理建议 |
---|---|---|
6000101 | 登录失败,Token 无效或 AppID 错误。 | 请先行检查登录时传入的参数是否准确。 |
6000102 | 内部原因,致使登录失败。 | 请联系 ZEGO 技术支持处理。 |
6000103 | Token 无效。 | 请调用 renewToken 接口,重新生成 Token 后重试。 |
6000104 | 网络错误。 | 请检查网络,如果确认网络正常,请联系 ZEGO 技术支持处理。 |
6000105 | 回包超时。 | 请检查网络,如果确认网络正常,请联系 ZEGO 技术支持处理。 |
6000106 | Token 过期。 | 请调用 renewToken 接口更新 Token。 |
6000107 | Token 版本号错误。 | 目标 Token 版本不匹配,请使用正确版本的 Token。 |
6000108 | Token 剩余有效时间过短。 | 传入 Token 剩余有效时间低于三十秒时,SDK 会报出此错误码,请生成有效时间更长的 Token 以登录或更新 Token。 |
6000111 | 当前设备登录多个账号。 | 请先登出当前账号后,再登录其他账号。 |
6000121 | 用户没有登录,无法进行其他操作。 | 请调用 login 接口登录。 |
6000123 | 用户离线时间超过断线重连最大时间后,未登出当前 userID 就尝试登录其他 userID。 | 先调用 logOut 接口登出,再调用 login 接口登录。 |
6000124 | 离线登录使用的 userID 与上一次成功在线登陆所用的 userID 不一样。 | 请使用上一次成功在线登录的 userID,或者进行在线登录。 |
消息相关错误码
错误码 | 说明 | 处理建议 |
---|---|---|
6000201 | 发送消息内部错误。 | 请先上传日志,并联系 ZEGO 技术支持处理。 |
6000202 | 内部服务错误。 | 请先上传日志,并联系 ZEGO 技术支持处理。 |
6000203 | 内部异常,消息发送失败。 | 请先上传日志,并联系 ZEGO 技术支持处理。 |
6000204 | 消息发送目标(用户、房间、群组)不存在。 | 请先确认消息发送目标是否存在。 |
6000210 | 文件模块错误。 | 查看 error message,或提交日志联系 ZEGO 技术支持。 |
6000211 | 富媒体文件不存在。 | 请先确认消息文件是否存在。 |
6000212 | 发送富媒体消息失败。 | 请先上传日志,并联系 ZEGO 技术支持处理。 |
6000213 | 不支持的图片/音频/视频格式。 | 请先确认文件格式是否正确,支持的文件格式请参考 消息类型。 |
6000214 | 富媒体文件大小异常。 | 请先确认文件大小是否正确,大小限制请参考 消息类型。 |
6000215 | 音频文件时长异常。 | 请先确认时长是否正确,时长限制请参考 消息类型。 |
6000216 | 文件没有正确的读取权限。 | 常见于发送富媒体消息,欲发送的文件没有正确的读取权限,需要给予相应的权限。 |
6000217 | 文件下载失败的通用报错。 | 请先上传日志,并联系 ZEGO 技术支持处理。 |
6000218 | 文件大小超过上限导致下载失败。 | 文件大小上限默认为 200 MB,如需调整,请联系 ZEGO 技术支持。 |
6000219 | 文件的 URL 无效导致下载失败。 | 请验证 URL 是否有效。 |
6000220 | 请求失败导致下载失败。 | 请验证 URL 是否有效。 |
6000221 | 消息内容未通过安全审核,可存在非法图片或文本。 | 请确认消息内容是否安全。 |
6000222 | 进行安全审核失败。 | 请先上传日志,并联系 ZEGO 技术支持处理。 |
6000230 | 因开发者业务侧审核导致消息发送失败。 | 无需处理。 |
6000231 | 因被禁言而发送消息失败。 | 等待解禁或禁言时期超时后再发送消息。 |
6000240 | 导入导出接口报错。 | 请确认对应的 DB 文件是否存在。 |
6000241 | 正在执行导入或导出消息操作。 | 请勿重复执行。 |
6000242 | 只能导入当前用户的数据。 | 请确认导入的消息数据是否属于当前用户。 |
6000243 | 导出消息出错。 | 请向 ZEGO 技术支持提供日志进行排查。 |
6000244 | 导入消息出错。 | 请向 ZEGO 技术支持提供日志进行排查。 |
6000245 | 导入消息后解析出错。 | 请向 ZEGO 技术支持提供日志进行排查。 |
呼叫邀请相关错误码
错误码 | 说明 | 处理建议 |
---|---|---|
6000270 | 呼叫邀请失败。 | 请先上传日志,并联系 ZEGO 技术支持处理。 |
6000271 | 取消呼叫邀请失败,目标已经接受了呼叫邀请。 | 取消呼叫邀请,需要在目标未接受邀请时使用。 |
6000272 | 发起呼叫邀请服务失败,呼叫邀请人数超过限制、或后台报错。 | 请确认人数是否超过限制,最大为 9 人;或联系 ZEGO 技术支持处理。 |
6000273 | 非发起方取消呼叫邀请。 | 请确认调用“取消呼叫邀请”接口的用户是否正确。 |
6000274 | 未被邀请的用户接收/拒绝邀请。 | 请确认用户是否被邀请。 |
6000275 | 会话 callID 已存在。 | 请确认 callID 是否唯一。 |
6000276 | 取消/接受/拒绝呼叫邀请时,callID 不存在或已超时。 | 请确认 callID 会话是否存在、或是否超时。 |
6000281 | 发起呼叫邀请时,所有被邀请者均未注册。 |
|
6000283 | 调用 callJoin 接口的设备,已在进阶模式呼叫且为主设备。 | 无需处理。 |
6000286 | 调用 callJoin ,callQuit ,callEnd ,callingInvite 等进阶模式接口时,传入了普通模式呼叫 ID。 | 请确认 callID 及其模式。 |
房间相关错误码
错误码 | 说明 | 处理建议 |
---|---|---|
6000301 | 房间 roomID 不存在。 | 请确认 roomID 是否存在。 |
6000302 | 内部原因,致使操作失败。 | 请先上传日志,并联系 ZEGO 技术支持处理。 |
6000303 | 创建房间失败,内部错误。 | 请先上传日志,并联系 ZEGO 技术支持处理。 |
6000304 | 加入房间失败,房间不存在。 | 请先确认 roomID 是否存在。 |
6000306 | 离开房间失败,房间不存在。 | 请确认 roomID 是否存在,或联系 ZEGO 技术支持处理。 |
6000320 | 用户已在房间内。 | 请确认该用户是否已在此房间内。 |
6000321 | 用户不在房间内。 | 请确认该用户是否在此房间内。 |
6000322 | 调用 joinRoom 时加入房间时,roomID 对应的房间不存在。 | 请确认 roomID 是否已经调用 createRoom 接口被创建过。 |
6000323 | 调用 createRoom 时创建房间时,roomID 对应的房间已存在。 | 请不要重复创建相同 roomID 的房间,或调用 joinRoom 加入房间即可。 |
6000324 | 房间同时存在数量达到上限。 | 请勿超过房间同时存在数量上限,上限详情请参考 计费说明 中的“版本说明”。 |
6000325 | 用户同时加入多个房间数量达到上限。 | 请勿超过用户同时加入房间上限,上限详情请参考 计费说明 中的“版本说明”。 |
6000326 | 多次重复尝试 createRoom 、joinRoom 或 enterRoom 等接口或对于正在连接中的房间执行操作。 | 请等待 onRoomStateChanged 返回房间连接结果的返回后再执行操作。 |
6000330 | 房间属性错误。 | 请先上传日志,并联系 ZEGO 技术支持处理。 |
6000331 | 房间属性操作失败。 | 请重试。 |
6000332 | 房间属性操作部分失败。 | 请重试。 |
6000333 | 房间属性查询失败。 | 请重试。 |
6000334 | 房间属性数量超出限制。 | 每个房间中,最多允许设置 10 个属性。 |
6000335 | 房间属性 key 长度超过限制。 | 默认 key 的长度是 16。 |
6000336 | 房间属性 value 长度超过限制。 | 默认 value 的长度是 1024。 |
6000337 | 房间属性 value 总长度超过限制。 | 总长度限制由 ZIM 后台配置,请联系 ZEGO 技术支持确认。 |
6000350 | 房间内用户属性错误。 | 请先上传日志,并联系 ZEGO 技术支持处理。 |
6000351 | 房间内用户属性的总大小超过限制。 | 单个用户,所有的 Key-Value 总长度最大为 144 字节,最多 30 对。 |
6000352 | 房间内用户属性的 Key 大小超过限制。 | 单个 Key 长度最大为 8 字节。 |
6000353 | 房间内用户属性的 Value 大小超过限制。 | 单个 Value 长度最大为 64 字节。 |
6000354 | 在同一房间内,新增/修改用户属性过于频繁。 | 当前时间段内,房间内的所有人执行新增/修改操作,累计不能超过 20 次/10s。 |
6000355 | 在同一房间内,查询用户属性过于频繁。 | 当前时间段内,房间内的所有人执行查询操作,累计不能超过 1000 次/10s。 |
6000356 | 在同一房间内,该用户查询过于频繁。 | 当前时间段内,房间内的单个用户执行查询操作,不能超过 5 次/30s。 |
6000357 | 在同一房间内,可设置属性的用户数量超过上限。 | 同一房间内,最多可以设置 500 个用户的用户属性。 |
离线推送相关错误码
错误码 | 说明 | 处理建议 |
---|---|---|
6000401 | 离线推送 ID 无效。 | 请确认离线推送 ID 是否存在。 |
群组相关错误码
错误码 | 说明 | 处理建议 |
---|---|---|
6000501 | 群组操作失败。 | 请先上传日志,并联系 ZEGO 技术支持处理。 |
6000502 | 内部原因,致使操作失败。 | 请先上传日志,并联系 ZEGO 技术支持处理。 |
6000503 | 创建群组失败。 | 请重试,或联系 ZEGO 技术支持处理。 |
6000504 | 解散群组失败。 | 请重试,或联系 ZEGO 技术支持处理。 |
6000505 | 加入群组失败。 | 请重试,或联系 ZEGO 技术支持处理。 |
6000506 | 退出群组失败。 | 请重试,或联系 ZEGO 技术支持处理。 |
6000507 | 移除群组成员失败。 | 请重试,或联系 ZEGO 技术支持处理。 |
6000508 | 添加用户进入群组失败。 | 请重试,或联系 ZEGO 技术支持处理。 |
6000509 | 转让群主失败。 | 请重试,或联系 ZEGO 技术支持处理。 |
6000510 | 操作群资料失败。 | 请重试,或联系 ZEGO 技术支持处理。 |
6000511 | 查询群资料失败。 | 请重试,或联系 ZEGO 技术支持处理。 |
6000512 | 操作群属性失败。 | 请重试,或联系 ZEGO 技术支持处理。 |
6000513 | 查询群属性失败。 | 请重试,或联系 ZEGO 技术支持处理。 |
6000514 | 更新群成员信息失败。 | 请重试,或联系 ZEGO 技术支持处理。 |
6000515 | 查询群成员信息失败。 | 请重试,或联系 ZEGO 技术支持处理。 |
6000516 | 查询群组列表失败。 | 请重试,或联系 ZEGO 技术支持处理。 |
6000517 | 查询群成员列表失败。 | 请重试,或联系 ZEGO 技术支持处理。 |
6000521 | 用户不在群组内。 | 请确认用户是否在群组内。 |
6000522 | 用户已在群组内。 | 请勿重复加入群组。 |
6000523 | 群组不存在。 | 使用群组相关接口前,请确认群组 groupID 是否存在。 |
6000524 | 群组已存在。 | 请勿重复创建相同 groupID 的群组。 |
6000525 | 群成员达到上限。 | 请勿超过群组人数上限,上限详情请参考 计费说明 中的“版本说明”。 |
6000526 | 群属性不存在。 | 请确认属性是否存在。 |
6000527 | 使用已被销毁的群 ID 创建群组。 | 请使用其他 ID。 |
6000531 | 群组属性超过上限。 | 每个群组中,最多允许设置 10 个属性。 |
6000532 | 群组属性 key 长度超过限制。 | 默认 key 的长度是 16。 |
6000533 | 群组属性 value 长度超过限制。 | 默认 key 的长度是 1024。 |
6000541 | 没有群组相关接口的操作权限。 | 请确认当前用户在群组内的角色。 |
6000542 | 该群禁止群外用户主动加入。 | 等待该群成员发起入群邀请。 |
6000543 | 调用 joinGroup 接口直接入群报错。 | 请调用 sendGroupJoinApplication 发起入群申请,等待群主或管理员审核。 |
6000544 | 调用 inviteUsersIntoGroup 接口邀请外部用户入群,由于群组的 beInviteMode 为 Auth(1),导致用户没有直接入群。 | 请等待目标用户同意或拒绝入群。 |
会话相关错误码
错误码 | 说明 | 处理建议 |
---|---|---|
6000601 | 会话失败。 | 请先上传日志,并联系 ZEGO 技术支持处理。 |
6000602 | 内部原因,致使操作失败。 | 请先上传日志,并联系 ZEGO 技术支持处理。 |
6000603 | 会话不存在。 | 请确认会话是否存在。 |
6000604 | 会话置顶列表数量超过上限。 | 如需提高上限,请联系 ZEGO 技术支持。 |
消息回执相关错误码
错误码 | 说明 | 处理建议 |
---|---|---|
6000277 | 设置消息回执已读失败。 | 请确认设置消息回执已读的参数是否正确。 |
6000282 | 调用 sendMessageReceiptsRead 接口一次性将 10 条以上消息设置为已读。 | 请减少传入的消息数量到 10 条以内。 |
消息撤回相关错误码
错误码 | 说明 | 处理建议 |
---|---|---|
6000278 | 欲撤回消息但已超过撤回时限。 | 请确认撤回的消息是否超过时限。 |
6000279 | 欲撤回消息但消息已被撤回。 | 请确认是否重复撤回。 |
消息表态相关错误码
错误码 | 说明 | 处理建议 |
---|---|---|
6000280 | 表示用户在对一条消息进行某个 key 的表态或者删除表态时,该 key 已经被该用户表态过或者删除过。 | 开发者可进行弹窗提示,或者不进行特殊处理。 |
黑名单相关错误码
错误码 | 说明 | 处理建议 |
---|---|---|
6000284 | 因被消息接收方拉黑,无法向其发送消息。 | 按照正常的黑名单逻辑处理客户端 UI 表现 |
6000804 | 拉黑用户时,该用户已在黑名单。 | 无需重复拉黑。 |
6000805 | 不支持拉黑自己。 | 请检查所传 userID 是否正确。 |
6000806 | 该用户已被移除黑名单。 | 请检查黑名单关系。 |
6000807 | 该用户并未在黑名单。 | 请检查黑名单关系。 |
6000808 | 已达黑名单容量上限。 | 移除一部分黑名单成员或联系 ZEGO 技术支持扩容。 |
6000815 | 拉黑用户失败。 | 请查看回调中 ZIMErrorUserInfo > reason ,以获取具体失败原因。 |
6000816 | 将用户移出黑名单失败。 | 请查看回调中 ZIMErrorUserInfo > reason ,以获取具体失败原因。 |
好友管理相关错误码
错误码 | 说明 | 处理建议 |
---|---|---|
6000801 | 好友数量已达上限(3000),无法添加更多好友。 | 移除一部分好友或联系 ZEGO 技术支持扩容。 |
6000802 | 当前用户已同意、拒绝该申请,无法再次调用同意或拒绝好友申请接口。 | 按照正常的好友管理逻辑处理客户端 UI 表现。 |
6000803 | 目标用户已经是操作用户的好友,无法直接添加目标用户为好友或向其发起好友申请。 | 按照正常的好友管理逻辑处理客户端 UI 表现。 |
6000809 | 一次性删除好友数量超过上限(默认为 20)。 | 请减少传入用户数量。 |
6000810 | 添加好友或发起好友申请时,传入的用户 ID 是操作用户自己。 | 按照正常的好友管理逻辑处理客户端 UI 表现。 |
6000811 | 添加好友或发起好友申请时,传入的用户 ID 不存在。 | 按照正常的好友管理逻辑处理客户端 UI 表现。 |
6000812 | 删除好友时,传入的用户 ID 不是操作用户的好友。 | 请检查您的代码是否符合好友管理逻辑。 |
6000813 | 删除好友时,传入的用户 ID 传入的用户 ID 是操作用户自己。 | 请检查您的代码是否符合好友管理逻辑。 |
6000814 | 好友申请已过期,无法对其调用同意或拒绝好友申请接口。 | 按照正常的好友管理逻辑处理客户端 UI 表现。 |