Revolutionize communication
with our programmable
configuration APIs
with our programmable
configuration APIs
Robust account configuration capabilities include
presence notifications, authorization profiles,
answering rules, push notifications, forwarding
numbers, extensions, and paging.
Use the configuration APIs to automate business workflows
to create new users, handle authentication, enable call event
notifications, create custom call flows and queue routing
rules, and more.
Our Configuration API for developers includes these great features
Build complex business workflows for onboarding and
communications management.
Account Management
Return basic account
information about a RingCentral
account.
Extension Management
Manage extensions and create
user templates for faster
onboarding.
Device Management
Get and assign devices to
extensions.
Presence Status
Return the presence status of an
extension (offline, busy, or
available).
Authorization Profile
Return a list of user permissions
granted during authorization.
Answering Rules
Implement the answering rules
for an extension.
Push Notifications
Return the list of subscriptions
created by a user on a client
app.
Forwarding Numbers
Return the list of extension
numbers for call forwarding and
call flipping.
Dictionary
Return country information and
details, including country name,
language, location area code,
city, state, time zone, available
greetings, and fax cover pages.
Client Application
Provision SIP devices.
Paging
Automate configuration of
RingCentral Paging including
creating paging only groups,
assigning paging devices and/or
desk phones, and authorizing
users to access the group.
API Version
Return current API versions and
server information.
Configuration API code samples
Configuring your application couldn’t be easier with our SDKs for C#, JavaScript, PHP, and Python.
- C#
- JavaScript
- PHP
- Python
RestClient rc = new RestClient(
Environment.GetEnvironmentVariable("clientId"),
Environment.GetEnvironmentVariable("clientSecret"),
false
);
await rc.Authorize(
Environment.GetEnvironmentVariable("username"),
Environment.GetEnvironmentVariable("extension"),
Environment.GetEnvironmentVariable("password")
);
var r = await rc.Restapi().Account(accountId).
Extension(extensionId).Presence().Get(readUserPresenceStatusParameters);
// PROCESS RESPONSE
const rcsdk = new SDK({server: process.env.serverURL,
appKey: process.env.clientId, appSecret: process.env.clientSecret});
const platform = rcsdk.platform();
platform.login({ username: process.env.username,
extension: process.env.extension,
password: process.env.password }).then(() => {
platform.get(`/restapi/v1.0/account/${accountId}/extension/
${extensionId}/presence`, queryParams).then((r) => {
// PROCESS RESPONSE
});
});
$rcsdk = new RingCentral\SDK\SDK(getenv('clientId'),
getenv('clientSecret'), getenv('serverURL'));
$platform = $rcsdk->platform();
$platform->login(getenv('username'), getenv('extension'),
getenv('password'));
$r = $platform->get("/restapi/v1.0/account/{$accountId}/extension/{$extensionId}/presence", $queryParams);
platform = rcsdk.platform()
platform.login(os.environ['username'],
os.environ['extension'], os.environ['password'])
r = platform.get(f'/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence', queryParams)
# PROCESS RESPONSE
Configuration API frequently asked questions
To help you get the most out of your RingCentral account, we have collected some of
the most commonly asked questions. Of course, you can always ask our community or contact our developer support for any questions you might have.
What is the Configuration API?
The Configuration API is a collection of end points that allows you to automate business workflows including new employee onboarding, device management, office hours, business rules, account authentication, and more.
Is the Configuration API included with my RingCentral Office subscription?
Yes, the Configuration APIs are included with Office Premium and Ultimate plans.
Can I manage my account with the Configuration APIs?
Yes, with the account endpoint you can gather basic information and then have code react accordingly to different access permission levels per extension ID.
Can I use the Configuration API to automatically onboard new team members?
Yes, with our Configuration API you can create new extensions complete with user information. You can also use our user templates to expedite the process. Finally, you can use the Devices Configuration API to assign devices (i.e., hard phones) to your extensions.
How do I determine if agents are available to take incoming calls?
You can use the Presence Status information provided by the API to see the current status of an agent. Returned status states are Offline, Busy, or Available.
If I have multiple business locations, can I control agents based on location?
Yes with the Configuration API you can determine states, time zones, and even countries for which to link your agents.
Companies using RingCentral Configuration API
These companies have increased efficiency and saved money with
RingCentral Configuration API!
Get more than communications.
Be part of the RingCentral community.
Live chat
Get live developer support via Glip® team messaging, where you can quickly solve problems and share code snippets.
Developer forum
Post your question in our forum and get help from our developer support team and amazing community.
RingCentral Professional Services™
Don’t have the time or resources to build your app internally? Our Professional Services team has you covered.
Be a Game Changer and be rewarded
Learn about our APIs, grow your skills, and get recognized and rewarded with RingCentral gear, conference passes, electronics, and more in our revolutionary Game Changer program.