错误排查

  • Unity

更新时间

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

开启本地日志

当你的应用处于开发、测试阶段时,你可能需要 SDK 输出更详细的信息来定位并修复问题。你可以在初始化 RTM 实例的时候通过设置 RtmConfig 中的 RtmLogConfig 来开启日志输出并设置日志信息等级,之后即可在 IDE 中查看日志信息。

C#
using Agora.Rtm;
private IRtmClient rtmClient;
LogConfig logConfig = new LogConfig()
// set log file path.
logConfig.filePath = "./logfile/";
// set log file size.
logConfig.fileSizeInKB = 512;
// set log report level.
logConfig.level = LOG_LEVEL.INFO;
RtmConfig config = new RtmConfig();
// initialize logconfig.
config.logConfig = logConfig;
config.appId = "your_appId";
config.userId = "your_userId";
try
{
    rtmClient = RtmClient.CreateAgoraRtmClient(config);
    Debug.Log("RTM Client Initialize Sucessfull");
}
catch (RTMException e)
{
    Debug.Log(string.Format("{0} is failed.", e.Status.Operation ));
    Debug.Log(string.Format("Error code: {0}, due to: {1}", e.Status.ErrorCode, e.Status.Reason));
}

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

信息

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

错误码对照表

错误码错误描述原因及解决方法
0OK正确调用。
-10001NOT_INITIALIZEDSDK 未初始化。请在调用 CreateAgoraRtmClient 方法初始化 RTM 实例后再执行其他操作。
-10002NOT_LOGIN用户未登录 RTM 系统、掉线超时或者主动退出登录后调用 API。请先登录 RTM 系统。
-10003INVALID_APP_ID

无效 App ID:

  • 检查 App ID 是否错误。
  • 检查 App ID 是否开通了 RTM 服务。
-10005INVALID_TOKEN无效 Token。检查 Token Provider 是否生成 RTM Token。
-10006INVALID_USER_ID

无效用户 ID:

  • 检查用户 ID 是否为空。
  • 检查用户 ID 是否包含非法字符。
-10007INIT_SERVICE_FAILEDSDK 初始化失败。请重新调用 CreateAgoraRtmClient 方法进行初始化。
-10008INVALID_CHANNEL_NAME

无效频道名称:

  • 检查频道名是否为空。
  • 检查频道名是否包含非法字符。
-10009TOKEN_EXPIREDToken 过期失效。你需要调用 renewToken 重新获取 Token。
-10010LOGIN_NO_SERVER_RESOURCES服务器资源受限。建议重新登录。
-10011LOGIN_TIMEOUT登录超时。你需要检查当前网络是否稳定并切换到稳定网络环境中。如果你的网络处于内网环境,请检查你的防火墙是否配置了正确的域名和端口,详见防火墙白名单设置。
-10012LOGIN_REJECTED

SDK 被服务器拒绝登录:

  • 检查 App ID 是否开通 RTM 服务。
  • 检查 Token 或 userId 是否被封禁。
-10013LOGIN_ABORTED

由于未知问题 SDK 登录中断:

  • 检查当前网络是否稳定,切换到稳定网络环境中。
  • 当前 userId 在其他端登录。
-10014INVALID_PARAMETER参数无效。检查你填写的参数是否正确。
-10015LOGIN_NOT_AUTHORIZED没有 RTM 服务权限。检查控制台是否开通 RTM 服务。
-10016INCONSISTENT_APPIDApp ID 不一致。检查初始化、登录、加入频道的 App ID 是否一致。
-10017DUPLICATE_OPERATION重复操作。
-10018INSTANCE_ALREADY_RELEASED重复调用 Dispose 方法释放 IRtmClient 实例或重复调用 Dispose 释放 IStreamChannel 实例。
-10019INVALID_CHANNEL_TYPE

频道类型无效。SDK 仅支持如下频道类型,请填写正确的值:

  • MESSAGE: Message Channel
  • STREAM: Stream Channel
-10020INVALID_ENCRYPTION_PARAMETER

消息加密参数无效。

  • 检查生成的加密密钥是否为字符串类型。
  • 检查生成的加密盐是否为字节数组类型,长度是否为 32 字节。
  • 检查加密方式与加密密钥、加密盐是否匹配。
-10021OPERATION_RATE_EXCEED_LIMITATIONAPI 调用频率超过限制。各 API 的配额见API 使用限制。
-11001CHANNEL_NOT_JOINED

用户未加入该频道:

  • 用户不在线、已离线或未加入该频道
  • 检查 userId 是否拼写错误。
-11002CHANNEL_NOT_SUBSCRIBED

用户未订阅该频道:

  • 用户不在线、已离线或未加入该频道
  • 检查 userId 是否拼写错误。
-11003CHANNEL_EXCEED_TOPIC_USER_LIMITATION订阅该 Topic 人数超出限制。
-11004CHANNEL_IN_REUSE共频道模式下,RTM 释放了 Stream Channel。
-11005CHANNEL_INSTANCE_EXCEED_LIMITATION创建的频道数量或订阅的频道数量超出限制。详见 API 调用限制。
-11006CHANNEL_IN_ERROR_STATE频道不可用。请重新创建 Stream Channel 或重新订阅 Message Channel。
-11007CHANNEL_JOIN_FAILED

加入该频道失败:

  • 检查已加入频道数量是否超限。
  • 检查频道名是否非法。
  • 检查网络是否断开连接。
-11008CHANNEL_INVALID_TOPIC_NAME

无效 Topic 名:

  • 检查 Topic 名是否包含非法字符。
  • 检查 Topic 名是否为空。
-11009CHANNEL_INVALID_MESSAGE无效消息。检查消息类型是否合法,RTM 只支持字符串或二进制类型消息。
-11010CHANNEL_MESSAGE_LENGTH_EXCEED_LIMITATION

消息长度超出限制。检查消息负载大小是否超限:

  • Message Channel 单个消息包小于 32 KB。
  • Stream Channel 单个消息包小于 1 KB。
-11011CHANNEL_INVALID_USER_LIST

无效用户列表:

  • 检查用户列表是否为空
  • 检查用户列表是否包含非法项。
-11012CHANNEL_NOT_AVAILABLEStream Channel 功能未开通,当前不可用。检查控制台是否已开启 Stream Channel 功能。
-11013CHANNEL_TOPIC_NOT_SUBSCRIBED未订阅该 Topic。
-11014CHANNEL_EXCEED_TOPIC_LIMITATIONTopic 数量超出限制。
-11015CHANNEL_JOIN_TOPIC_FAILED加入该 Topic 失败。检查已加入 Topic 数量是否超出限制。
-11016CHANNEL_TOPIC_NOT_JOINED未加入该 Topic。未加入 Topic 就发送消息,你需要先加入 Topic。
-11017CHANNEL_TOPIC_NOT_EXIST该 Topic 不存在。检查 Topic 名是否错误。
-11018CHANNEL_INVALID_TOPIC_METATopic 中的 meta 参数无效。检查 meta 参数是否超出 256 字节的限制。
-11019CHANNEL_SUBSCRIBE_TIMEOUT频道订阅超时。检查连接是否断开。
-11020CHANNEL_SUBSCRIBE_TOO_FREQUENT频道订阅操作太频繁。请确保 5 秒内对同一频道的订阅操作不超过 2 次。
-11021CHANNEL_SUBSCRIBE_FAILED频道订阅失败。检查已订阅频道数量是否超出限制。
-11022CHANNEL_UNSUBSCRIBE_FAILED取消频道订阅失败。检查连接是否断开。
-11023CHANNEL_ENCRYPT_MESSAGE_FAILED

消息加密失败:

  • 检查加密密钥是否有效。
  • 检查加密盐是否有效。
  • 检查加密方式与加密密钥、加密盐是否匹配。
-11024CHANNEL_PUBLISH_MESSAGE_FAILED消息发布失败。检查连接是否断开。
-11026CHANNEL_PUBLISH_MESSAGE_TIMEOUT消息发布超时。检查连接是否断开。
-11027CHANNEL_NOT_CONNECTEDSDK 与 RTM 服务器断开连接。请重新登录。
-11028CHANNEL_LEAVE_FAILED离开频道失败。检查连接是否断开。
-11029CHANNEL_CUSTOM_TYPE_LENGTH_OVERFLOWCustom type 长度溢出。customType 字段长度需要在 32 个字符以内。
-11030CHANNEL_INVALID_CUSTOM_TYPEcustomType 字段无效。检查 customType 字段是否包含非法字符。
-11031CHANNEL_UNSUPPORTED_MESSAGE_TYPE消息类型不支持。
-11032CHANNEL_PRESENCE_NOT_READYPresence 服务未就绪。请重新加入 Stream Channel 或重新订阅 Message Channel。
-11033CHANNEL_RECEIVER_OFFLINE

发送用户消息时,远端用户不在线:

  • 检查在调用方法时设置的用户 ID 是否正确。
  • 检查远端用户是否登录系统并处于在线状态。
-12001STORAGE_OPERATION_FAILEDStorage 操作失败。
-12002STORAGE_METADATA_ITEM_EXCEED_LIMITATIONStorage Metadata Item 数量超出限制。
-12003STORAGE_INVALID_METADATA_ITEM无效 Metadata Item。
-12004STORAGE_INVALID_ARGUMENT无效参数。
-12005STORAGE_INVALID_REVISION无效 Revision 参数。
-12006STORAGE_METADATA_LENGTH_OVERFLOWMetadata 长度溢出。
-12007STORAGE_INVALID_LOCK_NAME无效 Lock 名称。
-12008STORAGE_LOCK_NOT_ACQUIRED未获取该 Lock。
-12009STORAGE_INVALID_KEY无效 Metadata 键。
-12010STORAGE_INVALID_VALUE无效 Metadata 值。
-12011STORAGE_KEY_LENGTH_OVERFLOWMetadata 键长度溢出。
-12012STORAGE_VALUE_LENGTH_OVERFLOWMetadata 值长度溢出。
-12013STORAGE_DUPLICATE_KEY重复的 Metadata Item 键。
-12014STORAGE_OUTDATED_REVISIONMetadata Item 中的 Revision 过时或 Key 不存在。
-12015STORAGE_NOT_SUBSCRIBE未订阅该频道。
-12016STORAGE_INVALID_METADATA_INSTANCEMetadata 实例不存在。请创建 Metadata 实例。
-12017STORAGE_SUBSCRIBE_USER_EXCEED_LIMITATION订阅用户 Metadata 数量超出限制。
-12018STORAGE_OPERATION_TIMEOUTStorage 操作超时。
-12019STORAGE_NOT_AVAILABLEStorage 服务不可用。
-13001PRESENCE_NOT_CONNECTED用户未连接到系统。
-13002PRESENCE_NOT_WRITABLEPresence 服务不可用。
-13003PRESENCE_INVALID_ARGUMENT无效参数。
-13004PRESENCE_CACHED_TOO_MANY_STATES加入频道前缓存的临时用户状态超出限制。详见 API 调用限制。
-13005PRESENCE_STATE_COUNT_OVERFLOW临时用户状态键/值对数量超出限制。详见 API 调用限制。
-13006PRESENCE_INVALID_STATE_KEY无效状态键。
-13007PRESENCE_INVALID_STATE_VALUE无效状态值。
-13008PRESENCE_STATE_KEY_SIZE_OVERFLOW状态键长度溢出。
-13009PRESENCE_STATE_VALUE_SIZE_OVERFLOW状态值长度溢出
-13010PRESENCE_STATE_DUPLICATE_KEY重复的状态键。
-13011PRESENCE_USER_NOT_EXIST该用户不存在。
-13012PRESENCE_OPERATION_TIMEOUTPresence 操作超时。
-13013PRESENCE_OPERATION_FAILEDPresence 操作失败。
-14001LOCK_OPERATION_FAILEDLock 操作失败。
-14002LOCK_OPERATION_TIMEOUTLock 操作超时。
-14003LOCK_OPERATION_PERFORMINGLock 操作进行中。
-14004LOCK_ALREADY_EXISTLock 已存在。
-14005LOCK_INVALID_NAME无效 Lock 名。
-14006LOCK_NOT_ACQUIRED未获取该 Lock。
-14007LOCK_ACQUIRE_FAILED获取该 Lock 失败。
-14008LOCK_NOT_EXIST该 Lock 不存在。
-14009LOCK_NOT_AVAILABLELock 服务不可用。
表格内容超出当前宽度,可横向滚动查看更多列。

联系我们

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