Developing in Sandbox

Last updated: 2022-05-19 Contributors Byrne ReeseCraig Chan
Edit this page

RingCentral provides developers with both a Sandbox and Production environment in which to develop and test your app. Upon creating an application, a sandbox account is generated automatically if you do not already have one.

Access to the production environment is made available after your application has been reviewed and approved. As a result, sandbox accounts are required in order to develop your application. That being said, sandbox accounts come also with the following benefits:

  • Data Segregation - developers are free to make additions and changes without fear of littering the production account with test and dummy data.
  • Change Control - developers are free to create and develop applications in sandbox without fear of interfering with applications safely running in our production environment . This is especially important for our HIPAA-compliant customers.
  • Cost - API calls to our sandbox environment are not metered, or count against any allottments your account may be limited by.
  • Compliance - by requiring developers to apply for access to production, we can put in place steps to reduce the risk of developers unknowingly violating our company's EULA or TOS.

Sandbox URLs

Product URL
RingCentral app https://app.devtest.ringcentral.com
RingCentral account portal https://service.devtest.ringcentral.com
RingCentral API https://platform.devtest.ringcentral.com

Please note: Glip App (mobile or desktop) does NOT have:

  • Support for the RingCentral Sandbox API (cannot switch to 'developer mode')
  • Support for a 'Sandbox version'

How Sandbox accounts are organized

Sandbox accounts are currently shared across all users within the same account. We do not currently support creating multiple user level Sandbox accounts within a single RingCentral account. Within that account, developers can easily collaborate on the applications created within that account.

If you need to simulate two different users from two different organizations during development, you may need to create additional RingCentral accounts in order to do so.

Using phones in Sandbox

Every sandbox account is provisioned a different main company phone number and user that is different than ones used in production. Additional phone numbers and users can also be configured in your sandbox account. Some use cases supported by these communication apps include:

  • RingOut - to receive calls at a sandbox phone number.
  • Voicemail - to retrieve, listen to, and delete voicemails.
  • Call Control - to hang-up, hold, flip, forward calls placed to sandbox numbers.

RingCentral phones can be used with your sandbox account to make and receive calls.

  1. Embeddable Widget. This is a full-featured, production ready developer tool that can be used to integrate RingCentral functionality with your web app.
  2. WebRTC Demo App. This is a WebRTC voice endpoint that implements inbound and outbound calls with various call controls.

More information is available below on using and configuring these endpoints to work in Sandbox and to configure your app if needed.

Embeddable web widget and the Sandbox environmnet

The RingCentral Embeddable Web Widget is a fully-functional web client that developers can embed in their app. In addition to doing development with it, there is a hosted demo you can configure and use.

To use the demo app, you need to configure the Embeddable with your Client ID, Client Secret and Server URL. You also need to add the demo's OAuth 2.0 Redirect URL to your app. To use with your sandbox account, use the credentials for your sandbox account.

Read more below:

WebRTC Demo App and the Sandbox Environmnet

To use the WebRTC Demo App is provided with the RingCentral WebRTC SDK. In addition to doing development with it, there is a hosted demo you can configure and use.

To use the demo app, you need to configure the Embeddable with your Client ID, Client Secret and Server URL. You also need to add the demo's OAuth 2.0 Redirect URL to your app. To use with your sandbox account, use the credentials for your sandbox account.

Read more below:

Limitations

Restrictions

To help contain costs and curb abuse, the following restrictions are placed on sandbox accounts:

  • Telephony and voice APIs are restricted to US phone calls only. In other words, RingOut and other voice APIs that initiate calls do not work with non-US/international numbers.

Sandbox watermarks

In order to ensure that our sandbox environment is used for testing purposes only, we add the following watermarks to messages and voice calls eminating from that environment:

  • SMS (Inbound/Outbound) - a text watermark of "Test SMS using a RingCentral Developer account"

  • Voice calls (Inbound/Outbound) - a voice watermark of "Test call using a RingCentral Developer account"

  • Faxes (Outbound) - an image watermark of "Test fax using a RingCentral Developer account', for example:

Configuring Sandbox

To configure your Sandbox environment please follow the steps:

  1. Go to https://service.devtest.ringcentral.com

  2. Login with your sandbox account username (main company number) and password that are available on your App page:

    • in 'Sandbox Credentials' section on the 'Dashboard' tab (see above);
    • in 'User Account Credentials' section on the 'Credentials' tab (see below)

  3. Configure your user account phone system to emulate your target user environment:

    • set auto-receptionist and company info;
    • add extensions and phone numbers;
    • add and set devices;
    • etc.

Your Sandbox account is now ready to be used. You can now direct API calls to https://platform.devtest.ringcentral.com.

Deactivation of idle sandbox accounts

Use it or lose it

Sandbox accounts are provided to developers completely free of charge. As long as a sandbox is in active use, developers can rely on the sandbox being available. However, if a sandbox account becomes idle for 60 days, the sandbox account will be deactivated in order to free up phone numbers for others to use.

If you receive an email about your account facing deactivation, and you would like to prevent that from happening, then the quickest and easist thing one can do is use the "Try it out" feature in the API Explorer to conduct a single API call in sandbox.

A more sustainable and recommended practice however is to routinely test your app in sandbox using a CI/CD system, or some other automated process.

What happens if I lose access to my sandbox?

If you find yourself in the circumstance where your sandbox account has been deactivated, you can easily create a new one by following the prompts inside of the Developer Console.

Once the new sandbox account has been created then you may need to update the configuration of any apps that connect to your sandbox account, as your authentication credentials may have changed.