Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to RingCentral

Scalekit connector
Open markdown

The RingCentral connector lets your AI agent act in each user's RingCentral account. Each user signs in to RingCentral once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 26 tools.

Tools
26
What they doRead · write · destructive
16 · 7 · 316 read7 write3 destructive
Users sign in with
OAuth app
Your own RingCentral app

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the RingCentral connection

    In AgentKit > Connections, create a RingCentral connection and copy its redirect URI. The name you give it is the connection_name your code passes. See Configure connections.

  4. Register an OAuth app

    RingCentral connections use your own OAuth app. Register one with RingCentral and add the redirect URI you copied.

    Then enter the app's Client ID and Client Secret on the RingCentral connection.

  5. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'ringcentral'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize RingCentral:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'ringcentral_active_calls_list',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user signs in once. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • ringcentral_active_calls_listList the signed-in user's calls that are in progress right now.Read-only

    List Active Calls

    List the signed-in user's calls that are in progress right now. Returns each call's sessionId, direction, from, to, startTime and result. Use this to see current calls. Use ringcentral_call_log_list for finished calls.

    Inputs

    directionarray
    Only calls in these directions. Example: ["Inbound"]
  • ringcentral_call_log_listList the signed-in user's call history.Read-only

    List My Call Log

    List the signed-in user's call history. Returns each call record's id, sessionId, startTime, duration, direction, type, action, result, from, to and recording info. Use this for the user's own calls. Use ringcentral_company_call_log_list for every user in the account.

    Inputs

    date_fromstring
    Start of the time range, ISO 8601. Defaults to 24 hours ago. Example: 2026-11-01T00:00:00.000Z
    date_tostring
    End of the time range, ISO 8601. Defaults to now. Example: 2026-11-15T00:00:00.000Z
    directionarray
    Only calls in these directions. Example: ["Inbound"]
    pageinteger
    Page number of call records to return, starting at 1. Example: 2
    per_pageinteger
    Number of call records per page. Example: 100
    phone_numberstring
    Only calls to or from this number. Use E.164 format with +. Example: +16505550100
    typearray
    Only these call types. Example: ["Voice"]
    viewstring
    Simple (default) or Detailed, which adds each call leg. Example: Simpleone of SimpleDetailed
    with_recordingboolean
    Only calls that have a recording. Example: true
  • ringcentral_call_record_getGet one call record from the signed-in user's call log.Read-only

    Get Call Record

    Get one call record from the signed-in user's call log. Returns its startTime, duration, direction, from, to, result, recording and, with Detailed view, the call legs. Use this for one call's details.

    Inputs

    call_record_idstringrequired
    ID of the call record. Get it from ringcentral_call_log_list. Example: Y3s3cC4E4b2ZdxUA
  • ringcentral_chat_posts_listList the posts (messages) in a RingCentral team messaging chat, newest first.Read-only

    List Chat Posts

    List the posts (messages) in a RingCentral team messaging chat, newest first. Returns each post's id, creatorId, text, attachments, creationTime and mentions, plus navigation.prevPageToken. Use this to read a conversation. Use ringcentral_chat_post_create to reply.

    Inputs

    chat_idstringrequired
    ID of the team messaging chat (team, group or direct conversation). Get it from ringcentral_chats_list. Example: 147193860102
    page_tokenstring
    Page token from the previous page's navigation. Example: 4fbd1d2a-7cb3
    record_countinteger
    Maximum number of posts to return. Example: 30
  • ringcentral_chats_listList the signed-in user's RingCentral team messaging chats: teams, group chats and direct conversations.Read-only

    List Team Chats

    List the signed-in user's RingCentral team messaging chats: teams, group chats and direct conversations. Returns each chat's id, type, name, members and lastModifiedTime, plus navigation.nextPageToken. Use this to find a chat_id before reading or posting messages.

    Inputs

    page_tokenstring
    navigation.nextPageToken from the previous page. Example: 4fbd1d2a-7cb3
    record_countinteger
    Maximum number of chats to return. Example: 30
    typearray
    Only these chat types. Example: ["Team", "Direct"]
  • ringcentral_company_call_log_listList call history for every user in the RingCentral account.Read-only

    List Company Call Log

    List call history for every user in the RingCentral account. Returns call records with extension, startTime, duration, direction, from, to and result. Use this for account-wide reporting. Needs an admin user. Use ringcentral_call_log_list for the user's own calls.

    Inputs

    date_fromstring
    Start of the time range, ISO 8601. Defaults to 24 hours ago. Example: 2026-11-01T00:00:00.000Z
    date_tostring
    End of the time range, ISO 8601. Defaults to now. Example: 2026-11-15T00:00:00.000Z
    directionarray
    Only calls in these directions. Example: ["Outbound"]
    extension_numberstring
    Only calls of this extension number. Example: 101
    pageinteger
    Page number of call records to return, starting at 1. Example: 2
    per_pageinteger
    Number of call records per page. Example: 100
    phone_numberstring
    Only calls to or from this number. Use E.164 format with +. Example: +16505550100
  • ringcentral_contact_getGet one contact from the signed-in user's personal address book.Read-only

    Get Personal Contact

    Get one contact from the signed-in user's personal address book. Returns its name, company, job title, emails, phone numbers, addresses and notes. Use this when you know the contact_id.

    Inputs

    contact_idstringrequired
    ID of the personal contact. Get it from ringcentral_contacts_list. Example: 623045004
  • ringcentral_contacts_listList the signed-in user's personal address book contacts.Read-only

    List Personal Contacts

    List the signed-in user's personal address book contacts. Returns each contact's id, name, company, email and phone numbers. Use this to find a personal contact. Use ringcentral_directory_search for colleagues.

    Inputs

    pageinteger
    Page number of contacts to return, starting at 1. Example: 2
    per_pageinteger
    Number of contacts per page. Example: 100
    sort_byarray
    Fields to sort by. Example: ["LastName"]
    starts_withstring
    Only contacts whose first name, last name or company starts with this text. Example: Ru