> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# RingCentral

> How to set up the RingCentral connector, plus the actions that are available.

![RingCentral](https://stackone-logos.com/api/ringcentral/filled/svg)

Betav0.4.0[See changelog](https://docs.stackone.com/connectors/ringcentral/changelog.md)

[87 actions](#actions) · 2 auth methods

Telephony
Messaging
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/ringcentral/guides/connector-profile/oauth-2-0.md)
>
> Requires creating a REST API app in the RingCentral Developer Console with 3-legged OAuth and refresh tokens turned on....

> [card] [OAuth 2.0 (Client Credentials) · Connector Profile](https://docs.stackone.com/connectors/ringcentral/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> Server-to-server access with no sign-in screen. Requires a RingCentral REST API app set to the JWT auth flow and a JWT c...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/ringcentral/guides/link-account/oauth-2-0.md)

> [card] [OAuth 2.0 (Client Credentials) · Link Account](https://docs.stackone.com/connectors/ringcentral/guides/link-account/oauth-2-0-client-credentials.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

A2PSMS

Analytics

CallControl

Contacts

EditAccounts

EditCallLog

EditExtensions

EditMessages

EditPresence

Faxes

Glip

ReadAccounts

ReadCallLog

ReadContacts

ReadMessages

ReadPresence

RingOut

RoleManagement

SMS

TeamMessaging

Video

No scopes found

87 actions

ActionDescriptionRequired scopes

Get Emergency Map Configuration Task`ringcentral_read_automatic_location_updates_task`

Retrieve the status and results of an asynchronous Automatic Location Updates task

`EditAccounts`

Enable Automatic Location Updates For Users`ringcentral_assign_multiple_automatic_location_updates_users`

Enable or disable the Automatic Location Updates feature for multiple account users in one bulk call

`EditAccounts`

Calls Aggregation Data`ringcentral_analytics_calls_aggregation_fetch`

Fetch aggregated call volume and call duration analytics for a single time range

`Analytics`

Calls Timeline Data`ringcentral_analytics_calls_timeline_fetch`

Fetch time-series call volume and call duration analytics broken into interval buckets

`Analytics`

List User Events`ringcentral_read_glip_events_new`

Retrieve all calendar events created by the current authenticated user

`TeamMessaging`

Get Event`ringcentral_read_event_new`

Retrieve one or more calendar events by ID

`TeamMessaging`

Make CallOut`ringcentral_create_call_out_call_session`

Initiate a two-legged outbound (CallOut) call session that first rings the caller's registered Softphone/Hardphone devic...

`CallControl`

Start Conference Call Session`ringcentral_create_conference_call_session`

Start a new ad-hoc conference call session on the authenticated account's conferencing line, returning a voiceCallToken...

`CallControl`

Get Call Session Status`ringcentral_read_call_session_status`

Retrieve the current status of a live call session by its telephony session identifier, including all call parties and t...

`CallControl`

Drop Call Session`ringcentral_delete_call_session`

Drop (hang up) an entire live call session by its telephony session identifier, disconnecting every party on the call.

`CallControl`

List Company Active Calls`ringcentral_list_company_active_calls`

Retrieve all calls currently in progress across the entire RingCentral account

`ReadCallLog`

List User Active Calls`ringcentral_list_extension_active_calls`

Retrieve all calls currently in progress for a single user extension

`ReadCallLog`

List User Call Records`ringcentral_read_user_call_log`

Retrieve historical call log records for a single user extension with rich filtering

`ReadCallLog`

Delete User Call Records`ringcentral_delete_user_call_log`

Permanently delete call log records for a user extension

`EditCallLog`

List Call Queues`ringcentral_list_call_queues`

Retrieve a paginated list of call queue extensions on the account

`ReadAccounts`

Update User Call Queues`ringcentral_update_user_call_queues`

Replace the full set of call queues a user extension is an agent in

`EditAccounts`

List Favorite Chats`ringcentral_list_favorite_chats_new`

Retrieve the list of the authenticated user's favorite (starred/pinned) team messaging chats

`TeamMessaging`

Add Chat To Favorites`ringcentral_favorite_glip_chat_new`

Add a Team Messaging chat to the authenticated user's list of favorite (starred/pinned) chats

`TeamMessaging`

Send/Resend Welcome Email`ringcentral_send_welcome_email_v2`

Send or resend the welcome email to the system user of a confirmed RingCentral account

`EditExtensions`

Send/Resend Activation Email`ringcentral_send_activation_email_v2`

Send or resend the activation email to the system user of an unconfirmed RingCentral account

`EditAccounts`

List Data Export Tasks`ringcentral_list_data_export_tasks_new`

Retrieve the list of Glip (Team Messaging) compliance data export tasks created for the company

`TeamMessaging``Glip`

Get Data Export Task`ringcentral_read_data_export_task_new`

Retrieve the status and download links of a specific Glip compliance data export task

`TeamMessaging``Glip`

Create Data Export Task`ringcentral_create_data_export_task_new`

Start an asynchronous Glip (Team Messaging) compliance data export task

`TeamMessaging``Glip`

List Extension Devices`ringcentral_list_extension_devices`

List the devices assigned to a user's extension, with filters for device type, line type, feature, and line pooling

`ReadAccounts`

Add BYOD Devices`ringcentral_bulk_add_devices_v2`

Bulk-add multiple BYOD (customer provided) devices to the account in a single call

`EditAccounts`

List Extensions`ringcentral_list_extensions`

Retrieve the list of extensions (users, call queues, IVR menus, etc.) provisioned on the account

`ReadAccounts`

Get Extension`ringcentral_read_extension`

Retrieve basic information about a single extension by ID

`ReadAccounts`

Create Extension`ringcentral_create_extension`

Provision a new extension (user, virtual user, call queue, voicemail, etc.) on the account

`EditAccounts`

Update Multiple Extensions`ringcentral_extension_bulk_update`

Bulk-update up to 500 extensions in a single asynchronous request

`EditExtensions`

Get Extension Update Task Status`ringcentral_get_extension_bulk_update_task`

Poll the status of an asynchronous bulk extension-update task

`EditExtensions`

List User Templates`ringcentral_list_user_templates`

Retrieve the list of user templates configured for the account

`ReadAccounts`

Get User Template`ringcentral_read_user_template`

Retrieve a single user template by ID

`ReadAccounts`

List Favorite Contacts`ringcentral_list_favorite_contacts`

Retrieve the list of favorite contacts marked by an extension

`ReadContacts`

Get Contacts Upload Task`ringcentral_get_address_book_bulk_upload_task`

Retrieve the status of a bulk contacts upload task

`Contacts`

Upload Multiple User Contacts`ringcentral_address_book_bulk_upload`

Bulk-create personal address book contacts for multiple extensions in one request

`Contacts`

Update Favorite Contact List`ringcentral_update_favorite_contact_list`

Replace an extension's entire favorite contacts list with the provided set of records

`Contacts`

Create Fax Message`ringcentral_create_fax_message`

Send a fax message with one or more file attachments to one or more recipient fax numbers, optionally with a cover page

`Faxes`

List A2P SMS Statuses`ringcentral_aggregate_a2p_sms_statuses`

Retrieve aggregate counts of high-volume A2P SMS messages grouped by delivery status and error code

`A2PSMS`

Send A2P SMS`ringcentral_create_a2p_sms_batch`

Send a batch of high-volume A2P (Application-to-Person) SMS messages to many recipients in a single call

`A2PSMS`

Add Opt-In/Out Numbers`ringcentral_add_a2p_sms_opt_outs`

Bulk mark recipient phone numbers as opted out (or opted back in) for A2P SMS from a given sender number

`A2PSMS`

List Opted Out Numbers`ringcentral_read_a2p_sms_opt_outs`

List recipient phone numbers opted out of (or opted in to) high-volume A2P SMS on the account

`A2PSMS`

Get Company Directory Entries`ringcentral_list_directory_entries`

Retrieve the company directory of corporate (internal) contacts for the account

`ReadAccounts`

Search Company Directory Entries`ringcentral_search_directory_entries`

Search and filter corporate directory contacts by name, email, extension, department, site, status or type, with sorting...

`ReadAccounts`

List Video Meetings`ringcentral_list_video_meetings`

Retrieve the authenticated user's RingCentral Video meeting history records

`Video`

Get Video Meeting`ringcentral_get_video_meeting`

Retrieve a single RingCentral Video meeting history record by its meeting id

`Video`

Get Message Store Report Task`ringcentral_read_message_store_report_task`

Retrieve the current status of a message store report export task

`ReadMessages`

Create Message Store Report`ringcentral_create_message_store_report`

Start an asynchronous task that collects account messages into a downloadable export report

`ReadMessages`

List Messages`ringcentral_list_messages`

Retrieve a list of messages (SMS, Fax, VoiceMail, Pager) from an extension's message store

`ReadMessages`

Get Message(s)`ringcentral_read_message`

Retrieve an individual message record (or multiple records in bulk) by message ID

`ReadMessages`

Get Message Store Configuration`ringcentral_read_message_store_configuration`

Retrieve the account-wide message store retention settings

`EditAccounts`

Update Message(s)`ringcentral_update_message`

Update the read status of one or more messages by message ID

`EditMessages`

Patch Message(s)`ringcentral_patch_message`

Partially update message(s) — change read status and/or restore soft-deleted messages

`EditMessages`

Update Message Store Configuration`ringcentral_update_message_store_configuration`

Update the account-wide message retention policy for Fax and Voicemail messages

`EditAccounts`

Delete Message`ringcentral_delete_message`

Delete one or more messages by message ID, with optional immediate purge

`EditMessages`

Delete Conversation`ringcentral_delete_message_by_filter`

Delete entire conversation(s) by conversation ID, or all messages matching filter criteria

`EditMessages`

Get Call Queue Presence`ringcentral_read_call_queue_presence`

Retrieve the presence status of every member of a specific call queue

`ReadPresence`

Get Agent's Call Queue Presence`ringcentral_read_extension_call_queue_presence`

Retrieve all call queues an agent belongs to with their per-queue availability status

`ReadPresence`

Get User Presence Status`ringcentral_read_user_presence_status`

Retrieve the current presence status of a user extension

`ReadPresence`

Get Unified Presence`ringcentral_read_unified_presence`

Retrieve a user's aggregated presence across Team Messaging and telephony channels

`ReadPresence`

Update Call Queue Presence`ringcentral_update_call_queue_presence`

Bulk-update the queue availability of one or more members of a specific call queue

`EditPresence`

Update Agent's Call Queue Presence`ringcentral_update_extension_call_queue_presence`

Update a single agent's call availability across one or more of their call queues

`EditPresence`

Update User Presence Status`ringcentral_update_user_presence_status`

Update a user's presence status, status message and Do Not Disturb state

`EditPresence`

Update Unified Presence`ringcentral_update_unified_presence`

Update a user's aggregated presence across Team Messaging and telephony channels

`EditPresence`

List States`ringcentral_list_states`

Retrieve the list of states/regions from RingCentral's reference dictionary, optionally filtered by country

Get State`ringcentral_read_state`

Retrieve details of a single state/region by its internal identifier

Get RingOut Call Status`ringcentral_read_ring_out_call_status`

Retrieve the current status of a two-legged RingOut call

`RingOut`

Make RingOut Call`ringcentral_create_ring_out_call`

Place a two-legged RingOut phone call

`RingOut`

Cancel RingOut Call`ringcentral_delete_ring_out_call`

Cancel an in-progress or queued two-legged RingOut call

`RingOut`

List Company User Roles`ringcentral_list_user_roles`

Retrieve a paginated list of user roles configured on the account

`ReadAccounts`

List User Assigned Roles`ringcentral_list_user_assigned_roles`

Retrieve the roles currently assigned to a user extension

`ReadAccounts`

Update User Assigned Roles`ringcentral_update_user_assigned_roles`

Replace the full set of roles assigned to a user extension

`RoleManagement`

List User Administered Sites`ringcentral_list_administered_sites`

List the business sites a user's extension is authorized to administer

`ReadAccounts`

Update User Administered Sites`ringcentral_update_user_administered_sites`

Replace the full set of business sites a user's extension is authorized to administer

`EditAccounts`

Send SMS`ringcentral_create_sms_message`

Send an outbound SMS text message to one or more recipients from a RingCentral phone number

`SMS`

Send MMS`ringcentral_create_mms`

Send an outbound MMS message with a media file attachment to one or more recipients

`SMS`

List Chat Tasks`ringcentral_list_chat_tasks_new`

Retrieve the list of tasks that belong to a specific Team Messaging chat

`TeamMessaging`

Create Task`ringcentral_create_task_new`

Create a new task in a specific Team Messaging chat, assigning it to one or more members

`TeamMessaging`

List Teams`ringcentral_list_glip_teams_new`

Retrieve the list of Team Messaging teams visible to the current user

`TeamMessaging`

Create Team`ringcentral_create_glip_team_new`

Create a new Team Messaging team, optionally adding an initial list of members by ID or email

`TeamMessaging`

Archive Team`ringcentral_archive_glip_team_new`

Archive a Team Messaging team by its chat ID

`TeamMessaging`

Unarchive Team`ringcentral_unarchive_glip_team_new`

Unarchive a Team Messaging team by its chat ID, restoring it to Active status

`TeamMessaging`

Create Multiple User Extensions`ringcentral_post_batch_provision_users`

Provision multiple new user extensions (with customer-provided BYOD devices) in a single bulk call

`EditAccounts`

Get User Profile Image`ringcentral_read_user_profile_image`

Download the current profile image of a user extension as binary image content

`ReadAccounts`

Upload User Profile Image`ringcentral_create_user_profile_image`

Upload a new profile image for a user extension via multipart form upload

`EditExtensions`

Update User Profile Image`ringcentral_update_user_profile_image`

Replace an existing profile image of a user extension via multipart form upload

`EditExtensions`

Delete User Extensions`ringcentral_bulk_delete_users_v2`

Delete one or more user extensions in a single bulk call, optionally keeping their phone numbers and devices in the acco...

`EditAccounts`

Delete User Profile Image`ringcentral_delete_user_profile_image`

Remove the current profile image of a user extension without replacing it

`EditExtensions`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.