v1.5.0 was released on July 27, 2022.
This release fixed the unit of timeout in output logs from milliseconds (ms) to seconds (s).
v1.4.5 was released on May 31, 2022.
This release improved the following issues:
subscribePeersOnlineStatusexceeds the limit of 10 calls every five seconds, the SDK returns the
This release fixed an issue where the Agora RTM Web SDK could reconnect to the RTM system when the Safari browser or tab was running in the macOS background.
v1.4.4 was released on December 24, 2021.
Fixed an issue where the Agora RTM Web SDK could reconnect to the RTM system (with the connection status RECONNECTING) when the browser or tab was running in the background, if the RTM Web SDK was used in Chrome 88 or higher.
v1.4.3 was released on May 27, 2021.
Firewall domain whitelist
As of v1.4.3, the list of destination domains required for your firewall whitelist changes to the following:
If you upgrade the SDK to v1.4.3, update your firewall domain whitelist to ensure you can use Agora products in environments with restricted network access.
This release adds the
AgoraRTM.setArea method for specifying the region for connection. After specifying the region, the SDK connects to the Agora servers within that region. The following regions are supported:
If you specify the region for connection as GLOBAL, you can use the excludeArea parameter in the AgoraRTM.setArea method to remove individual region from the regions for connection possibilities.
v1.4.2 was released on March 2, 2021.
setParametersmethod in terms of naming, this version adds the
updateConfigmethod, which is a duplicate of the
updateConfigmethod deprecates the
contentis greater than 8 KB, the
INVITATION_API_CALL_ERR_INVALID_ARGUMENTerror code is triggered when calling
sendinstead of calling
window.sha1 = require('js-sha1')
isHistoricalMessagemember variable is removed from the
downloadMedia. The SDK supports automatically detecting and adding the following MIME types:
isHistoricalMessage member variable in
v1.4.1 was released on November 5, 2020.
Fixed the performance issue when communicating with the RTM Native SDK.
v1.4.0 was released on September 25, 2020.
v1.4.0 supports only TypeScript 3.8 or higher.
Geofencing. You can use the
areaCodes parameter in
createInstance to set the region of the Agora RTM SDK. The RTM SDK can only connect to Agora RTM servers within the specified region.
areaCodes parameter is added to
v1.3.1 was released on August 7, 2020.
TokenExpiredcallback could not be triggered in time.
v1.3.0 was released on June 16, 2020.
You can call
createMediaMessageByUploading to upload non-empty files or image files no greater than 30 MB. Each uploaded file or image stays in the Agora server for seven days. The SDK returns a media ID as the unique identifier of the file or image file. You can use the
RtmFileMessage interface or the
RtmImageMessage interface to save the media ID. The
RtmFileMessage interface and the
RtmImageMessage interface are type aliases of the
RtmMessage interface, so you can send and receive file or image messages via peer-to-peer or channel message methods. You can call
downloadMedia to download the received file or image file.
You can use the
mediaTransferHandler interface to cancel or report the progress of an upload or download task.
Fixed the login issues for some users.
v1.2.2 was released on February 21, 2020.
|Send a channel message.||5 s||10 s|
The SDK occasionally returns
LOGIN_ERR_UNKNOWN when logging in from a recent version of Chrome on a Windows platform.
v1.2.1 was released on December 17, 2019.
Compatible with the endCall method of the Agora Signaling SDK
If you use the
sendMessageToPeer method to send a text message in the format of AgoraRTMLegacyEndcallCompatibleMessagePrefix_<channelId>_<your additional information>, then this method is compatible with the endCall method of the legacy Agora Signaling SDK. Replace <channelId> with the channel ID from which you want to leave (end call), and replace <your additional information> with any additional information. Note that you must not put any "_" (underscore) in your additional information but you can set <your additional information> as empty "".
v1.2.0 was released on November 15, 2019.
When the method call succeeds, the SDK returns the PeersOnlineStatusChanged callback to report the online status of peers, to whom you subscribe.
When the online status of the peers, to whom you subscribe, changes, the SDK returns the PeersOnlineStatusChanged callback to report whose online status has changed.
If the online status of the peers, to whom you subscribe, changes when the SDK is reconnecting to the server, the SDK returns the PeersOnlineStatusChanged callback to report whose online status has changed when successfully reconnecting to the server.
Allows you to unsubscribe from the online status of the specified user(s).
Allows you to get a list of the peers, to whose specific status you have subscribed.
Creates and initializes a raw message to be sent.
If you set a text description, ensure that the size of the raw message and the description combined does not exceed 32 KB.
The SDK is occasionally kicked by the server: When the issue occurs, the Client instance receives the
ConnectionStateChange callback, which indicates the connection state is
ABORTED and the reason for the connection state change
INTERRUPTED. The log file shows the error code from the server is 10001.
v1.1.0 was released on September 18, 2019. It adds the following features:
You can now get the member count of specified channel(s) without the need to join, by calling the
getChannelMemberCount method. You can get the member counts of a maximum of 32 channels in one method call.
If you are already in a channel, you do not have to call the
getChannelMemberCount method to get the member count of the current channel. We also do not recommend using
onMemberLeft to keep track of the member counts. As of this release, the SDK returns to the channel members
MemberCountUpdated the latest channel member count when the number of channel members changes. Note that:
Supports setting or getting the attribute(s) of a specified channel. You can use this feature to create group anouncement.
Each channel attribute comes as a key-value pair. See RtmChannelAttribute for more information. Where:
When updating attributes of a channel, you can use the
enableNotificationToChannelMembers flag to decide whether or not to notify all members of the channel about this attribute change.
This release improves the resending mechanism of peer-to-peer messages, and extends the timeout for sending a peer-to-peer message from five to 10 seconds, greatly improving the success rate of peer-to-peer message sending under weak network conditions.
The Agora RTM system will resend a maximum of 32 channel messages of up to 30 seconds to channel members, when they manage to reconnect to the system from poor network conditions. This greatly improves the overall arrival rate of channel messages under weak network conditions.
v1.0.1 was released on September 5, 2019.
v1.0.0 was released on August 5th, 2019.
v1.0.0 implements the
- To intercommunicate with the legacy Agora Signaling SDK, you MUST set the channel ID. However, even if the callee successfully accepts the call invitation, the Agora RTM SDK does not join the channel of the specified channel ID.
- If your App does not involve the legacy Agora Signaling SDK, we recommend using the
RemoteInvitation.responseproperty to set customized contents.
Supports setting the output log level of the SDK using the
logFilter parameter. The log level follows the sequence of OFF, ERROR, WARNING, and INFO. Choose a level to see the logs preceding that level. If, for example, you set the log level to WARNING, you see the logs within levels ERROR and WARNING.
v0.9.3 was released on July 24th, 2019.
This version allows you to send a message to a specified user when he/she is offline. If you set a message as an offline message and the specified user is offline when you send it, the RTM server caches it. Please note that for now we only cache 200 offline messages for up to seven days for each receiver. When the number of the cached messages reaches this limit, the newest message overrides the oldest one.
This version allows you to set or update a user's attributes. You can:
The attributes you set will be cleard when you log out of the RTM system.
This release introduces a new concept: online and offline.
This release adds the function of querying the online status of the specified users. After logging in the Agora RTM system, you can get the online status of a maximum of 256 specified users.
This release allows you to renew a token.
v0.9.1 was released on May 20th, 2019.
This release adds the call invitation feature, allowing you to create, send, cancel, accept, and decline a call invitation in a one-to-one or one-to-many voice/video call.
RtmClient.ConnectionStateChangeto ConnectionStateChanged .
RtmChannel.getId()method. Uses the channelId property instead.
v0.9.0 was released on February 14th, 2019.