RingCentral Python API Docs | dltHub
Build a RingCentral-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
To get insights from RingCentral's RingSense API, use the endpoint at https://developers.ringcentral.com/api-reference/RingSense/getRecordingInsights with your Recording_ID or sourceRecordId. This API provides detailed conversational analytics from transcribed voice calls. The REST API base URL is https://platform.ringcentral.com and All requests require OAuth 2.0 access tokens (Bearer tokens)..
dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading RingCentral data in under 10 minutes.
What data can I load from RingCentral?
Here are some of the endpoints you can load from RingCentral:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| ringsense_recording_insights | ai/ringsense/v1/public/accounts/~/domains/pbx/records/{sourceRecordId}/insights | GET | insights | Get RingSense insights (transcript, summary, action items) for a recording |
| ringsense_recording_status | ai/ringsense/v1/public/accounts/~/domains/pbx/records/{sourceRecordId} | GET | Get recording metadata and processing status | |
| ringsense_transcript | ai/ringsense/v1/public/accounts/~/domains/pbx/records/{sourceRecordId}/transcript | GET | transcript | Retrieve transcript object for a recording |
| insights_list | /restapi/v1.0/account/ | GET | records | Example RingCentral insights/message store endpoint returning records array |
| call_recordings_list | /restapi/v1.0/account/~/recording-storage/recordings | GET | records | List call/meeting recordings |
How do I authenticate with the RingCentral API?
Use OAuth 2.0 (authorization code or server-to-server JWT) to obtain an access token; include header Authorization: Bearer <access_token> on every request.
1. Get your credentials
- Sign in to RingCentral Developer Portal (https://developers.ringcentral.com). 2) Create a new application and note client_id and client_secret. 3) Add required OAuth scopes (for RingSense: RingSense/app and relevant ai/insights scopes). 4) For server-to-server use JWT grant or implement Authorization Code grant to obtain access and refresh tokens.
2. Add them to .dlt/secrets.toml
[sources.ringcentral_ringsense_source] client_id = "your_client_id" client_secret = "your_client_secret" access_token = "your_access_token"
dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.
How do I set up and run the pipeline?
Set up a virtual environment and install dlt:
uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"
1. Install the dlt AI Workbench:
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex
This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →
2. Install the rest-api-pipeline toolkit:
dlt ai toolkit rest-api-pipeline install
This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →
3. Start LLM-assisted coding:
Use /find-source to load data from the RingCentral API into DuckDB.
The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.
4. Run the pipeline:
python ringcentral_ringsense_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline ringcentral_ringsense_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset ringcentral_ringsense_data The duckdb destination used duckdb:/ringcentral_ringsense.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline ringcentral_ringsense_pipeline show
This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.
Python pipeline example
This example loads ringsense_recording_insights and ringsense_transcript from the RingCentral API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def ringcentral_ringsense_source(access_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://platform.ringcentral.com", "auth": { "type": "bearer", "token": access_token, }, }, "resources": [ {"name": "ringsense_recording_insights", "endpoint": {"path": "ai/ringsense/v1/public/accounts/~/domains/pbx/records/{sourceRecordId}/insights", "data_selector": "insights"}}, {"name": "ringsense_transcript", "endpoint": {"path": "ai/ringsense/v1/public/accounts/~/domains/pbx/records/{sourceRecordId}/transcript", "data_selector": "transcript"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="ringcentral_ringsense_pipeline", destination="duckdb", dataset_name="ringcentral_ringsense_data", ) load_info = pipeline.run(ringcentral_ringsense_source()) print(load_info)
To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.
How do I query the loaded data?
Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.
Python (pandas DataFrame):
import dlt data = dlt.pipeline("ringcentral_ringsense_pipeline").dataset() sessions_df = data.ringsense_recording_insights.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM ringcentral_ringsense_data.ringsense_recording_insights LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("ringcentral_ringsense_pipeline").dataset() data.ringsense_recording_insights.df().head()
See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.
What destinations can I load RingCentral data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example value |
|---|---|
| DuckDB (local, default) | "duckdb" |
| PostgreSQL | "postgres" |
| BigQuery | "bigquery" |
| Snowflake | "snowflake" |
| Redshift | "redshift" |
| Databricks | "databricks" |
| Filesystem (S3, GCS, Azure) | "filesystem" |
Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.
Next steps
Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:
data-exploration— Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.dlthub-runtime— Deploy, schedule, and monitor your pipeline in production.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install
Was this page helpful?
Community Hub
Need more dlt context for RingCentral?
Request dlt skills, commands, AGENT.md files, and AI-native context.