由于浏览器的安全策略对除 127.0.0.1 以外的 HTTP 地址作了限制，RTCSIP Web SDK 仅支持 HTTPS 协议或者 http://localhost （http://127.0.0.1），请勿使用 HTTP 协议部署你的项目。

1. 获取SDK

点击下载SDK

2. 开发语言及浏览器支持

• 开发语言：JavaScript
• 浏览器支持：PC上的WebKit内核浏览器、iOS上的Safari以及Android上的Chrome

3. 搭建开发环境

3.1 引入 SDK 文件

<script src="SDK目录/QZLinkRTCSipSDK.min.js"></script>

3.2 设置播放音视频流的HTML元素

<div id="stream_area"></div>

3.3 初始化实例

请在设置播放音视频流的HTML元素后，再初始化对象实例。

// 开启(true)/关闭(false)调试模式QZLinkRTCSip.debug = true// 初始化实例对象const rtcsip = new QZLinkRTCSip()

4. 实例方法

4.1 init(options[, success, fail])

登录服务器。

• options Object
• appid String - 应用ID
• username String - 应用账号
• password String - 应用密码
• host String - 服务器IP地址
• port String - 服务器端口
• element String - 播放音视频流的HTML元素ID
• joinType（可选） String - 用户进入房间的方式，默认值为connect。取值：connect - 在接听后进入；ringing - 在振铃后进入
• codec（可选） String - 浏览器使用的编码格式，默认值为vp8。有以下两种选择：vp8 - 浏览器使用 VP8 编码；h264 - 浏览器使用 H.264 编码。
• cameraResolution（可选） String - 视频属性，默认值为480p_1
• success(res) Function (可选) - 执行成功后的回调
• res Object
• userid String - 用户ID
• fail(err) Function (可选) - 执行失败后的回调
• err Object
• type String - 错误类型
• evt String - 事件名称
• reason String - 错误码
• msg String - 错误信息

rtcsip.init({  appid: '应用ID',  username: '应用账号',  password: '应用密码',  host: '服务器IP地址',  port: '服务器端口',  codec: 'vp8',  cameraResolution: '480p_1',  element: 'stream_area' // 播放音视频流的HTML元素ID}, res => {  console.log('登录成功：', res)}, err => {  console.error('登录失败: ' + err.msg)})

4.2 calling(callee[, options, success, fail])

发起通话请求。

远端会触发ringing事件。

• callee String - 被呼叫方的用户ID或者电话号码
• options Object
• isVideo Boolean - 是否视频通话，默认值为false。
• isSip Boolean - 是否SIP通话，默认值为false。
• gateway （可选）String - 网关。若通话为Call Sip模式，则必须传此值。
• success(res) Function (可选) - 执行成功后的回调
• res Object
• userid String - 用户ID
• caller String - 呼叫者ID
• callee String - 被呼者ID
• callType String - 呼叫类型：AUDIO(音频)、VIDEO(视频)
• sip Boolean - 是否SIP通话
• channel String - 通话频道ID
• fail(err) Function (可选) - 执行失败后的回调
• err Object
• type String - 错误类型
• evt String - 事件名称
• reason String - 错误码
• msg String - 错误信息

rtcsip.calling('被呼者ID', {  isVideo: false,  isSip: true,  gateway: '106.xx.xx.xx:15080'}, res => {  console.log('拨号成功：', res)}, err => {  console.error('拨号失败: ' + err.msg)})

4.3 answer([success, fail])

接受通话请求。

本地及远端都会触发connected事件。

• success(res) Function (可选) - 执行成功后的回调
• res Object
• userid String - 用户ID
• caller String - 呼叫者ID
• callee String - 被呼者ID
• callType String - 呼叫类型：AUDIO(音频)、VIDEO(视频)
• sip Boolean - 是否SIP通话
• channel String - 通话频道ID
• fail(err) Function (可选) - 执行失败后的回调
• err Object
• type String - 错误类型
• evt String - 事件名称
• reason String - 错误码
• msg String - 错误信息

4.4 hangup([success, fail])

取消/拒绝/挂断通话。

本地会触发hangup事件，远端会触发remote-cancel/remote-rejected/remote-disconnect事件

• success(res) Function (可选) - 执行成功后的回调
• res Object
• userid String - 用户ID
• caller String - 呼叫者ID
• callee String - 被呼者ID
• callType String - 呼叫类型：AUDIO(音频)、VIDEO(视频)
• sip Boolean - 是否SIP通话
• channel String - 通话频道ID
• fail(err) Function (可选) - 执行失败后的回调
• err Object
• type String - 错误类型
• evt String - 事件名称
• reason String - 错误码
• msg String - 错误信息

4.5 setJoinType(joinType)

设置用户进入房间的方式，若正在通话中执行此方法，则会返回USER_BUSY错误。

• joinType String - 用户进入房间的方式，默认值为connect。取值：connect - 在接听后进入；ringing - 在振铃后进入

rtcsip.setJoinType('`ringing`')

4.6 setCodec(codec)

设置浏览器使用的编码格式，若正在通话中执行此方法，则会返回USER_BUSY错误。

• codecString - 浏览器使用的编码格式，默认值为vp8。有以下两种选择：vp8 - 浏览器使用 VP8 编码；h264 - 浏览器使用 H.264 编码。

rtcsip.setCodec('h264')

4.7 setCameraResolution(cameraResolution)

设置视频属性，若正在通话中执行此方法，则会返回USER_BUSY错误。

• cameraResolution String - 视频属性，默认值为480p_1

rtcsip.setCameraResolution('720p_1')

5. 实例事件

5.1 事件：'error'

错误事件。

rtcsip.on('ringing', err => console.log(err))

返回：

• err Object
• type String - 错误类型
• evt String - 事件名称
• reason String - 错误码
• msg String - 错误信息

5.2 事件：'warning'

警告事件。

返回：

• err Object
• type String - 错误类型
• evt String - 事件名称
• reason String - 错误码
• msg String - 错误信息

5.3 事件：'ringing'

有远端通话请求时触发。

返回：

• evt Object
• userid String - 用户ID
• caller String - 呼叫者ID
• callee String - 被呼者ID
• callType String - 呼叫类型：AUDIO(音频)、VIDEO(视频)
• sip Boolean - 是否SIP通话
• channel String - 通话频道ID

5.4 事件：'connected'

通话连接建立后触发。

返回：

• evt Object
• userid String - 用户ID
• caller String - 呼叫者ID
• callee String - 被呼者ID
• callType String - 呼叫类型：AUDIO(音频)、VIDEO(视频)
• sip Boolean - 是否SIP通话
• channel String - 通话频道ID

5.5 事件：'hangup'

本地取消/拒绝/挂断通话后触发。

返回：

• evt Object
• userid String - 用户ID
• caller String - 呼叫者ID
• callee String - 被呼者ID
• callType String - 呼叫类型：AUDIO(音频)、VIDEO(视频)
• sip Boolean - 是否SIP通话
• channel String - 通话频道ID

5.6 事件：'remote-rejected'

远端拒绝通话后触发。

返回：

• evt Object
• userid String - 用户ID
• caller String - 呼叫者ID
• callee String - 被呼者ID
• callType String - 呼叫类型：AUDIO(音频)、VIDEO(视频)
• sip Boolean - 是否SIP通话
• channel String - 通话频道ID

5.7 事件：'remote-cancel'

远端取消通话后触发。

返回：

• evt Object
• userid String - 用户ID
• caller String - 呼叫者ID
• callee String - 被呼者ID
• callType String - 呼叫类型：AUDIO(音频)、VIDEO(视频)
• sip Boolean - 是否SIP通话
• channel String - 通话频道ID

5.8 事件：'remote-busy'

本地请求通话，而远端正在通话中时触发。

返回：

• evt Object
• userid String - 用户ID
• caller String - 呼叫者ID
• callee String - 被呼者ID
• callType String - 呼叫类型：AUDIO(音频)、VIDEO(视频)
• sip Boolean - 是否SIP通话
• channel String - 通话频道ID

5.9 事件：'remote-disconnect'

远端挂断通话时触发。

返回：

• evt Object
• userid String - 用户ID
• caller String - 呼叫者ID
• callee String - 被呼者ID
• callType String - 呼叫类型：AUDIO(音频)、VIDEO(视频)
• sip Boolean - 是否SIP通话
• channel String - 通话频道ID

5.10 事件：'remote-added'

远端音视频流添加后触发。

返回：

• evt Object
• streamId Int - 音视频流ID，用于控制其所在的HTML元素，id名称为video+streamId

5.11 事件：'remote-removed'

远端音视频流删除后触发。

返回：

• evt Object
• streamId Int - 音视频流ID，用于控制其所在的HTML元素，id名称为video+streamId

6. 错误码

• SOCKET_CONNECT_FAILED - 服务器连接失败
• SOCKET_LOGIN_ERROR - 用户登录失败
• SOCKET_RECONNECT - 重新连接服务器
• SOCKET_CLOSED - 服务器连接关闭
• CALLING_TIMEOUT - 远端未接受通话请求，等待超时
• USER_CALLING_ERROR - 通话呼出失败
• USER_ANSWER_ERROR - 通话接听失败
• USER_HANGUP_ERROR - 本地取消/拒绝/挂断通话失败
• PARAMETER_IS_INVALID - 缺少必要的参数
• USER_BUSY - 用户正在通话中