RingCentral Basics

General

What can I accomplish with your APIs?

The RingCentral Platform offers a family of cloud APIs that integrate voice, SMS, and fax communications, as well as provides access to communications data. You can tightly integrate all business communications with your CRM application; send SMS messages and faxes straight from your business apps; seamlessly initiate phone calls and ring out from business applications; analyze call logs to create reports and feed dashboards. See the RingCentral Developer Library for further information.

Where can I find SDKs, sample code and/or example apps for my language?

SDKs, sample code and example apps available from RingCentral and community authors are linked from the RingCentral Developer Portal SDK page (https://developer.ringcentral.com/library/sdks.html). For all official resources, developers can also go the RingCentral GitHub organization page at https://github.com/ringcentral/.

How do I send text messages to other colleagues within my company using RingCentral through the API?

If you are interested in sending text messages to your internal employees you can take advantage of using company-pager API to send text messages to other users, and use the RingCentral iOS/Android mobile application or RingCentral for Desktop to receive them. Through the Advanced Messaging APIs your business application can send unlimited amount of messages. Get more details on how to create pager for your company here.

How many API calls am I allowed to make per a time period?

There are certain API usage plans which are applied to 3rd party applications which use the RingCentral API. These plans can vary depending on a particular API or a user’s current service plan. But in most cases our servers will reject API requests from a particular application if the request rate exceeds 30 API requests per minute. In this case the client will get an HTTP error with status code 429 “too many requests”.

Can I give someone access to development with an account in our sandbox account or is a production account required?

There are two basic scenarios:

  1. If you want the developer to have full access to the Developer Portal (https://developers.ringcentral.com) to create and configure apps, view analytics, submit for graduation, then the user needs a production account that can be used to log into (https://service.ringcentral.com).
  2. If you want a developer to have access to the APIs for development and testing, but not have access to the Developer Portal, you can create a user on the sandbox account (https://service.devtest.ringcentral.com) and provide the developer a pre-created app key and app secret to perform development. The sandbox account user will not have access to the production Online Account Portal (https://service.ringcentral.com).

What are the System Requirements for using the RingCentral Service and Integrations, and which browsers are supported for using these applications?

RingCentral KB article 5126 covers this information which you can refer to for answers to this question.

What version of security protocol does RingCentral support?

RingCentral's legacy RingOut and FaxOut APIs require servers to support TLS version 1.2. Older browsers and API clients without TLS 1.2 support will no longer work. You can read more about our TLS requirements, how to test your browsers/API client/code for TLS 1.2 support, and language updates required to operate with our API in RingCentral KB Article 8778. The RingCentral Connect Platform APIs will be updated at a future date.

How do I get my app into Production?

The RingCentral Developer Portal contains information on the graduation status and readiness of your application. In your app page, your app's status is presented on the Status & Review view with related API call information in the Analytics view. Summaries of both of these are presented at the top level Dashboard view. For step-by-step instructions:

  1. Login to the RingCentral Developer Portal.
  2. Navigate to your desired application by selecting it from the My Apps menu bar item or from the All applications app list.
  3. The Dashboard view of your Application page in Developer Portal contains summary information including a section named Production Status. The content in this will provide you with a quick pulse on where your application is in the development process as it relates to Production access.
  4. Click on Status & Review to see a more detailed graduation information where the graduation requirements link of #3 above is referenced.
  5. This Status & Review view contains two sections: Production Status (same from Dashboard view), and the Graduation Requirements section. This section provides you with a detailed list of our Production Access Criteria, and how it relates to the current state of your application.
  6. If the button named "Apply for Production" is greyed out it is because your application has not yet met our Production Access Criteria. Please review the 'status' of each rule that is failing and resolve the issue within your application code.
  7. Note that the data in this view may be cached, but there is a 'refresh' icon you can use to update the state of the review data.
  8. If you feel that your application has met all of the rules, but you are still unable to "Apply for Production", please submit a Developer Support Case.
  9. We process requests for production each workday and address all requests from the previous day(s).

Troubleshooting

When should I retry when receiving a 503 CMN-211 MaintenanceMode "Service is overloaded, please retry later" error?

The amount of time to wait before retrying the request is the number of seconds provided in the Retry-After HTTP response header. Often times, the retry after time is no longer than 10-15 seconds.