RTM Limitations

This page provides a brief overview of the limitations of the Agora RTM SDK for Android, including the maximum method call frequencies, maximum string length, unicode support and more.

Maximum Call Frequency

When mentioning a qps limitation, we are referring to the qps of an API in the context of one single RtmClient instance, not in the context of one Agora RTM SDK.

You can increase the qps limitation of an API by creating multiple RtmClient instances.

Function	Method	Maximum Call Frequency
Log in the RTM system	login	Two queries per second
Retrieve member count of specified channel(s)	getChannelMemberCount	one query per second
Join a channel¹	join	50 queries every three seconds
Send messages	sendMessageToPeer sendMessageToPeer And sendMessage taken together	60 queries per second
Retrieve a member list of the channel	getMembers	Five queries every two seconds
Renew the token	RtmClient.renewToken	Two queries per second
Query the online status of the specified user(s)	queryPeersOnlineStatus	Ten queries every five seconds.
Set user attributes	setLocalUserAttributes addOrUpdateLocalUserAttributes deleteLocalUserAttributesByKeys And clearLocalUserAttributes taken together	10 queries every five seconds
Get user attributes	getUserAttributes And getUserAttributesByKeys taken together	40 queries every five seconds
Set channel attributes	setChannelAttributes addOrUpdateChannelAttributes deleteChannelAttributesByKeys And clearChannelAttributes taken together	10 queries every five seconds
Get channel attributes	getChannelAttributes And getChannelAttributesByKeys taken together	10 queries every five seconds
Subscribes to the online status of the specified user(s)	subscribePeersOnlineStatus	Ten queries every five seconds.
Unsubscribes from the online status of the specified user(s)	unsubscribePeersOnlineStatus	Ten queries every five seconds.
Gets a list of the peers, to whose specific status you have subscribed.	queryPeersBySubscriptionOption	Ten queries every five seconds.
Subscribes to the online status of the specified user(s)	subscribePeersOnlineStatus	Ten queries every five seconds.
Unsubscribes from the online status of the specified user(s)	unsubscribePeersOnlineStatus	Ten queries every five seconds.
Gets a list of the peers, to whose specific status you have subscribed.	queryPeersBySubscriptionOption	Ten queries every five seconds.

¹ The maximum call frequency limit for joining the same channel is two queries every five seconds.

Timeout settings

Function	Timeout settings (s)
Log in the RTM system	6
Send peer messages	10
Query the online status of specified users	10
Subscribe to the online status of specified users	10
Unsubscribe from the online status of specified users	10
Query peers by subscription option	5
user attribute or channel attribute operations	5
Retrieve member count of specified channels	5
Join a channel	5
Send a channel message	10
Gets a member list of the channel	5

String Length

The maximum length of a peer-to-peer or channel message is 32 KB. See RtmMessage.setText.
The maximum length of the content in a call invitation is 8 KB. See LocalInvitation.setContent
The maximum length of the response in a call invitation is 8 KB. See RemoteInvitation.setResponse

Unicode support

Supports channel and peer-to-peer messages, invitation content, and invitation response in UTF-8 only.

Miscellaneous

Notifications of a member joining or leaving the channel are automatically disabled when the number of channel members exceeds 512..
The current version supports querying the online status of a maximum of 256 users.
Attribute settings in one user attribute operation should not exceed 16 KB in size; attribute settings in one channel attribute operation should not exceed 32 KB in size; each attribute (key/value pair) should not excced 8 KB in size; the number of key/value pairs you set in one attribute operation should not exceed 32.