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

Agora RTM Web API Reference

概览 Globals AgoraRTM RtmClient RtmMessage RtmChannel LocalInvitation RemoteInvitation RtmErrorCode RtmStatusCode

AgoraRTM 是 Agora RTM SDK 的导出模块。

使用 <script> 标签引入 SDK 时，产生名为 AgoraRTM 的全局变量，该变量含有该模块的所有成员。

example

直接在 HTML 中引入 <script src="agora-rtm-sdk-0.9.1.js"></script>。

Note:

此处文件名 agora-rtm-sdk-0.9.1.js 中的版本号 0.9.1 仅供参考，安装时请使用最新版的 SDK 和链接地址。

Index

Variables

Functions

Variables

Const AreaCode

AreaCode: keyof typeof AreaCode

Agora RTM 服务的限定区域。默认为 AgoraAreaGLOB，即限定区域为全球。详见 AreaCode。

Const BUILD

BUILD: string

Agora RTM SDK 的编译信息。

Const ConnectionChangeReason

ConnectionChangeReason: keyof typeof ConnectionChangeReason

连接状态改变原因。

Const ConnectionState

ConnectionState: keyof typeof ConnectionState

连接状态。

Const END_CALL_PREFIX

END_CALL_PREFIX: string

Const LOG_FILTER_ERROR

LOG_FILTER_ERROR: LogFilterType

输出 ERROR 级别的日志信息。

Const LOG_FILTER_INFO

LOG_FILTER_INFO: LogFilterType

输出 ERROR、WARNING 和 INFO 级别的日志信息。 我们推荐你将日志级别设为该等级。

Const LOG_FILTER_OFF

LOG_FILTER_OFF: LogFilterType

不输出日志信息。

Const LOG_FILTER_WARNING

LOG_FILTER_WARNING: LogFilterType

输出 ERROR 和 WARNING 级别的日志信息。

Const LocalInvitationFailureReason

LocalInvitationFailureReason: keyof typeof LocalInvitationFailureReason

（返回给主叫）呼叫邀请失败原因。

Const LocalInvitationState

LocalInvitationState: keyof typeof LocalInvitationState

返回给主叫的呼叫邀请状态。

Const MessageType

MessageType: keyof typeof MessageType

消息类型。

Const PeerOnlineState

PeerOnlineState: keyof typeof PeerOnlineState

用户的在线状态。

Const PeerSubscriptionOption

PeerSubscriptionOption: keyof typeof PeerSubscriptionOption

订阅类型。

Const RemoteInvitationFailureReason

RemoteInvitationFailureReason: keyof typeof RemoteInvitationFailureReason

（返回给被叫）呼叫邀请失败原因。

Const RemoteInvitationState

RemoteInvitationState: keyof typeof RemoteInvitationState

返回给被叫的呼叫邀请状态。

Const VERSION

VERSION: string

Agora RTM SDK 的版本号。

Functions

createInstance

  • 该方法创建并返回一个 RtmClient 实例。

    Agora RTM SDK 支持多个 RtmClient 实例。

    RtmClient 类的所有接口函数都是异步调用。

    example

    创建 RtmClient 对象

    import AgoraRTM from 'agora-rtm-sdk';
const client = AgoraRTM.createInstance('demoAppId', { enableLogUpload: false }); // Pass your App ID here.

    Parameters

    • appId: string

      传入项目的 App ID。必须是 ASCII 编码，长度为 32 个字符。

    • Optional config: RtmConfig

      RtmClient 对象的配置参数。详见 RtmConfig。

    Returns RtmClient

    一个 RtmClient 实例。

  • deprecated

    从 v1.4.3 起废弃，声网不建议你使用。请改用 createInstance 方法。 该方法创建并返回一个 RtmClient 实例。

    Agora RTM SDK 支持多个 RtmClient 实例。

    RtmClient 类的所有接口函数都是异步调用。

    example

    创建 RtmClient 对象

    import AgoraRTM from 'agora-rtm-sdk';
const client = AgoraRTM.createInstance('demoAppId', { enableLogUpload: false }); // Pass your App ID here.

    Parameters

    • appId: string

      传入项目的 App ID。必须是 ASCII 编码，长度为 32 个字符。

    • Optional config: RtmConfig

      RtmClient 对象的配置参数。详见 RtmConfig。

    • Optional areaCodes: AreaCode[]

      Agora RTM 服务的限定区域。详见 AreaCode。

    Returns RtmClient

    一个 RtmClient 实例。

setArea

  • setArea(areaConfig: object): void
  • since

    1.4.3

    设置 Agora RTM SDK 的访问区域。支持设置多个访问区域。

    注意：

    • 该功能为高级设置，适用于有访问安全限制的场景。
    • 默认情况下，SDK 会就近选择 Agora 服务器进行连接。设置访问区域之后，SDK 只会连接到指定区域内的 Agora 服务器。
    • 该方法支持去除访问区域中的个别区域。

    Parameters

    • areaConfig: object

      访问区域设置。

      • areaCodes 访问区域，详见 AreaCode。
      • excludedArea 排除区域，支持设置为CHINA，JAPAN 和 ASIA。该参数仅对于 GLOBAL 的访问区域有效。

    Returns void