使用云代理服务

功能描述

大型企业、医院、高校、银行等安全需求较高的机构会部署防火墙将办公环境与外网隔离开来，保护内部信息安全。

为避免这些企业用户因防火墙无法使用 Agora 的服务，Agora 提供云代理服务。

工作原理

Agora 云代理的工作原理如下：

1. Agora SDK 在连接 Agora SD-RTN™ 之前，向云代理发起请求。
2. 云代理发送相应代理信息。
3. Agora SDK 向云代理发送数据，云代理将接收到的数据透传给 Agora SD-RTN™。
4. Agora SD-RTN 向云代理返回数据，云代理再将接收到的数据发送给 Agora SDK。

实现方法

Web SDK v3.4.0 或以上

自 Web SDK v3.4.0 起，Agora 优化了云代理架构，进一步加强了有网络访问限制的环境中 SDK 的连通性，同时支持限定访问区域。如果你使用的是 Web SDK v3.4.0 或以上版本（不包含 4.x），参考以下步骤使用云代理服务：

1. 申请开通云代理服务

联系 sales@agora.io 或技术支持申请开通云代理服务，并提供以下信息：

• App ID
• 代理服务使用区域
• 并发规模
• 网络运营商

2. 客户端开启云代理功能

成功开通后，在加入频道前调用 startProxyServer 方法打开云代理功能，并将 type 参数设为 3，然后测试是否能正常实现音视频通话或直播。

var client = AgoraRTC.createClient({mode: 'live',codec: 'vp8'});

// 开启云代理
client.startProxyServer(3);
// 加入频道
client.init(key, function() {
    client.join(channelKey, channel, null, function(uid) {
      /** ... **/
    })
})

3. 客户端关闭云代理功能

如果需要关闭代理，请在离开频道后调用 stopProxyServer。

// 开启云代理并加入频道后
/** ... **/
// 离开频道
client.leave();

// 关闭云代理服务
client.stopProxyServer();

// 重新加入频道
client.join(channelKey, channel, null, function(uid) {
 /** ... **/
}

Web SDK v2.5.1 - v3.3.1

如果你使用的是 Web SDK v2.5.1 至 v3.3.1，参考以下步骤使用云代理服务：

1. 申请开通云代理服务

联系 sales@agora.io 或技术支持申请开通云代理服务，并提供以下信息：

• App ID
• 代理服务使用区域
• 并发规模
• 网络运营商

2. 添加防火墙白名单

将以下测试 IP 及端口添加到企业防火墙的白名单。

源地址为集成了 Web SDK 的客户端。

国内测试

国外测试

3. 客户端开启云代理功能

在加入频道前调用 startProxyServer 方法打开云代理功能，测试是否能正常实现音视频通话或直播。

var client = AgoraRTC.createClient({mode: 'live',codec: 'vp8'});

// 开启云代理
client.startProxyServer();
// 加入频道
client.init(key, function() {
    client.join(channelKey, channel, null, function(uid) {
        .......
    })
})

测试完成后，Agora 会为你部署云代理服务正式环境，并提供相应的 IP 和端口。将 Agora 提供的 IP 和端口添加到企业防火墙的白名单。

4. 客户端关闭云代理功能

如果需要关闭云代理，请在离开频道后调用 stopProxyServer。

// 开启云代理并加入频道后
...
// 离开频道
client.leave();

// 关闭云代理服务
client.stopProxyServer();

// 重新加入频道
client.join(channelKey, channel, null, function(uid) {

 ...

}

API 参考

• startProxyServer
• stopProxyServer

开发注意事项

• startProxyServer 和 stopProxyServer 必须在加入频道前或离开频道后调用。
• Agora Web SDK 还提供 setProxyServer 和 setTurnServer 两个方法给用户自行部署代理服务器。这两个方法与 startProxyServer 不可同时调用，调用了其中任一个方法，再调用 startProxyServer 会报错，反之亦然。
• stopProxyServer 会关闭所有代理服务，包括通过 setProxyServer 和 setTurnServer 设置的代理。