Connect with Cloud Proxy

Take the following steps to use Cloud proxy in your app:

1. Enable Cloud Proxy in Agora Console:

   1. Log in to the console.

   2. Under Projects, locate the project that you want to edit, then click Configure.

   3. Under All Features, select Cloud Proxy.

   4. Click Enable Cloud Proxy.

      

2. Configure the enterprise firewall to allow traffic from the IP address and port ranges in the Agora Allowed IP List.

3. Call setCloudProxy and set proxyType to TRANSPORT_TYPE_UDP_PROXY or TRANSPORT_TYPE_TCP_PROXY to enable Cloud proxy.

4. Test if you can initiate audio and video calls or live broadcasts normally.

5. To stop using Cloud proxy, call setCloudProxy and set proxyType to TRANSPORT_TYPE_NONE_PROXY.

6. To update the current proxyType, call setCloudProxy(TRANSPORT_TYPE_NONE_PROXY) first, then call setCloudProxy again with the new proxyType.

Call setCloudProxy outside the channel. Its settings are valid within the RtcEngine life cycle.

Reference

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

Pricing

Agora charges for use of Cloud Proxy as follows.

Duration-based pricing

Duration-based pricing is based on the total number of minutes used per month across all users.

For volume pricing discount, contact Agora support.

PCU-based pricing

PCU is the maximum number of simultaneous users connected to the Cloud Proxy service at any point during the billing cycle. For PCU-based usage, Agora charges $500.00 for each VID.

For volume pricing discount, contact Agora support.

IP addresses for Cloud Proxy

To use Agora Cloud Proxy, your end users must first configure their firewalls to trust the following IP address and port ranges.

API reference

• setCloudProxy

Take the following steps to use Cloud proxy in your app:

1. Enable Cloud Proxy in Agora Console:

   1. Log in to the console.

   2. Under Projects, locate the project that you want to edit, then click Configure.

   3. Under All Features, select Cloud Proxy.

   4. Click Enable Cloud Proxy.

      

2. Configure the enterprise firewall to allow traffic from the IP address and port ranges in the Agora Allowed IP List.

3. Call setCloudProxy and set proxyType to udpProxy or tcpProxy to enable Cloud proxy.

4. Test if you can initiate audio and video calls or live broadcasts normally.

5. To stop using Cloud proxy, call setCloudProxy and set proxyType to noneProxy.

6. To update the current cloud proxy type, call setCloudProxy(noneProxy) first, then call setCloudProxy again and set the cloud proxy type.

Call setCloudProxy outside the channel. Its settings are valid within the AgoraRtcEngineKit life cycle.

Reference

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

Pricing

Agora charges for use of Cloud Proxy as follows.

Duration-based pricing

Duration-based pricing is based on the total number of minutes used per month across all users.

For volume pricing discount, contact Agora support.

PCU-based pricing

PCU is the maximum number of simultaneous users connected to the Cloud Proxy service at any point during the billing cycle. For PCU-based usage, Agora charges $500.00 for each VID.

For volume pricing discount, contact Agora support.

IP addresses for Cloud Proxy

To use Agora Cloud Proxy, your end users must first configure their firewalls to trust the following IP address and port ranges.

API reference

• setCloudProxy

Take the following steps to use Cloud proxy in your app:

1. Enable Cloud Proxy in Agora Console:

   1. Log in to the console.

   2. Under Projects, locate the project that you want to edit, then click Configure.

   3. Under All Features, select Cloud Proxy.

   4. Click Enable Cloud Proxy.

      

2. Configure the enterprise firewall to allow traffic from the IP address and port ranges in the Agora Allowed IP List.

3. Call setCloudProxy and set proxyType to udpProxy or tcpProxy to enable Cloud proxy.

4. Test if you can initiate audio and video calls or live broadcasts normally.

5. To stop using Cloud proxy, call setCloudProxy and set proxyType to noneProxy.

6. To update the current cloud proxy type, call setCloudProxy(noneProxy) first, then call setCloudProxy again and set the cloud proxy type.

Call setCloudProxy outside the channel. Its settings are valid within the AgoraRtcEngineKit life cycle.

Reference

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

Pricing

Agora charges for use of Cloud Proxy as follows.

Duration-based pricing

Duration-based pricing is based on the total number of minutes used per month across all users.

For volume pricing discount, contact Agora support.

PCU-based pricing

PCU is the maximum number of simultaneous users connected to the Cloud Proxy service at any point during the billing cycle. For PCU-based usage, Agora charges $500.00 for each VID.

For volume pricing discount, contact Agora support.

IP addresses for Cloud Proxy

To use Agora Cloud Proxy, your end users must first configure their firewalls to trust the following IP address and port ranges.

API reference

• setCloudProxy

Since Web SDK v4.3.0, Agora has optimized the Cloud proxy architecture, enhanced the connectivity of the SDK in environments with restricted network access, and supports restricted access areas. Agora recommends that you upgrade to v4.3.0 or above.

Depending on the Web SDK version you are using, refer to the corresponding implementation method:

v4.3.0 or above

1. Enable Cloud Proxy in Agora Console:

   1. Log in to the console.

   2. Under Projects, locate the project that you want to edit, then click Configure.

   3. Under All Features, select Cloud Proxy.

   4. Click Enable Cloud Proxy.

      

2. Call the startProxyServer method and set the mode parameter before joining the channel:

   • Force UDP cloud proxy mode: Set mode to 3. Cloud proxy using UDP protocol. In this mode, the SDK always transmits data using UDP protocol.

   • Force TCP cloud proxy mode: Set mode to 5. (Supported since v4.9.0) Cloud proxy using TCP (encryption) protocol. In this mode, the SDK always transmits data over TLS 443.

3. Test if you can initiate audio and video calls or live broadcasts normally.

4. Video SDK provides a client.on("is-using-cloud-proxy") event that triggers the callback after the media stream is successfully published locally, to inform whether the current media stream is forwarded by the cloud proxy service.

   const client = AgoraRTC.createClient({mode: 'live',codec: 'vp8'});
   // Enable cloud proxy
   client.startProxyServer(3);
   // Join channel
   client.join("<YOUR TOKEN>", "<YOUR CHANNEL>").then(() => );
   

5. To stop using the proxy server, call stopProxyServer after leaving the channel.

   // Leave channel
   client.leave();
   
   // Turn off the cloud proxy service
   client.stopProxyServer();
   
   // Rejoin channel
   client.join("<YOUR TOKEN>", "<YOUR CHANNEL>").then(() => );
   

v4.0.0-v4.2.1

1. Enable Cloud Proxy in Agora Console:

   1. Log in to the console.

   2. Under Projects, locate the project that you want to edit, then click Configure.

   3. Under All Features, select Cloud Proxy.

   4. Click Enable Cloud Proxy.

      

2. Configure the firewall whitelist

   Add the following test IP addresses and ports to your corporate firewall whitelist. The source address is the client integrated with the Web SDK.

   Domestic testing

   Protocol	Target Address	Port	Port Usage
   TCP	150.138.153.78	443, 4000, 3433 - 3460	Message data transmission, media data exchange
   TCP	47.74.211.17	443	Edge node communication
   TCP	52.80.192.229	443	Edge node communication
   TCP	52.52.84.170	443	Edge node communication
   TCP	47.96.234.219	443	Edge node communication
   UDP	150.138.153.78	3478-3500	media data exchange

   Overseas testing

   Protocol	Target Address	Port	Port Usage
   TCP	23.236.115.138	443, 4000, 3433 - 3460	Message data transmission, media data exchange
   TCP	148.153.66.218	443, 4000, 3433 - 3460	Message data transmission, media data exchange
   TCP	47.74.211.17	443	Edge node communication
   TCP	52.80.192.229	443	Edge node communication
   TCP	52.52.84.170	443	Edge node communication
   TCP	47.96.234.219	443	Edge node communication
   UDP	23.236.115.138	3478-3500	media data exchange
   UDP	148.153.66.218	3478-3500	media data exchange

   The above IPs are only meant for debugging during the test phase. Before official launch, apply for custom cloud proxy service resources from Agora.

3. To turn on cloud proxy server before joining the channel, call:

   client.startProxyServer();

4. To turn off cloud proxy server after leaving the channel, call:

   client.stopProxyServer();

Reference

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

Pricing

Agora charges for use of Cloud Proxy as follows.

Duration-based pricing

Duration-based pricing is based on the total number of minutes used per month across all users.

For volume pricing discount, contact Agora support.

PCU-based pricing

PCU is the maximum number of simultaneous users connected to the Cloud Proxy service at any point during the billing cycle. For PCU-based usage, Agora charges $500.00 for each VID.

For volume pricing discount, contact Agora support.

IP addresses for Cloud Proxy

To use Agora Cloud Proxy, your end users must first configure their firewalls to trust the following IP address and port ranges.

Firewall whitelist

Alternatively, you can whitelist the following domains and ports to ensure seamless communication with Agora's services. For the complete and current Web SDK allowlist, see Firewall requirements.

• v4.4.0 and above

  .agora.io
  .edge.agora.io
  .sd-rtn.com
  .edge.sd-rtn.com
  .ap.sd-rtn.com
  .statscollector.sd-rtn.com
  .webrtc-cloud-proxy.sd-rtn.com
  .rtnsvc.com
  .edge.rtnsvc.com
  .rtesvc.com
  .edge.rtesvc.com

  To improve connectivity over public networks, we recommend adding the domains listed above to your firewall allowlist.

• v4.0.0 - v4.4.0

  .agora.io
  .edge.agora.io
  .agoraio.cn
  .edge.agoraio.cn

API reference

• startProxyServer
• stopProxyServer

Take the following steps to use Cloud proxy in your app:

1. Enable Cloud Proxy in Agora Console:

   1. Log in to the console.

   2. Under Projects, locate the project that you want to edit, then click Configure.

   3. Under All Features, select Cloud Proxy.

   4. Click Enable Cloud Proxy.

      

2. Configure the enterprise firewall to allow traffic from the IP address and port ranges in the Agora Allowed IP List.

3. Call setCloudProxy and set proxyType to UDP_PROXY or TCP_PROXY to enable Cloud proxy.

4. Test if you can initiate audio and video calls or live broadcasts normally.

5. To stop using Cloud proxy, call setCloudProxy and set proxyType to NONE_PROXY.

6. To update the current cloud proxy type, call setCloudProxy(NONE_PROXY) first, then call setCloudProxy again and set the cloud proxy type.

Call setCloudProxy outside the channel. Its settings are valid within the RtcEngine life cycle.

Reference

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

Pricing

Agora charges for use of Cloud Proxy as follows.

Duration-based pricing

Duration-based pricing is based on the total number of minutes used per month across all users.

For volume pricing discount, contact Agora support.

PCU-based pricing

PCU is the maximum number of simultaneous users connected to the Cloud Proxy service at any point during the billing cycle. For PCU-based usage, Agora charges $500.00 for each VID.

For volume pricing discount, contact Agora support.

IP addresses for Cloud Proxy

To use Agora Cloud Proxy, your end users must first configure their firewalls to trust the following IP address and port ranges.

API reference

• setCloudProxy

Take the following steps to use Cloud proxy in your app:

1. Enable Cloud Proxy in Agora Console:

   1. Log in to the console.

   2. Under Projects, locate the project that you want to edit, then click Configure.

   3. Under All Features, select Cloud Proxy.

   4. Click Enable Cloud Proxy.

      

2. Configure the enterprise firewall to allow traffic from the IP address and port ranges in the Agora Allowed IP List.

3. Call setCloudProxy and set proxyType to UdpProxy or TcpProxy to enable Cloud proxy.

4. Test if you can initiate audio and video calls or live broadcasts normally.

5. To stop using Cloud proxy, call setCloudProxy and set proxyType to NoneProxy.

6. To update the current cloud proxy type, call setCloudProxy(NoneProxy) first, then call setCloudProxy again and set the cloud proxy type.

Call setCloudProxy outside the channel. Its settings are valid within the RtcEngine life cycle.

Reference

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

Pricing

Agora charges for use of Cloud Proxy as follows.

Duration-based pricing

Duration-based pricing is based on the total number of minutes used per month across all users.

For volume pricing discount, contact Agora support.

PCU-based pricing

PCU is the maximum number of simultaneous users connected to the Cloud Proxy service at any point during the billing cycle. For PCU-based usage, Agora charges $500.00 for each VID.

For volume pricing discount, contact Agora support.

IP addresses for Cloud Proxy

To use Agora Cloud Proxy, your end users must first configure their firewalls to trust the following IP address and port ranges.

API reference

• setCloudProxy

Take the following steps to use Cloud proxy in your app:

1. Enable Cloud Proxy in Agora Console:

   1. Log in to the console.

   2. Under Projects, locate the project that you want to edit, then click Configure.

   3. Under All Features, select Cloud Proxy.

   4. Click Enable Cloud Proxy.

      

2. Configure the enterprise firewall to allow traffic from the IP address and port ranges in the Agora Allowed IP List.

3. Call setCloudProxy and set proxyType to udpProxy or tcpProxy to enable Cloud proxy.

4. Test if you can initiate audio and video calls or live broadcasts normally.

5. To stop using Cloud proxy, call setCloudProxy and set proxyType to noneProxy.

6. To update the current cloud proxy type, call setCloudProxy(noneProxy) first, then call setCloudProxy again and set the cloud proxy type.

Call setCloudProxy outside the channel. Its settings are valid within the RtcEngine life cycle.

Reference

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

Pricing

Agora charges for use of Cloud Proxy as follows.

Duration-based pricing

Duration-based pricing is based on the total number of minutes used per month across all users.

For volume pricing discount, contact Agora support.

PCU-based pricing

PCU is the maximum number of simultaneous users connected to the Cloud Proxy service at any point during the billing cycle. For PCU-based usage, Agora charges $500.00 for each VID.

For volume pricing discount, contact Agora support.

IP addresses for Cloud Proxy

To use Agora Cloud Proxy, your end users must first configure their firewalls to trust the following IP address and port ranges.

API reference

• setCloudProxy

Take the following steps to use Cloud proxy in your app:

1. Enable Cloud Proxy in Agora Console:

   1. Log in to the console.

   2. Under Projects, locate the project that you want to edit, then click Configure.

   3. Under All Features, select Cloud Proxy.

   4. Click Enable Cloud Proxy.

      

2. Configure the enterprise firewall to allow traffic from the IP address and port ranges in the Agora Allowed IP List.

3. Call setCloudProxy and set proxyType to UdpProxy or TcpProxy to enable Cloud proxy.

4. Test if you can initiate audio and video calls or live broadcasts normally.

5. To stop using Cloud proxy, call setCloudProxy and set proxyType to NoneProxy.

6. To update the current cloud proxy type, call setCloudProxy(NoneProxy) first, then call setCloudProxy again and set the cloud proxy type.

Call setCloudProxy outside the channel. Its settings are valid within the RtcEngine life cycle.

Reference

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

Pricing

Agora charges for use of Cloud Proxy as follows.

Duration-based pricing

Duration-based pricing is based on the total number of minutes used per month across all users.

For volume pricing discount, contact Agora support.

PCU-based pricing

PCU is the maximum number of simultaneous users connected to the Cloud Proxy service at any point during the billing cycle. For PCU-based usage, Agora charges $500.00 for each VID.

For volume pricing discount, contact Agora support.

IP addresses for Cloud Proxy

To use Agora Cloud Proxy, your end users must first configure their firewalls to trust the following IP address and port ranges.

API reference

• setCloudProxy

Take the following steps to use Cloud proxy in your game:

1. Enable Cloud Proxy in Agora Console:

   1. Log in to the console.

   2. Under Projects, locate the project that you want to edit, then click Configure.

   3. Under All Features, select Cloud Proxy.

   4. Click Enable Cloud Proxy.

      

2. Configure the enterprise firewall to allow traffic from the IP address and port ranges in the Agora Allowed IP List.

3. Call SetCloudProxy and set proxyType to UDP_PROXY or TCP_PROXY to enable Cloud proxy.

4. Test if you can initiate audio and video calls or live broadcasts normally.

5. To stop using Cloud proxy, call SetCloudProxy and set proxyType to NONE_PROXY.

6. To update the current cloud proxy type, call SetCloudProxy(NONE_PROXY) first, then call SetCloudProxy again and set the cloud proxy type.

Call SetCloudProxy outside the channel. Its settings are valid within the RtcEngine life cycle.

Reference

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

Pricing

Agora charges for use of Cloud Proxy as follows.

Duration-based pricing

Duration-based pricing is based on the total number of minutes used per month across all users.

For volume pricing discount, contact Agora support.

PCU-based pricing

PCU is the maximum number of simultaneous users connected to the Cloud Proxy service at any point during the billing cycle. For PCU-based usage, Agora charges $500.00 for each VID.

For volume pricing discount, contact Agora support.

IP addresses for Cloud Proxy

To use Agora Cloud Proxy, your end users must first configure their firewalls to trust the following IP address and port ranges.

API reference

• SetCloudProxy