Movatterモバイル変換


[0]ホーム

URL:


DOCS >INTEGRATIONS >SAAS >RINGCENTRAL (V1)

Get started with a free trial today

Already have an account? Sign in

RingCentral (v1)

RingCentral is supported by the Singer community
This integration is powered bySinger's RingCentral tap. For support,visit the GitHub repo orjoin the Singer Slack.

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

Released on August 23, 2019

Supported by

Singer Community

Stitch plan

Standard

API availability

Available

Singer GitHub repository

singer-io/tap-ringcentral

REPLICATION SETTINGS
Anchor Scheduling

Supported

Advanced Scheduling

Supported

Table-level reset

Unsupported

Configurable Replication Methods

Unsupported

DATA SELECTION
Table selection

Supported

Column selection

Supported

Select all

Supported

TRANSPARENCY
Extraction Logs

Supported

Loading Reports

Supported

Connecting RingCentral

Step 1: Generate RingCentral credentials

Step 1.1: Create a RingCentral developer application

In this step, you’ll create a RingCentral developer application.

  1. Navigate to theRingCentral Developer Console.
  2. Create a free account, if you don’t already have one.
  3. After you’ve created an account and logged in, click theCreate App button.

RingCentral App Type & Platform window for creating a developer app.

  1. In the window that displays, enter a name and description for the app.
  2. In theApp Type & Platform window, fill in the fields as follows:
    • Application Type: SelectPrivate.
    • Platform Type: SelectServer-only (No UI).
  3. ClickNext.

RingCentral OAuth Settings window for creating a developer app.

  1. Next, you’ll grant permissions to the app. In thePermissions Needed field, select the following:
    • Read Accounts
    • Read Call Log
    • Read Messages
  2. ClickCreate.

Step 1.2: Retrieve application credentials

After your application is created, you’ll retrieve its credentials.

  1. On theApps page, click the developer application you created in the previous step.
  2. Click theCredentials option in the menu on the left side of the page.

RingCentral Application Credentials page with the Production Environment column highlighted.

  1. In theApplication Credentials section, locate the following in theProduction 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.
  2. On the Stitch Dashboard page, click theAdd Integration button.

  3. Click theRingCentral 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 calledstitch_ringcentral in the destination.Note: Schema names cannot be changed after you save the integration.

  5. In theClient ID field, enter theClient ID fromStep 1.2.
  6. In theClient Secret field, enter theClient Secret fromStep 1.2.
  7. In theUsername field, enter the username for the RingCentral developer app. This is typically the phone number used to create the app.
  8. In thePassword field, enter the password for the RingCentral developer app.
  9. In theAPI URL field, enter theAPI Server URL fromStep 1.2.

Step 3: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your RingCentral integration. This means that dataequal 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 of1 year. For a detailed look at historical replication jobs, check out theSyncing Historical SaaS Data guide.

Step 4: Create a replication schedule

Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to theReplication Scheduling documentation for more information.

In theReplication Frequency section, you’ll create the integration’sreplication schedule. 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:

To keep your row usage low, consider setting the integration to replicate less frequently. See theUnderstanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 5: Set objects to replicate

Is an object missing or not replicating? Verify that the object meets the requirements forselection andreplication.

The last step is to select the tables and columns you want to replicate.Learn about the available tables for this integration.

Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.

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’sTables to Replicate tab, locate a table you want to replicate.
  2. To track a table, click thecheckbox next to the table’s name. A blue checkmark means the table is set to replicate.

  3. To track a column, click thecheckbox 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 theFinalize Your Selections button at the bottom of the screen to save your selections.
Important: Using theSelect All feature will overwrite any previous selections. However, selections aren’t final untilFinalize Your Selections is clicked. ClickingCancel will restore your previous selections.Refer to theSelect All guide for more info about this feature.
  1. Click into the integration from the Stitch Dashboard page.
  2. Click theTables to Replicate tab.

  3. In the list of tables, click the box next to theTable Names column.
  4. In the menu that displays, clickTrack all Tables and Fields:

    The Track all Tables and Fields menu in the Tables to Replicate tab

  5. Click theFinalize 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, itsSync Status may show asPending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, aPending status indicates that Stitch is in the process of scheduling the initial replication job for the integration.This may take some time to complete.

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 theAnchor Scheduling 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.

Replication will continue after the seven days are over. If you’re no longer interested in this source, be sure topause ordelete the integration to prevent unwanted usage.

RingCentral table reference

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 forversion 1 of this integration.

This is the latest version of the RingCentral integration.

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 theLoading Guide for your destination for more info.

call_log

Thecall_log contains info about your call logs.

Replication Method

Key-based Incremental

Primary Key

id

Useful links

call_log schema on GitHub

RingCentral API method

_contact_id

INTEGER

action

STRING

direction

STRING

duration

INTEGER

extension

OBJECT

id

INTEGER

uri

STRING

from

OBJECT

extensionId

STRING

location

STRING

name

STRING

phoneNumber

STRING

id

STRING

result

STRING

sessionId

STRING

startTime

DATE-TIME

to

OBJECT

extensionId

STRING

location

STRING

name

STRING

phoneNumber

STRING

type

STRING

uri

STRING

company_call_log

Thecompany_call_log contains info about company call log records.

Replication Method

Key-based Incremental

Primary Key

id

Useful links

company_call_log schema on GitHub

RingCentral API method

_contact_id

INTEGER

action

STRING

direction

STRING

duration

INTEGER

extension

OBJECT

id

INTEGER

uri

STRING

from

OBJECT

location

STRING

name

STRING

phoneNumber

STRING

id

STRING

result

STRING

sessionId

STRING

startTime

DATE-TIME

to

OBJECT

location

STRING

name

STRING

phoneNumber

STRING

type

STRING

uri

STRING

contacts

Thecontacts contains info about corporate users of federated accounts.

Replication Method

Full Table

Primary Key

id

Useful links

contacts schema on GitHub

RingCentral API method

account

OBJECT

email

STRING

extensionNumber

INTEGER

firstName

STRING

id

INTEGER

jobTitle

STRING

lastName

STRING

name

STRING

phoneNumbers

ARRAY

phoneNumber

STRING

type

STRING

usageType

STRING

status

STRING

type

STRING

messages

Themessages contains info about an extension mailbox’s messages.

Replication Method

Key-based Incremental

Primary Keys

id

conversationId

Useful links

messages schema on GitHub

RingCentral API method

_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

RelatedTroubleshooting

Questions? Feedback?

Did this article help? If you have questions or feedback, feel free tosubmit a pull request with your suggestions,open an issue on GitHub, orreach out to us.


[8]ページ先頭

©2009-2026 Movatter.jp