API 使用限制

一般限制

除下文有特别说明外，使用 RTM SDK 的单个客户端对所有 API 的调用频率需限制在 20（次/秒）之内。如果每秒调用次数超出 20 次，则部分调用会被 SDK 忽略。如需每秒调用更多次 API，联系声网 RTM 团队（rtm-support@agora.io）。

初始配置

类别	软限制	硬限制	说明
项目数量/账号	1000 个	-	一个声网账号默认支持创建 1000 个项目。如需创建更多项目，联系声网 RTM 团队（rtm-support@agora.io）。
实例数量/客户端	1 个	1 个	RTM SDK 仅支持为单个客户端创建单个 RTM 实例。尝试创建多实例会失败。
Message Channel 数量/App ID	无限制	-	频道资源属于 RTM 公共资源，用户可以随用随取，一个 App ID 下无频道数量限制。
Stream Channel 数量/App ID	无限制	-	频道资源属于 RTM 公共资源，用户可以随用随取，一个 App ID 下无频道数量限制。
用户 ID （userId）长度	64 个 ASCII 字符	64 个 ASCII 字符	超出软限制会收到错误提示。

Message Channel

类别	软限制	硬限制	说明
消息发送速率/客户端	60 条消息/秒	60 条消息/秒	超出软限制会收到错误提示。如需更快的消息发送速率，联系声网 RTM 团队（rtm-support@agora.io）。
订阅者数量/频道	无限制	-	每个频道可以被无限个用户订阅。
发布者数量/频道	无限制	-	每个频道可以有无限个消息发布者。
订阅频道数量/客户端	50 个	-	一个客户端可以同时订阅 50 个频道，超出软限制会收到错误提示。
消息包体积（消息负载 + customType 字段大小）	32 KB	32 KB	超出软限制会收到错误提示。如需更大的消息包体积，联系声网 RTM 团队（rtm-support@agora.io）。
频道名长度	64 个 ASCII 字符	64 个 ASCII 字符	超出软限制会收到错误提示。
自定义消息类型长度	32 个 ASCII 字符	32 个 ASCII 字符	超出软限制会收到错误提示。

Stream Channel

类别	软限制	硬限制	说明
创建频道数量/客户端	无限制	-	单个客户端可以创建无限个频道。
加入频道数量/客户端	10 个	-	单个客户端可以同时加入至多 10 个频道，超出软限制会收到错误提示。如需加入更多频道，联系声网 RTM 团队（rtm-support@agora.io）。
用户数量/频道	128 个	128 个	单个频道可同时容纳至多 128 个用户。超出软限制会收到错误提示。如需容纳更多用户，联系声网 RTM 团队（rtm-support@agora.io）。
Topic 数量/频道	无限制	-	单个频道可以拥有无限个 Topic。
频道名长度	64 个 ASCII 字符	64	超出软限制会收到错误提示。

Topic

类别	软限制	硬限制	说明
加入 Topic 数量/客户端/频道	8 个	8 个	单个客户端在单个频道可同时加入至多 8 个 Topic，超出软限制会收到错误提示。
消息发布速率/客户端/频道	200 条消息/秒	200 条消息/秒	单个客户端在一个频道中发送消息的速率至多为 200 条消息/秒，超出软限制会收到错误提示。如需更快的消息发送速率，联系声网 RTM 团队（rtm-support@agora.io）。
订阅 Topic 数量/客户端/频道	50 个	50 个	单个客户端在单个频道中可以同时订阅至多 50 个 Topic，超出软限制会收到错误提示。
订阅用户数量/客户端/Topic	64 个	64 个	单个客户端在单个 Topic 中可以订阅至多 64 个用户 ID，超出软限制会收到错误提示。
发布者数量/Topic	无限制	-	单个 Topic 中可以有无限个消息发布者。
Topic 名长度	16 个 ASCII 字符	16 个 ASCII 字符	当前版本的 Topic 名长度为 16 个 ASCII 字符，后续版本将扩展到 64 个 ASCII 字符。
消息包体积（消息负载 + customType 字段大小）	1 KB	1 KB	超出软限制会收到错误提示。如果你的业务场景需要支持更大的消息包体积，联系 RTM 团队（rtm-support@agora.io）反馈。
自定义消息类型长度	32 个 ASCII 字符	32 个 ASCII 字符	超出软限制会收到错误提示。

Presence

类别	软限制	硬限制	说明
presenceTimeout	默认 300 秒，可设置范围为 10 秒 - 300 秒	-	超出设定值后 SDK 会就近匹配边界值，例如：你设置了 400 秒，则 SDK 实际应用的presenceTimeout 为 300 秒。如需更长或者更短的时间间隔，联系声网 RTM 团队（rtm-support@agora.io）。
临时用户状态键/值对	32 对	32 对	超出软限制会收到错误提示。
加入频道前缓存的临时用户状态数量	100 个	100 个	超出软限制会收到错误提示。

Storage

类别	软限制	硬限制	说明
Metadata Item 中 key 的长度	32 个 ASCII 字符	-	key 的长度不超过 32 个 ASCII 字符。
单频道/用户可拥有 Channel Metadata 或 User Metadata 的个数	1 个	1 个	每个频道只能最多拥有一个 Channel Metadata，每个用户只能最多拥有一个 User Metadata 。
单个 Channel Metadata 或 User Metadata 可拥有的 Metadata Item 个数	无限制	-	Channel Metadata 或 User Metadata 中可以包含无限个 Metadata Item。
单个 Channel Metadata 或 User Metadata 的存储空间大小	16 KB	-	如需更大的存储空间，联系声网 RTM 团队（rtm-support@agora.io）。
单个 Metadata Item 的存储空间大小	16 KB	-	如需更大的存储空间，联系声网 RTM 团队（rtm-support@agora.io）。
单客户端 Channel Metadata API 调用频率	10 次/秒	20 次/秒	单客户端对所有 Channel Metadata 相关 API 的调用频率需限制在 10（次/秒）。如需每秒调用更多次 API，联系声网 RTM 团队（rtm-support@agora.io）。
单客户端 User Metadata API 调用频率	10 次/秒	20 次/秒	单客户端对所有 User Metadata 相关 API 的调用频率需限制在 10（次/秒）。如需每秒调用更多次 API，联系声网 RTM 团队（rtm-support@agora.io）。
Channel Metadata 总数量/App ID	1 百万个	-	一个 App ID 下，最多可以存储 1 百万个 Channel Metadata。
User Metadata 总数量/App ID	1 百万个	-	一个 App ID 下，最多可以存储 1 百万个 User Metadata 。超出软限制会收到错误提示。

Lock

类别	软限制	硬限制	说明
锁数量/频道	32 把	-	一个频道可以最多创建 32 把锁。如需创建更多数量的锁，联系声网 RTM 团队（rtm-support@agora.io）。
占有锁数量/客户端	无限制	-	单个客户端可以同时持有无限把锁。
锁 TTL（Locks Time to Live）	10 秒 - 300 秒	10 秒 - 300 秒	当用户离开频道或掉线时，该用户持有的锁会在设置的时间后自动释放。超出设定值后 SDK 会就近匹配边界值，例如：你设置了 400 秒，则 SDK 实际应用的 presenceTimeout 为 300 秒。
锁名长度	64 个 ASCII 字符	64 个 ASCII 字符	超出软限制会收到错误提示。
锁数量/App ID	1 百万把	-	一个 App ID 下最多可同时存在 1 百万把锁。超出软限制会收到错误提示。如需更多把锁，联系声网 RTM 团队（rtm-support@agora.io）。
获取锁的频率	10 次/秒	-	获取锁的 API 调用频率限制为 10 次/秒。