# RingCentral (v1) Information note **RingCentral is supported by the Singer community** This integration is powered by [Singer's](https://www.singer.io/) RingCentral tap. For support, [visit the GitHub repo](https://github.com/singer-io/tap-ringcentral) or [join the Singer Slack](https://singer-slackin.herokuapp.com/). ## RingCentral feature snapshot A high-level look at Stitch's RingCentral (v1) integration, including release status, useful links, and the features supported in Stitch. | **STITCH** | | | | | --- | --- | --- | --- | | **[Release status](https://help.qlik.com/en-US/stitch/integrations/identify-an-integration-version)** | Released on August 23, 2019 | **Supported by**

the Info icon

Indicates if the integration is supported by Stitch or the Singer community. | [Singer Community](https://www.singer.io/) | | **Stitch plan**

the Info icon

The type of Stitch plan required to use the integration. | Standard | **[API availability](https://help.qlik.com/en-US/stitch/developers/stitch-connect/guides/source-destination-reference)**

the Info icon

Indicates if the integration is available as a source in Stitch Connect. | the Success icon

This version of the integration is available via the API.


Available | | **Singer GitHub repository** | [singer-io/tap-ringcentral](https://github.com/singer-io/tap-ringcentral) | | | | **REPLICATION SETTINGS** | | | | | **[Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)**

the Info icon

A type of replication scheduling where an integration's Replication Frequency is anchored to a time you select. | the Success icon

This feature is supported for this version of the integration.


Supported | **[Advanced Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling)**

the Info icon

A type of replication scheduling that allows you to specify granular start times for data extraction using cron expressions. | the Success icon

This feature is supported for this version of the integration.


Supported | | **Table-level reset**

the Info icon

Indicates if data can be reset at the table level. If unsupported, data can only be reset at the integration level. | the Remove icon

Table-level resets are not supported for this integration. Resets are only supported at the integration level.


Unsupported | **[Configurable Replication Methods](https://help.qlik.com/en-US/stitch/replication/replication-methods)**

the Info icon

Indicates if Replication Methods can be defined by you for tables in the integration. | the Remove icon

Configurable Replication Methods are not supported for this integration. Stitch will use pre-defined replication methods for tables you set to replicate.


Unsupported | | **DATA SELECTION** | | | | | **Table selection**

the Info icon

The ability to select individual tables for replication in the Stitch interface. If table selection is unavailable, all tables and all the columns they contain will be set to replicate by default. | the Success icon

This feature is supported for this version of the integration.


Supported | **Column selection**

the Info icon

The ability to select individual columns for replication in the Stitch interface. If column selection is unavailable, all columns will be set to replicate by default. | the Success icon

This feature is supported for this version of the integration.


Supported | | **Select all**

the Info icon

Indicates if the integration supports selecting all available tables and columns. | the Success icon

Supported


Supported | | | | **TRANSPARENCY** | | | | | **[Extraction Logs](https://help.qlik.com/en-US/stitch/replication/extractions/integration-extraction-logs)**

the Info icon

Logs detailing the Extraction phase of the replication process for a given integration. Includes error info, should an error occur. | the Success icon

This feature is supported for this version of the integration.


Supported | **[Loading Reports](https://help.qlik.com/en-US/stitch/replication/integration-loading-reports)**

the Info icon

Reports detailing the Loading phase of the replication process for a given integration. Includes the number of rows loaded for each table and error info, should an error occur. | the Success icon

This feature is supported for this version of the integration.


Supported | ## Connecting RingCentral ### Step 1: Generate RingCentral credentials * [Step 1.1: Create a RingCentral developer application](https://help.qlik.com/en-US/stitch/integrations/saas/ringcentral#create-developer-application) * [Step 1.2: Retrieve application credentials](https://help.qlik.com/en-US/stitch/integrations/saas/ringcentral#retrieve-application-credentials) #### Step 1.1: Create a RingCentral developer application In this step, you’ll create a RingCentral developer application. 1. Navigate to the [RingCentral Developer Console](https://developers.ringcentral.com/my-account.html#/applications). 2. Create a free account, if you don’t already have one. 3. After you’ve created an account and logged in, click the **Create App** button. [![RingCentral App Type & Platform window for creating a developer app.](https://help.qlik.com/en-US/stitch/images/integrations/ringcentral-app-settings.png)RingCentral App Type & Platform window for creating a developer app.RingCentral App Type & Platform window for creating a developer app.](https://help.qlik.com/en-US/stitch/images/integrations/ringcentral-app-settings.png) 1. In the window that displays, enter a name and description for the app. 2. In the **App Type & Platform** window, fill in the fields as follows: * **Application Type**: Select **Private**. * **Platform Type**: Select **Server-only (No UI)**. 3. Click **Next**. [![RingCentral OAuth Settings window for creating a developer app.](https://help.qlik.com/en-US/stitch/images/integrations/ringcentral-app-permissions.png)RingCentral OAuth Settings window for creating a developer app.RingCentral OAuth Settings window for creating a developer app.](https://help.qlik.com/en-US/stitch/images/integrations/ringcentral-app-permissions.png) 1. Next, you’ll grant permissions to the app. In the **Permissions Needed** field, select the following: * **Read Accounts** * **Read Call Log** * **Read Messages** 2. Click **Create**. #### Step 1.2: Retrieve application credentials After your application is created, you’ll retrieve its credentials. 1. On the **Apps** page, click the developer application you created in the previous step. 2. Click the **Credentials** option in the menu on the left side of the page. [![RingCentral Application Credentials page with the Production Environment column highlighted.](https://help.qlik.com/en-US/stitch/images/integrations/ringcentral-app-credentials.png)RingCentral Application Credentials page with the Production Environment column highlighted.RingCentral Application Credentials page with the Production Environment column highlighted.](https://help.qlik.com/en-US/stitch/images/integrations/ringcentral-app-credentials.png) 1. In the **Application Credentials** section, locate the following in the **Production Environment** column: * **API Server URL** * **Client ID** * **Client Secret** Keep this page handy for now - you’ll need it to complete the setup in Stitch. ### Step 2: Add RingCentral as a Stitch data source 1. [Sign into your Stitch account](https://app.stitchdata.com/). 2. On the Stitch Dashboard page, click the **Add Integration** button. 3. Click the **RingCentral** icon. 4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination. For example, the name “Stitch RingCentral” would create a schema called `stitch_ringcentral` in the destination. **Note**: Schema names cannot be changed after you save the integration. 5. In the **Client ID** field, enter the **Client ID** from [Step 1.2](https://help.qlik.com/en-US/stitch/integrations/saas/ringcentral#retrieve-application-credentials). 6. In the **Client Secret** field, enter the **Client Secret** from [Step 1.2](https://help.qlik.com/en-US/stitch/integrations/saas/ringcentral#retrieve-application-credentials). 7. In the **Username** field, enter the username for the RingCentral developer app. This is typically the phone number used to create the app. 8. In the **Password** field, enter the password for the RingCentral developer app. 9. In the **API URL** field, enter the **API Server URL** from [Step 1.2](https://help.qlik.com/en-US/stitch/integrations/saas/ringcentral#retrieve-application-credentials). ### Step 3: Define the historical replication start date The Sync Historical Data setting defines the starting date for your RingCentral integration. This means that data **equal to or newer than this date** will be replicated to your data warehouse. Change this setting if you want to replicate data beyond RingCentral’s default setting of **1 year**. For a detailed look at historical replication jobs, check out the [Syncing Historical SaaS Data](https://help.qlik.com/en-US/stitch/replication/syncing-historical-saas-data-resetting-replication-keys) guide. ### Step 4: Create a replication schedule Information note Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the [Replication Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling) documentation for more information. In the **Replication Frequency** section, you’ll create the integration’s [replication schedule](https://help.qlik.com/en-US/stitch/replication/replication-scheduling). An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins. RingCentral integrations support the following replication scheduling methods: * [Replication Frequency](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/replication-frequency) * [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling) * [Advanced Scheduling using Cron](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling) (Advanced or Premium plans only) To keep your row usage low, consider setting the integration to replicate less frequently. See the [Understanding and Reducing Your Row Usage guide](https://help.qlik.com/en-US/stitch/getting-started/understanding-stitch-usage) for tips on reducing your usage. ### Step 5: Set objects to replicate Information note **Is an object missing or not replicating?** Verify that the object meets the requirements for [selection](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#selection-requirements) and [replication](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#replication-requirements). The last step is to select the tables and columns you want to replicate. [Learn about the available tables for this integration.](https://help.qlik.com/en-US/stitch/integrations/saas/ringcentral#schema) **Note**: If a replication job is currently in progress, new selections won’t be used until the next job starts. * Selection options * Individual tables and columns * All tables and columns For RingCentral integrations, you can select: 1. **Individual tables and columns** 2. **All tables and columns** Click the tabs to view instructions for each selection method. 1. In the integration’s **Tables to Replicate tab**, locate a table you want to replicate. 2. To track a table, click the **checkbox** next to the table’s name. A blue checkmark means the table is set to replicate. 3. To track a column, click the **checkbox** next to the column’s name. A blue checkmark means the column is set to replicate. 4. Repeat this process for all the tables and columns you want to replicate. 5. When finished, click the **Finalize Your Selections** button at the bottom of the screen to save your selections. Information note **Important**: Using the **Select All** feature will overwrite any previous selections. However, selections aren’t final until **Finalize Your Selections** is clicked. Clicking **Cancel** will restore your previous selections. Refer to the [Select All guide](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#set-all-data-to-replicate) for more info about this feature. 1. Click into the integration from the Stitch Dashboard page. 2. Click the **Tables to Replicate** tab. 3. In the list of tables, click the box next to the **Table Names** column. 4. In the menu that displays, click **Track all Tables and Fields**: ![The Track all Tables and Fields menu in the Tables to Replicate tab](https://help.qlik.com/en-US/stitch/images/replication/select-all-tables-menu.png)The Track all Tables and Fields menu in the Tables to Replicate tabThe Track all Tables and Fields menu in the Tables to Replicate tab 5. Click the **Finalize Your Selections** button at the bottom of the page to save your data selections. ### Initial and historical replication jobs After you finish setting up RingCentral, its **Sync Status** may show as **Pending** on either the Stitch Dashboard or in the Integration Details page. For a new integration, a **Pending** status indicates that Stitch is in the process of scheduling the initial replication job for the integration. **This may take some time to complete.** Information note **Initial replication jobs with Anchor Scheduling** If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling#job-scheduling-and-anchor-times) documentation for more information. #### Free historical data loads The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota. Information note **Replication will continue after the seven days are over**. If you’re no longer interested in this source, be sure to **pause** or **delete** the integration to prevent unwanted usage. ## RingCentral table reference Information note **Schemas and versioning** Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing. The schema and info displayed below is for **version 1** of this integration. This is the latest version of the RingCentral integration. Information note **Table and column names in your destination** Depending on your destination, table and column names may not appear as they are outlined below. For example: Object names are lowercased in Redshift (`CusTomERs` > `customers`), while case is maintained in PostgreSQL destinations (`CusTomERs` > `CusTomERs`). Refer to the [Loading Guide](https://help.qlik.com/en-US/stitch/replication/loading/destination-guides) for your destination for more info. ### call\_log The `call_log` contains info about your call logs. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Useful links** | [call_log schema on GitHub](https://github.com/singer-io/tap-ringcentral/blob/master/tap_ringcentral/schemas/call_log.json "Opens in new tab: call_log schema on GitHub")


[RingCentral API method](https://developers.ringcentral.com/api-reference/Call-Log/readUserCallLog "Opens in new tab: RingCentral API method") | call\_log table schema | **\_contact\_id**


INTEGER | | --- | | **action**


STRING | | **direction**


STRING | | **duration**


INTEGER | | **extension**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand extension

id

INTEGER

uri

STRING

| | **from**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand from

extensionId

STRING

location

STRING

name

STRING

phoneNumber

STRING

| | **id**


STRING | | **result**


STRING | | **sessionId**


STRING | | **startTime**


DATE-TIME | | **to**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand to

extensionId

STRING

location

STRING

name

STRING

phoneNumber

STRING

| | **type**


STRING | | **uri**


STRING | ### company\_call\_log The `company_call_log` contains info about company call log records. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Useful links** | [company_call_log schema on GitHub](https://github.com/singer-io/tap-ringcentral/blob/master/tap_ringcentral/schemas/company_call_log.json "Opens in new tab: company_call_log schema on GitHub")


[RingCentral API method](https://developers.ringcentral.com/api-reference#Call-Log-loadCompanyCallLog "Opens in new tab: RingCentral API method") | company\_call\_log table schema | **\_contact\_id**


INTEGER | | --- | | **action**


STRING | | **direction**


STRING | | **duration**


INTEGER | | **extension**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand extension

id

INTEGER

uri

STRING

| | **from**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand from

location

STRING

name

STRING

phoneNumber

STRING

| | **id**


STRING | | **result**


STRING | | **sessionId**


STRING | | **startTime**


DATE-TIME | | **to**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand to

location

STRING

name

STRING

phoneNumber

STRING

| | **type**


STRING | | **uri**


STRING | ### contacts The `contacts` contains info about corporate users of federated accounts. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Useful links** | [contacts schema on GitHub](https://github.com/singer-io/tap-ringcentral/blob/master/tap_ringcentral/schemas/contacts.json "Opens in new tab: contacts schema on GitHub")


[RingCentral API method](https://developers.ringcentral.com/api-reference/Internal-Contacts/readDirectoryEntry "Opens in new tab: RingCentral API method") | contacts table schema | **account**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand account

id

INTEGER

| | --- | | **email**


STRING | | **extensionNumber**


INTEGER | | **firstName**


STRING | | **id**


INTEGER | | **jobTitle**


STRING | | **lastName**


STRING | | **name**


STRING | | **phoneNumbers**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand phoneNumbers

phoneNumber

STRING

type

STRING

usageType

STRING

| | **status**


STRING | | **type**


STRING | ### messages The `messages` contains info about an extension mailbox’s messages. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Keys ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id

conversationId | | **Useful links** | [messages schema on GitHub](https://github.com/singer-io/tap-ringcentral/blob/master/tap_ringcentral/schemas/messages.json "Opens in new tab: messages schema on GitHub")


[RingCentral API method](https://developers.ringcentral.com/api-reference/Message-Store/listMessages "Opens in new tab: RingCentral API method") | messages table schema | **\_contact\_id**


INTEGER | | --- | | **availability**


STRING | | **coverIndex**


INTEGER | | **creationTime**


DATE-TIME | | **direction**


STRING | | **faxPageCount**


INTEGER | | **faxResolution**


STRING | | **id**


STRING | | **lastModifiedTime**


DATE-TIME | | **messageStatus**


STRING | | **priority**


STRING | | **readStatus**


STRING | | **type**


STRING | | **uri**


STRING |