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

Use Cloud Proxy

Last updated 2021/12/30 06:44:55

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

This page describes the use of the Agora Cloud Proxy with the Agora RTC Native SDK v3.4.0 or later.

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 has this mode enabled by default.
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, complete the following steps:

  1. Download the Agora RTC Native SDK.
  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

Add allowed IP list

To use the Agora Cloud Proxy service for the Force UDP or Force TCP modes, you must configure your firewall to trust specific allowed IP addresses and ports. The tables below provide the Allowed IP list for the Force UDP and Force TCP modes.

To ensure high availability of the Agora Cloud Proxy service, Agora recommends configuring your firewall to trust all the IP addresses and ports specified in the tables below. If you want to restrict the use of the Agora Cloud Proxy in a certain geographic region, ensure that you use SDK version v3.4.8, v3.4.11, v3.5.0.3, or any version later than v3.5.0.3, and enable the network geofencing function.

Allowed IP list for the Force UDP mode

Mainland China

IP address Protocol Port Used to
  • 106.14.12.130
  • 118.190.148.38
    		•  UDP 8443 Access the signaling service
  • 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
  • 106.3.140.194
  • 106.3.140.195
    		•  UDP
  • 4590-4600
  • 8001-8010
    		•  Access the media service

    Asia, excluding Mainland China

    IP address Protocol Port Used to
  • 54.178.26.110
  • 52.221.23.86
  • 13.230.60.35
    		•  UDP 8443 Access the signaling service
  • 128.1.186.240/28
  • 129.227.73.32/28
  • 103.193.127.208/28
  • 164.52.53.77
  • 164.52.53.78
    		•  UDP
  • 4590-4600
  • 8001-8010
    		•  Access the media service

    Japan

    IP address Protocol Port Used to
  • 54.178.26.110
  • 52.221.23.86
  • 13.230.60.35
    		•  UDP 8443 Access the signaling service
  • 129.227.113.112/28
  • 129.227.55.96/28
  • 122.10.153.74
  • 129.227.234.123
  • 122.10.153.86
  • 103.101.125.23
  • 164.52.24.42
    		•  UDP
  • 4590-4600
  • 8001-8010
    		•  Access the media service

    India

    IP address Protocol Port Used to
  • 15.206.47.129
  • 13.127.149.196
    		•  UDP 8443 Access the signaling service
  • 129.227.217.128/28
  • 129.227.108.208/28
  • 128.1.105.112/28
  • 129.227.205.170
  • 122.10.255.145
  • 128.1.105.158
    		•  UDP
  • 4590-4600
  • 8001-8010
    		•  Access the media service

    Europe

    IP address Protocol Port Used to
  • 35.156.231.150
  • 15.237.134.178
    		•  UDP 8443 Access the signaling service
  • 104.166.160.208/28
  • 23.236.110.32/28
  • 104.166.142.134
  • 104.166.161.4
  • 128.1.78.94
    		•  UDP
  • 4590-4600
  • 8001-8010
    		•  Access the media service

    North America

    IP address Protocol Port Used to
  • 184.72.16.87
  • 35.168.106.53
    		•  UDP 8443 Access the signaling service
  • 128.14.195.192/28
  • 128.14.245.16/28
  • 128.14.72.80/28
  • 128.14.200.208/28
  • 148.153.53.105
  • 148.153.53.106
    		•  UDP
  • 4590-4600
  • 8001-8010
  		•  Access the media service

    Allowed IP list for the Force TCP mode

    Mainland China

    IP address Protocol Port Used to
  • 101.132.108.165
  • 123.56.235.221
    		•  TCP 443 Access the signaling service
  • 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
  • 106.3.140.194
  • 106.3.140.195
    		•  TCP 443 Access the media service

    Asia, excluding Mainland China

    IP address Protocol Port Used to
  • 13.250.89.184
  • 18.176.162.64
    		•  TCP 443 Access the signaling service
  • 128.1.186.240/28
  • 129.227.73.32/28
  • 103.193.127.208/28
  • 164.52.53.77
  • 164.52.53.78
    		•  TCP 443 Access the media service

    Japan

    IP address Protocol Port Used to
  • 13.250.89.184
  • 18.176.162.64
    		•  TCP 443 Access the signaling service
  • 129.227.113.112/28
  • 129.227.55.96/28
  • 122.10.153.74
  • 129.227.234.123
  • 122.10.153.86
  • 103.101.125.23
  • 164.52.24.42
    		•  TCP 443 Access the media service

    India

    IP address Protocol Port Used to
  • 13.250.89.184
  • 18.176.162.64
    		•  TCP 443 Access the signaling service
  • 129.227.217.128/28
  • 129.227.108.208/28
  • 128.1.105.112/28
  • 129.227.205.170
  • 122.10.255.145
  • 128.1.105.158
    		•  TCP 443 Access the media service

    Europe

    IP address Protocol Port Used to
  • 52.28.239.238
  • 3.9.120.239
    		•  TCP 443 Access the signaling service
  • 104.166.160.208/28
  • 23.236.110.32/28
  • 104.166.142.134
  • 104.166.161.4
  • 128.1.78.94
    		•  TCP 443 Access the media service

    North America

    IP address Protocol Port Used to
  • 52.54.85.111
  • 184.72.18.217
    		•  TCP 443 Access the signaling service
  • 128.14.195.192/28
  • 128.14.245.16/28
  • 128.14.72.80/28
  • 128.14.200.208/28
  • 148.153.53.105
  • 148.153.53.106
    		•  TCP 443 Access the media service

    Call API

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

    After configuring your firewall to trust the Allowed IP list, do the following to enable the Force UDP or Force TCP cloud proxy mode:

    1. Call setCloudProxy, and set proxyType as UDP_PROXY(1) or TCP_PROXY(2).
    2. Test the audio and video call functionality.

    To disable the Force UDP or Force TCP cloud proxy mode, call setCloudProxy and set proxyType as NONE_PROXY(0), which enables the SDK to return the Automatic (default) mode.

    Considerations

    • You need to call setCloudProxy before using the Agora Cloud Proxy Force UDP or Force TCP mode. For example, if you need to enable cloud proxy to join a channel, call setCloudProxy before joinChannel. If you need to enable cloud proxy to conduct a lastmile test, call setCloudProxy before startLastmileProbeTest. The settings of setCloudProxy takes effect within the life cycle of RtcEngine.
    • The Force UDP mode of the Agora Cloud Proxy does not support pushing streams to Content Delivery Networks (CDNs) or relaying streams across channels.