通知
RTM 1.x 将于近期下架，各版本退休日期和替代方案详见 退休政策 。
文档中心
云信令（原实时消息）
Console 官网 社区 技术支持
简体中文
search-icon

限制条件

更新时间 2020/09/03 11:46:12

本页简要介绍 Agora RTM Web SDK 的使用限制条件，包括调用频率、字符串大小、编码格式等。

调用频率限制

所有的调用频率都针对单个 RtmClient 实例。如果一个操作对应多个方法，则此操作在单位时间内的调用次数等于所有方法单位时间内的调用次数之和。

我们暂不建议在 Web 平台上通过创建多个实例提高 API 的调用频率。
操作 方法 调用频率上限
登录到 Agora RTM 系统 login 每秒 2 次
查询单个或多个频道的成员人数 getChannelMemberCount 每秒 1 次
每次加入同一个频道 join 每 3 秒 50 次
每次加入不同频道 join 每 5 秒 2 次
发送消息
  • sendMessageToPeer
  • SendMessage
    		•  每 3 秒 180 次
    获取频道成员列表 getMembers 每 2 秒 5 次
    更新 Token renewToken 每秒 2 次
    查询指定用户在线状态 queryPeersOnlineStatus 每 5 秒 10 次
    用户属性增删修改
  • setLocalUserAttributes
  • addOrUpdateLocalUserAttributes
  • deleteLocalUserAttributesByKeys
  • clearLocalUserAttributes
    		•  每 5 秒 10 次
    用户属性查询
  • getUserAttributes
  • getUserAttributesByKeys
    		•  每 5 秒 40 次
    频道属性增删修改
  • setChannelAttributes
  • addOrUpdateChannelAttributes
  • deleteChannelAttributesByKeys
  • clearAttributes
    		•  每 5 秒 10 次
    频道属性查询
  • getChannelAttributes
  • getChannelAttributesByKeys
    		•  每 5 秒 10 次
    订阅指定单个或多个用户的在线状态 subscribePeersOnlineStatus 每 5 秒 10 次
    取消订阅指定单个或多个用户的在线状态 unSubscribePeersOnlineStatus 每 5 秒 10 次
    根据订阅内容获取用户列表 queryPeersBySubscriptionOption 每 5 秒 10 次

    字符串长度限制

    编码格式限制

    仅支持发送 UTF-8 编码格式的频道消息和点对点消息、呼叫邀请内容、呼叫邀请响应。

    浏览器兼容性

    详见开发环境要求。

    其他限制

    • 当频道人数超过 512 人时，用户进出频道的提示会被自动关闭。Agora 建议你在自己的业务服务器调用获取用户加入或离开频道事件 RESTful API 获取进出频道通知。
    • 对于单个实例，支持单次查询最多 256 个用户的在线状态。
    • 对于单个实例，单次最多且总计只能订阅 512 人的在线状态。你无法通过多次订阅来突破人数限制。如果频道人数超过 512，SDK 会随机返回其中的 512 人。
    • 对于单个实例，每个用户最多同时加入 20 个频道。
    • 单次用户属性设置的最大值为 16 KB，单次频道属性设置的最大值为 32 KB，单条用户或频道属性（键值对）的最大值为 8 KB，单次属性操作设置的属性条目（键值对）不能超过 32 个。
    • 每个上传文件或图片在 Agora 服务器上的保存时间最长为 7 天，上传文件或图片所对应的 media ID 有效期也为 7 天。
    • 每个上传文件或图片不得超过 30 MB。
    • 对于单个实例，同时最多支持 9 个上传和下载进程。