Options
All
  • Public
  • Public/Protected
  • All
Menu

NECCC sdk V1.0.0

NECCC

NECCC 提供完善的音视频通话 JavaScript 开发框架,提供VOIP和PSTN通话,支持在网页或者小程序中调用API快速建立实时音通话,提供接打电话的服务。

完整的 NERTC Web SDK 由 NECCC、UserAgent 和 RtcSession 三部分组成。

  • NECCC 是 sdk 基础对象,是所有可调用方法的入口。
  • UserAgent 是UA对象,作为电话终端,具备注册、注销、呼叫等能力。
  • RtcSession 实时音会话实例,提供接听、挂断、mute、hold等基础功能。

NECCC 对象

方法 功能描述
NECCC.UA 创建客户端
NECCC.destroy 销毁客户端

UserAgent 软电话软终端对象

连接服务器

方法 功能描述
UserAgent.init 初始化,初始化成功后可自动连接服务,并进行会话相关控制
UserAgent.isReady 查看服务器连接是否已准备就绪,已就绪则可以进行其他处理
UserAgent.getCause 查看服务器连接是否已准备就绪,若没有准备好,则可以查看具体原因
UserAgent.register UA主动主动注册到服务器
UserAgent.unregister UA主动主动注销
UserAgent.connect UA连接服务;用户主动行为,连接结果通过事件通知
UserAgent.disconnect UA断开服务器的连接;用户主动行为,连接结果通过事件通知
UserAgent.isConnected UA连接服务状态
RtcSession.destroy 销毁UA对象。

会话相关

方法 功能描述
UserAgent.call UA坐席软电话外呼用户手机
UserAgent.getSession 获取当前正在进行的会话对象实例

RtcSession 对象

会话管理

方法 功能描述
RtcSession.isEstablished 判断会话是否已接通
RtcSession.isEnded 判断会话是否已结束
RtcSession.accept 应答呼入的会话
RtcSession.bye 终止当前会话,无论呼入或呼出

会话媒体控制

方法 功能描述
RtcSession.sendDTMF 发送DTMF按键
RtcSession.mute 静音本地音视频,无论呼入或呼出
RtcSession.unmute 解除静音,无论呼入或呼出;
RtcSession.isMuted 当前是否处于静音中,无论呼入或呼出
RtcSession.hold 会话保持,无论呼入或呼出;
RtcSession.unhold 解除会话保持,无论呼入或呼出
RtcSession.isOnHold 会话保持状态,无论呼入或呼出;

事件

通过 UserAgent.onRtcSession.on 方法监听 UserAgentRtcSession 方法触发的事件。