错误排查

  • 小程序

更新时间

了解实时消息 RTM 在不同平台上的错误排查方式,包括接入流程、关键配置和平台差异。

本文介绍 RTM 微信小程序 SDK 的错误排查方式。

开启本地日志

当你的应用处于开发、测试阶段时,你可能需要 SDK 输出更详细的信息来定位并修复问题。你可以在初始化 RTM 实例的时候通过设置 RTMConfig 中的 logLevel 来开启日志输出并设置日志信息等级,之后即可在微信开发者工具控制台或真机调试日志中查看日志信息。

JavaScript
import AgoraRTM from 'shengwang-rtm-miniapp';

const { RTM } = AgoraRTM;
const rtmConfig = { logLevel: 'debug' };
const rtm = new RTM('yourAppId', 'Tony', rtmConfig);

logLevel 字段可以设置为 debug、info、warn、error、none 五个等级之一,其中 debug 输出最详细的日志信息,none 不输出日志信息。

信息

当你的应用上线时,请将日志信息等级设置为 info。

开启日志上传

当你遇到在本地调试无法解决的错误时,可以联系声网技术支持协助你排查问题。此时,你需要开启日志上传功能,声网技术支持会根据你的日志信息来定位错误原因。你需要在初始化 RTM 实例的时候通过设置 rtmConfig 参数中的 logUpload 参数开启日志上传功能。

JavaScript
const { RTM } = AgoraRTM;
const rtmConfig = {
  logLevel: 'debug',
  logUpload: true,
};
const rtm = new RTM('yourAppId', 'Tony', rtmConfig);

信息

为避免产生不必要的存储计费,你需要在故障解决后及时关闭日志上传功能。

错误码对照表

RTM 微信小程序 SDK 支持并推荐你使用 Async/Await 编程模式,以便在业务中处理 JavaScript 异步操作。在调用 RTM 微信小程序 API 时,如果发生错误,SDK 会抛出一个 ErrorInfo 类型的错误对象,你需要使用 try...catch 捕获该对象。ErrorInfo 包含以下属性:

JavaScript
type ErrorInfo = {
  error: boolean;      // 本次操作是否出错
  operation: string;   // 本次操作的 API 名称
  errorCode: number;   // 错误码
  reason: string;      // 错误描述
}

如果 API 调用失败,则 SDK 会通过 ErrorInfo 的 errorCode 和 reason 属性分别报告错误码和错误描述,你可以在下面的表格中寻找解决方法:

错误码错误描述原因及解决方法
0RTM_ERROR_OK正确调用。
-10002RTM_ERROR_NOT_LOGIN用户未登录 RTM 系统、掉线超时或者主动退出登录后调用 API。请先登录 RTM 系统。
-10003RTM_ERROR_INVALID_APP_ID无效 App ID。检查 App ID 是否错误或是否已开通 RTM 服务。
-10005RTM_ERROR_INVALID_TOKEN无效 Token。检查 Token Provider 是否生成 RTM Token。
-10006RTM_ERROR_INVALID_USER_ID无效用户 ID。检查用户 ID 是否为空或包含非法字符。
-10008RTM_ERROR_INVALID_CHANNEL_NAME无效频道名称。检查频道名是否为空或包含非法字符。
-10009RTM_ERROR_TOKEN_EXPIREDToken 过期失效。你需要先调用 logout 方法登出 RTM 系统,然后使用新的 Token 创建 RTM 实例,再调用 login 方法重新登录 RTM 系统。
-10010RTM_ERROR_LOGIN_NO_SERVER_RESOURCES服务器资源受限。建议重新登录。
-10011RTM_ERROR_LOGIN_TIMEOUT登录超时。你需要检查当前网络是否稳定并切换到稳定网络环境中,并确认已在微信公众平台配置 SDK 所需的 request 合法域名和 socket 合法域名。完整域名列表见快速开始。
-10012RTM_ERROR_LOGIN_REJECTEDSDK 被服务器拒绝登录。检查 App ID 是否开通 RTM 服务,以及 Token 或 userId 是否被封禁。
-10013RTM_ERROR_LOGIN_ABORTED由于未知问题 SDK 登录中断。检查网络是否稳定,并确认当前 userId 未在其他端登录。
-10015RTM_ERROR_LOGIN_NOT_AUTHORIZED没有 RTM 服务权限。检查控制台中的 RTM 服务、账号余额和账号状态。
-10017RTM_ERROR_DUPLICATE_OPERATION重复操作。
-10018RTM_ERROR_INSTANCE_ALREADY_RELEASED重复释放 RTM 实例。
-10019RTM_ERROR_INVALID_CHANNEL_TYPE频道类型无效。SDK 仅支持 MESSAGE 和 USER。
-10020RTM_ERROR_INVALID_ENCRYPTION_PARAMETER消息加密参数无效。检查加密密钥、加密盐和加密方式是否匹配。
-10021RTM_ERROR_OPERATION_RATE_EXCEED_LIMITATIONChannel Metadata 或 User Metadata 相关 API 的调用频率超限。请控制调用频率在 10 次/秒之内。
-10023RTM_ERROR_LOGIN_CANCELED登录操作已取消。请避免重复调用 login,并确保登录成功后再调用 logout。
-10025RTM_ERROR_NOT_CONNECTED未连接 RTM 服务器。在调用消息订阅、Metadata 或 Lock 模块相关 API 时,如果 RTM 服务未连接,会报这个错误。
-10026RTM_ERROR_RENEW_TOKEN_TIMEOUT更新 Token 超时。
-11001RTM_ERROR_CHANNEL_NOT_JOINED用户未加入该频道。检查用户是否在线、是否已加入频道以及 userId 是否正确。
-11002RTM_ERROR_CHANNEL_NOT_SUBSCRIBED用户未订阅该频道。检查用户是否在线、是否已订阅频道以及 userId 是否正确。
-11005RTM_ERROR_CHANNEL_INSTANCE_EXCEED_LIMITATION创建的频道数量或订阅的频道数量超出限制。详见 API 使用限制。
-11006RTM_ERROR_CHANNEL_IN_ERROR_STATE频道不可用。请重新订阅 Message Channel。
-11007RTM_ERROR_CHANNEL_JOIN_FAILED加入频道失败。检查频道数量、频道名和网络连接。
-11009RTM_ERROR_CHANNEL_INVALID_MESSAGE无效消息。检查消息类型是否合法,RTM 只支持字符串或二进制类型消息。
-11010RTM_ERROR_CHANNEL_MESSAGE_LENGTH_EXCEED_LIMITATION消息长度超出限制。Message Channel 单个消息包必须小于 32 KB。
-11019RTM_ERROR_CHANNEL_SUBSCRIBE_TIMEOUT频道订阅超时。检查连接是否断开。
-11020RTM_ERROR_CHANNEL_SUBSCRIBE_TOO_FREQUENT频道订阅操作太频繁。请确保 5 秒内对同一频道的订阅操作不超过 2 次。
-11021RTM_ERROR_CHANNEL_SUBSCRIBE_FAILED频道订阅失败。检查已订阅频道数量是否超出限制。
-11023RTM_ERROR_CHANNEL_ENCRYPT_MESSAGE_FAILED消息加密失败。检查加密密钥、加密盐和加密方式是否有效。
-11024RTM_ERROR_CHANNEL_PUBLISH_MESSAGE_FAILED消息发布失败。检查连接是否断开。
-11026RTM_ERROR_CHANNEL_PUBLISH_MESSAGE_TIMEOUT消息发布超时。检查连接是否断开。
-11028RTM_ERROR_CHANNEL_LEAVE_FAILED离开频道失败。检查连接是否断开。
-11029RTM_ERROR_CHANNEL_CUSTOM_TYPE_LENGTH_OVERFLOWCustom type 长度溢出。customType 字段长度需要在 32 个字符以内。
-11030RTM_ERROR_CHANNEL_INVALID_CUSTOM_TYPEcustomType 字段无效。检查 customType 字段是否包含非法字符。
-11033RTM_ERROR_CHANNEL_RECEIVER_OFFLINE发送用户消息时,远端用户不在线。检查用户 ID 和远端用户在线状态。
-12001RTM_ERROR_STORAGE_OPERATION_FAILEDStorage 操作失败。
-12002RTM_ERROR_STORAGE_METADATA_ITEM_EXCEED_LIMITATIONStorage Metadata Item 数量超出限制。
-12003RTM_ERROR_STORAGE_INVALID_METADATA_ITEM无效 Metadata Item。
-12004RTM_ERROR_STORAGE_INVALID_ARGUMENT无效参数。
-12005RTM_ERROR_STORAGE_INVALID_REVISION无效 Revision 参数。
-12006RTM_ERROR_STORAGE_METADATA_LENGTH_OVERFLOWMetadata 长度溢出。
-12007RTM_ERROR_STORAGE_INVALID_LOCK_NAME无效 Lock 名称。
-12008RTM_ERROR_STORAGE_LOCK_NOT_ACQUIRED未获取该 Lock。
-12009RTM_ERROR_STORAGE_INVALID_KEY无效 Metadata 键。
-12010RTM_ERROR_STORAGE_INVALID_VALUE无效 Metadata 值。
-12011RTM_ERROR_STORAGE_KEY_LENGTH_OVERFLOWMetadata 键长度溢出。
-12012RTM_ERROR_STORAGE_VALUE_LENGTH_OVERFLOWMetadata 值长度溢出。
-12014RTM_ERROR_STORAGE_OUTDATED_REVISION过时的 Revision 参数。
-12015RTM_ERROR_STORAGE_NOT_SUBSCRIBE未订阅该频道。
-12017RTM_ERROR_STORAGE_SUBSCRIBE_USER_EXCEED_LIMITATION订阅用户 Metadata 数量超出限制。
-12018RTM_ERROR_STORAGE_OPERATION_TIMEOUTStorage 操作超时。
-12019RTM_ERROR_STORAGE_NOT_AVAILABLEStorage 服务不可用。
-13001RTM_ERROR_PRESENCE_NOT_CONNECTED用户未连接到系统。
-13003RTM_ERROR_PRESENCE_INVALID_ARGUMENT无效参数。
-13004RTM_ERROR_PRESENCE_CACHED_TOO_MANY_STATES加入频道前缓存的临时用户状态超出限制。详见 API 使用限制。
-13005RTM_ERROR_PRESENCE_STATE_COUNT_OVERFLOW临时用户状态键/值对数量超出限制。详见 API 使用限制。
-13006RTM_ERROR_PRESENCE_INVALID_STATE_KEY无效状态键。
-13008RTM_ERROR_PRESENCE_STATE_KEY_SIZE_OVERFLOW状态键长度溢出。
-13010RTM_ERROR_PRESENCE_STATE_DUPLICATE_KEY重复的状态键。
-13009RTM_ERROR_PRESENCE_STATE_VALUE_SIZE_OVERFLOW状态值长度溢出。
-13011RTM_ERROR_PRESENCE_USER_NOT_EXIST该用户不存在。
-13012RTM_ERROR_PRESENCE_OPERATION_TIMEOUTPresence 操作超时。
-13013RTM_ERROR_PRESENCE_OPERATION_FAILEDPresence 操作失败。
-14001RTM_ERROR_LOCK_OPERATION_FAILEDLock 操作失败。
-14002RTM_ERROR_LOCK_OPERATION_TIMEOUTLock 操作超时。
-14003RTM_ERROR_LOCK_OPERATION_PERFORMINGLock 操作进行中。
-14004RTM_ERROR_LOCK_ALREADY_EXISTLock 已存在。
-14005RTM_ERROR_LOCK_INVALID_NAME无效 Lock 名。
-14006RTM_ERROR_LOCK_NOT_ACQUIRED未获取该 Lock。
-14007RTM_ERROR_LOCK_ACQUIRE_FAILED获取该 Lock 失败。
-14008RTM_ERROR_LOCK_NOT_EXIST该 Lock 不存在。
-14009RTM_ERROR_LOCK_NOT_AVAILABLELock 服务不可用。
-15001RTM_ERROR_HISTORY_OPERATION_FAILED历史消息的操作失败。
-15003RTM_ERROR_HISTORY_OPERATION_TIMEOUT历史消息操作过时。
-15005RTM_ERROR_HISTORY_NOT_AVAILABLE历史消息服务不可用。
表格内容超出当前宽度,可横向滚动查看更多列。

具体 API 支持范围以已安装的 shengwang-rtm-miniapp 包中的类型定义为准。

联系我们

如果以上措施都为未能解决你的故障,或者你需要解决方案的支持,请将你的需求整理出来并通过邮箱发送到:rtm-support@agora.io。我们会在收到邮件的第一时间与你取得联系。