Dev Center
Video Call
Agora.io Community
English
search-icon
Use Cloud Proxy
Last updated 2020/12/22 05:51:47

Introduction

To allow users to use the Agora RTC Native SDK in environments with restricted network access, Agora provides a cloud proxy. Users only need to add specific IP addresses and ports to the firewall whitelist, and call the API to configure the Agora cloud proxy service.

Working principles

  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.

Implementation

  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.

  4. Add all the IP addresses and ports in the appropriate table to your firewall whitelist.

    • If your SDK is v3.2.0 or later, refer to the following table.

      Protocol Destination IP address Port Comment
      UDP 140.210.77.68 (Mainland China) 8443 Used to access Agora services
      UDP 125.88.159.163 (Mainland China) 8443 Used to access Agora services
      UDP 128.1.87.146 (Asia, excluding Mainland China) 8443 Used to access Agora services
      UDP 128.1.77.34 (Europe) 8443 Used to access Agora services
      UDP 128.1.78.146 (Europe) 8443 Used to access Agora services
      UDP 69.28.51.142 (North America) 8443 Used to access Agora services
      UDP 107.155.14.132 (North America) 8443 Used to access Agora services
      UDP 106.3.140.194 (Mainland China) 8001 - 8005, 4590 - 4600 Used for the Agora cloud proxy service
      UDP 106.3.140.195 (Mainland China) 8001 - 8005, 4590 - 4600 Used for the Agora cloud proxy service
      UDP 164.52.53.77 (Asia, excluding Mainland China) 8001 - 8005, 4590 - 4600 Used for the Agora cloud proxy service
      UDP 164.52.53.78 (Asia, excluding Mainland China) 8001 - 8005, 4590 - 4600 Used for the Agora cloud proxy service
      UDP 128.1.78.94 (Europe) 8001 - 8005, 4590 - 4600 Used for the Agora cloud proxy service
      UDP 148.153.53.105 (North America) 8001 - 8005, 4590 - 4600 Used for the Agora cloud proxy service
      UDP 148.153.53.106 (North America) 8001 - 8005, 4590 - 4600 Used for the Agora cloud proxy service

    • If your SDK is earlier than v3.2.0, refer to the following table.

      Some IP addresses and ports in the following table are for testing purposes only. In a production environment, you must apply to Agora for the official IP addresses and ports that replace them.
      Protocol Destination IP address Port Comment
      TCP 47.74.211.17 1080, 8000, 25000, 9700 Used to access Agora services
      TCP 52.80.192.229 1080, 8000, 25000, 9700 Used to access Agora services
      TCP 52.52.84.170 1080, 8000, 25000, 9700 Used to access Agora services
      TCP 47.96.234.219 1080, 8000, 25000, 9700 Used to access Agora services
      UDP 47.74.211.17 1080, 8000, 25000, 9700 Used to access Agora services
      UDP 52.80.192.229 1080, 8000, 25000, 9700 Used to access Agora services
      UDP 52.52.84.170 1080, 8000, 25000, 9700 Used to access Agora services
      UDP 47.96.234.219 1080, 8000, 25000, 9700 Used to access Agora services
      TCP 120.92.118.34 4000 Used for the Agora cloud proxy service (for testing purpose only)
      TCP 120.92.18.162 4000 Used for the Agora cloud proxy service (for testing purpose only)
      UDP 120.92.118.34 4500 - 4650 Used for the Agora cloud proxy service (for testing purpose only)
      UDP 120.92.18.162 4500 - 4650 Used for the Agora cloud proxy service (for testing purpose only)

  5. Enable the cloud proxy service by calling setParameters("{\"rtc.enable_proxy\":true}");.

  6. After you enable the cloud proxy service, Agora configures the service by default. If the default configuration does not meet your requirements, call setParameters("{\"rtc.proxy_server\":[2, \"[\"ip1\",\"ip2\",\"ip3\"]\", 0]}"); to use IP addresses to configure the cloud proxy service.

  7. Test the audio and video call functionality.

To disable the cloud proxy service, call setParameters("{\"rtc.enable_proxy\":false}");.

Sample code

// Enables the cloud proxy server and configures the service by default.
setParameters("{\"rtc.enable_proxy\":true}");
// Enables the cloud proxy server and uses IP addresses for configuration.
setParameters("{\"rtc.enable_proxy\":true}");
// The following IP addresses are just examples. You need to fill in all the IP addresses that need to be opened.
setParameters("{\"rtc.proxy_server\":[2, \"[\"128.1.87.146\",\"164.52.53.77\",\"164.52.53.78\"]\", 0]}");

Considerations

  • The setParameters method must be called before joining a channel or after leaving a channel.
  • When you use the cloud proxy, the services for pushing streams to CDN and co-hosting across channels are not available.
score