Documentation
Video Call (Legacy)
Console 官网 Community Technical support
English
search-icon

Use Cloud Proxy (Web SDK 4.x)

Last updated 2022/03/11 03:23:40

To allow users to use the Agora RTC Web SDK in environments with restricted network access, Agora provides the cloud proxy service.

This page describes the use of cloud proxy with the Agora RTC Web SDK v4.x.

  • When using the cloud proxy service, Agora recommends using the latest version of Chrome, Firefox, and Safari.
  • The cloud proxy service is not supported on mobile devices.

High-level overview

This section provides a high-level overview of the Agora Cloud Proxy solution and supported cloud proxy modes.

The following network diagram shows the basic working principles of the Agora Cloud Proxy.

  1. The Agora SDK sends a request to the Agora cloud proxy. The Agora cloud proxy returns the proxy information.
  2. The Agora SDK sends data to the Agora cloud proxy. The Agora cloud proxy forwards the data to Agora SD-RTN™ (Software Defined Real-time Network).
  3. Agora SD-RTN™ sends data to the Agora cloud proxy. The Agora cloud proxy forwards the data to the Agora SDK.

Supported modes

To ensure connectivity in restricted network environments, the Agora Cloud Proxy service supports the following modes:

Mode Description Applicable scenario Pricing plan How to enable
Automatic The SDK attempts a direct connection to Agora SD-RTN™, and automatically falls back to TCP/TLS 443 if the attempt fails.① Used when users might be behind a firewall. No additional charges. The SDK uses this mode by default as of v4.9.0.
Off The SDK always connects to Agora SD-RTN™. Used when users are not behind a firewall. No additional charges. The SDK uses this mode by default before v4.9.0.
Force UDP The SDK transmits data over UDP. This mode ensures a higher-quality video and audio experience. Used when users are behind a firewall and require high-quality media. You need to pay for this mode. You must configure the firewall to allow specific IP addresses and ports provided by Agora. Follow the procedures in Prerequisites and Implementation to enable this cloud proxy mode.
Force TCP The SDK transmits data over TCP/TLS 443. Used when users are behind a firewall and the security policy allows data to flow through TCP/TLS 443 only. You need to pay for this mode. You must configure the firewall to allow specific IP addresses and ports provided by Agora. Follow the procedures in Prerequisites and Implementation to enable this cloud proxy mode.

① Automatic fallback typically occurs within 2 seconds.

Prerequisites

Before proceeding, ensure that you meet the following requirements:

  1. Download the Agora RTC Web SDK v4.x.
  2. Integrate the SDK and prepare the development environment. For details, see QuickStart Guide.
  3. Contact Agora technical support and provide the following information:
    • Your App ID.
    • The regions using the cloud proxy.
    • The concurrent scale.
    • Network operators.

Implementation

Choose the implementation based on your SDK version.

Add firewall allowed list

To use the Agora cloud proxy service, you must allow certain IP addresses and ports in your firewall to access the access point (AP) service, signaling service, and media service. The following provides the allowed IP list for both UDP and TCP cloud proxy. Refer to the table according to the mode of cloud proxy you want to use, and add the IP addresses and ports in the table to your firewall allowed IP list.

  • In addition to port 443, DNS resolution port 53 also needs to be opened.
  • Agora recommends configuring the Cloud Proxy network segment in all regions. If you want to restrict the use of Cloud Proxy in a certain region, please use it together with Geo Fencing.

Web SDK v4.8.0 or later

Region IP List for Media Service IP List for Signaling and AP Service Port
North America
  • 128.14.195.192/28
  • 128.14.245.16/28
  • 128.14.72.80/28
  • 128.14.200.208/28
  • 148.153.109.60
  • 148.153.109.62
  • 148.153.109.51
  • 148.153.109.58
  • 148.153.109.59
  • 148.153.109.61
  • 148.153.109.52
  • 148.153.109.50
  • 148.153.109.49
  • 148.153.109.53
  • 148.153.163.40
  • 148.153.163.41
  • 148.153.163.42
  • 148.153.163.43
  • 148.153.163.44
  • 148.153.163.45
  • 148.153.163.46
  • 148.153.163.47
  • 148.153.163.48
  • 148.153.163.49
  • 128.14.247.143
  • 128.14.247.139
    		•
  • 47.252.17.251
  • 170.106.135.177
    		•
  • UDP: 443
  • TCP: 443
    		•
    Europe
  • 104.166.160.208/28
  • 23.236.110.32/28
  • 148.153.25.149
  • 148.153.25.148
  • 148.153.25.147
  • 148.153.25.146
  • 148.153.25.184
  • 148.153.93.18
  • 148.153.93.19
  • 148.153.93.24
  • 148.153.93.25
  • 148.153.93.27
  • 104.166.161.8
    		•
  • 47.254.149.145
  • 162.62.220.8
    		•
  • UDP: 443
  • TCP: 443
    		•
    India
  • 129.227.217.128/28
  • 129.227.108.208/28
  • 128.1.105.112/28
  • 148.153.140.193
  • 148.153.140.210
  • 148.153.140.198
  • 148.153.140.192
  • 148.153.140.199
  • 129.227.205.172
  • 122.10.255.148
    		•
  • 147.139.34.215
  • 129.226.26.104
    		•
  • UDP: 443
  • TCP: 443
    		•
    Japan
  • 129.227.113.112/28
  • 129.227.55.96/28
  • 164.52.24.41
  • 164.52.6.29
  • 164.52.24.44
  • 164.52.24.43
  • 103.101.125.21
  • 103.101.125.26
  • 103.101.125.20
  • 103.101.125.22
  • 122.10.153.90
  • 129.227.234.115
    		•
  • 47.245.7.250
  • 43.128.248.97
    		•
  • UDP: 443
  • TCP: 443
    		•
    Southeast Asia
  • 128.1.186.240/28
  • 129.227.73.32/28
  • 103.193.127.208/28
  • 164.52.103.188
  • 164.52.103.187
  • 164.52.103.189
  • 164.52.103.8
  • 164.52.103.9
  • 129.227.71.165
  • 129.227.156.23
    		•
  • 161.117.177.218
  • 104.250.52.195
    		•
  • UDP: 443
  • TCP: 443
    		•
    Mainland China
  • 14.29.38.144/28
  • 27.45.161.144/28
  • 183.232.200.144/28
  • 115.238.206.0/28
  • 106.3.209.0/28
  • 112.13.216.0/28
  • 219.153.111.128/28
  • 221.178.42.0/28
  • 113.207.12.0/28
  • 43.255.214.30
  • 43.255.214.29
  • 43.255.214.26
  • 140.210.84.223
  • 140.210.84.221
  • 140.210.84.222
  • 113.207.12.14
  • 219.153.111.143
  • 221.178.42.14
    		•
  • 139.196.42.124
  • 123.56.57.206
    		•
  • UDP: 443
  • TCP: 443
    		•

    Web SDK v4.3.0 - v4.7.x

    Region IP List for Media Service IP List for Signaling Service and AP Service Port
    North America
  • 128.14.195.192/28
  • 128.14.245.16/28
  • 128.14.72.80/28
  • 128.14.200.208/28
  • 148.153.109.60
  • 148.153.109.62
  • 148.153.109.51
  • 148.153.109.58
  • 148.153.109.59
  • 148.153.109.61
  • 148.153.109.52
  • 148.153.109.50
  • 148.153.109.49
  • 148.153.109.53
  • 148.153.163.40
  • 148.153.163.41
  • 148.153.163.42
  • 148.153.163.43
  • 148.153.163.44
  • 148.153.163.45
  • 148.153.163.46
  • 148.153.163.47
  • 148.153.163.48
  • 148.153.163.49
  • 128.14.247.139
  • 128.14.247.143
    		•
  • 47.252.17.251
  • 170.106.135.177
  • 47.74.211.17
  • 52.52.84.170
    		•
  • UDP: 443
  • TCP: 443
    		•
    Europe
  • 104.166.160.208/28
  • 23.236.110.32/28
  • 148.153.25.149
  • 148.153.25.148
  • 148.153.25.147
  • 148.153.25.146
  • 148.153.25.184
  • 148.153.93.18
  • 148.153.93.19
  • 148.153.93.24
  • 148.153.93.25
  • 148.153.93.27
  • 104.166.161.8
    		•
  • 47.254.149.145
  • 162.62.220.8
  • 47.74.211.17
  • 52.52.84.170
    		•
  • UDP: 443
  • TCP: 443
    		•
    India
  • 129.227.217.128/28
  • 129.227.108.208/28
  • 128.1.105.112/28
  • 148.153.140.193
  • 148.153.140.210
  • 148.153.140.198
  • 148.153.140.192
  • 148.153.140.199
  • 129.227.205.172
  • 122.10.255.148
    		•
  • 147.139.34.215
  • 129.226.26.104
  • 47.74.211.17
  • 52.52.84.170
    		•
  • UDP: 443
  • TCP: 443
    		•
    Japan
  • 129.227.113.112/28
  • 129.227.55.96/28
  • 164.52.24.41
  • 164.52.6.29
  • 164.52.24.44
  • 164.52.24.43
  • 103.101.125.21
  • 103.101.125.26
  • 103.101.125.20
  • 103.101.125.22
  • 122.10.153.90
  • 129.227.234.115
    		•
  • 47.245.7.250
  • 43.128.248.97
  • 47.74.211.17
  • 52.52.84.170
    		•
  • UDP: 443
  • TCP: 443
    		•
    Southeast Asia
  • 128.1.186.240/28
  • 129.227.73.32/28
  • 103.193.127.208/28
  • 164.52.103.188
  • 164.52.103.187
  • 164.52.103.189
  • 164.52.103.8
  • 164.52.103.9
  • 129.227.71.165
  • 129.227.156.23
    		•
  • 161.117.177.218
  • 104.250.52.195
  • 47.74.211.17
  • 52.52.84.170
    		•
  • UDP: 443
  • TCP: 443
    		•
    Mainland China
  • 14.29.38.144/28
  • 27.45.161.144/28
  • 183.232.200.144/28
  • 115.238.206.0/28
  • 106.3.209.0/28
  • 112.13.216.0/28
  • 219.153.111.128/28
  • 221.178.42.0/28
  • 113.207.12.0/28
  • 43.255.214.30
  • 43.255.214.29
  • 43.255.214.26
  • 140.210.84.223
  • 140.210.84.221
  • 140.210.84.222
  • 113.207.12.14
  • 219.153.111.143
  • 221.178.42.14
    		•
  • 139.196.42.124
  • 123.56.57.206
  • 52.80.192.229
  • 47.96.234.219
    		•
  • UDP: 443
  • TCP: 443
    		•

    Call API

    After adding the allowed IP list, do the following to enable cloud proxy:

    1. Before joining a channel, call startProxyServer to enable the cloud proxy service and set mode:
      • Set mode as 3 to use UDP mode.
      • Set mode as 5 to use TLS mode. (Only applicable to the Web SDK v4.5.0 or later)
    2. Test the audio and video call functionality.

    To disable the UDP, TCP, or TLS cloud proxy, call stopProxyServer, which enables the SDK to return the default mode.

    startProxyServer must be called before joining the channel, and stopProxyServer must be called after leaving the channel.