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
- OAuth app
- Your own RingCentral app
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. 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>Create the RingCentral connection
In AgentKit > Connections, create a RingCentral connection and copy its redirect URI. The name you give it is the
connection_nameyour code passes. See Configure connections.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.
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.actionsconst connector = 'ringcentral'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'ringcentral_active_calls_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "ringcentral"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize RingCentral:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="ringcentral_active_calls_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user signs in once. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolringcentral_active_calls_listList the signed-in user's calls that are in progress right now.Read-onlyList 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-onlyList 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-onlyGet 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-onlyList 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-onlyList 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-onlyList 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-onlyGet 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-onlyList 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
ringcentral_directory_searchSearch the RingCentral company directory by name, email, phone or extension number.Read-onlySearch Company Directory
Search the RingCentral company directory by name, email, phone or extension number. Returns matching entries with id, name, extensionNumber, email, phone numbers, type and status. Use this to find a colleague by name. Use ringcentral_extensions_list to list everyone.
Inputs
search_stringstringrequired- Text to search for. Example: dana
pageinteger- Page number of results to return, starting at 1. Example: 2
per_pageinteger- Number of results per page. Example: 25
search_fieldsarray- Fields to search in: firstName, lastName, extensionNumber, phoneNumber, email, jobTitle, department. Omit to search all. Example: ["firstName", "lastName", "email"]
ringcentral_extension_getGet the signed-in RingCentral user's extension.Read-onlyGet My Extension
Get the signed-in RingCentral user's extension. Returns the extension id, extensionNumber, name, contact (email, phone), type, status, regional settings and permissions. Use this to learn who is connected and their extension number. Use ringcentral_extensions_list for other users.
Inputs
This tool takes no inputs.
ringcentral_extensions_listList the extensions (users, departments, IVR menus and other endpoints) in the RingCentral account.Read-onlyList Extensions
List the extensions (users, departments, IVR menus and other endpoints) in the RingCentral account. Returns each extension's id, extensionNumber, name, type, status and contact. Use this to find colleagues and their extension numbers. Use ringcentral_directory_search to search by name.
Inputs
extension_numberstring- Only the extension with this short number. Example: 101
pageinteger- Page number of extensions to return, starting at 1. Example: 2
per_pageinteger- Number of extensions per page. Example: 100
statusarray- Only extensions with these statuses. Example: ["Enabled"]
typearray- Only these extension types, such as User or Department. Example: ["User"]
ringcentral_message_getGet one message from the signed-in user's message store.Read-onlyGet Message
Get one message from the signed-in user's message store. Returns its type, direction, from, to, subject, readStatus, creationTime and attachment links (voicemail audio, fax pages, transcription). Use this for one message's details.
Inputs
message_idstringrequired- ID of the message. Get it from ringcentral_messages_list. Example: 1724099032020
ringcentral_messages_listList the signed-in user's messages: SMS, voicemail, fax and internal pager messages.Read-onlyList Messages
List the signed-in user's messages: SMS, voicemail, fax and internal pager messages. Returns each message's id, type, direction, from, to, subject (SMS text), readStatus, creationTime and attachments. Use this to read texts and voicemails. Use ringcentral_message_get for one message.
Inputs
conversation_idstring- Only messages in this SMS conversation. Example: 7173416693124693000
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 messages in these directions. Example: ["Inbound"]
message_typearray- Only these message types. Example: ["SMS"]
pageinteger- Page number of messages to return, starting at 1. Example: 2
per_pageinteger- Number of messages per page. Example: 100
phone_numberstring- Only messages to or from this number. Use E.164 format with +. Example: +16505550100
read_statusarray- Only messages with these read statuses. Example: ["Unread"]
ringcentral_presence_getGet the presence of a RingCentral user: availability, Do Not Disturb, and whether they are on a call.Read-onlyGet Presence
Get the presence of a RingCentral user: availability, Do Not Disturb, and whether they are on a call. Returns presenceStatus, userStatus, dndStatus, telephonyStatus and, if detailed, active calls. Use this before calling or messaging someone.
Inputs
extension_idstringrequired- Extension ID of the user, or ~ for the signed-in user. Example: ~
detailed_telephony_stateboolean- Include details of the user's active calls. Example: true
ringcentral_ringout_getGet the status of a RingOut call.Read-onlyGet RingOut Status
Get the status of a RingOut call. Returns callStatus, callerStatus and calleeStatus (for example InProgress, Success, NoAnswer, Busy). Use this to follow a call started with ringcentral_ringout_create.
Inputs
ringout_idstringrequired- ID returned by ringcentral_ringout_create. Example: 234343434
ringcentral_video_meetings_listList the signed-in user's past RingCentral Video meetings.Read-onlyList Video Meetings
List the signed-in user's past RingCentral Video meetings. Returns each meeting's id, displayName, startTime, duration, participants and recordings. Use this to review past meetings.
Inputs
page_tokenstring- Page token from the previous page's paging. Example: dXNlcjo2MDQ4
per_pageinteger- Number of meetings per page. Example: 25
textstring- Only meetings whose name contains this text. Example: standup
typestring- All, My (hosted by the user), Deleted or Shared. Example: Myone of
AllMyDeletedShared
ringcentral_chat_post_createPost a message in a RingCentral team messaging chat as the signed-in user.WritePost to Chat
Post a message in a RingCentral team messaging chat as the signed-in user. Returns the new post with its id. Use this to message a team or a colleague in RingCentral app. Use ringcentral_sms_send for phone numbers.
Inputs
chat_idstringrequired- ID of the team messaging chat (team, group or direct conversation). Get it from ringcentral_chats_list. Example: 147193860102
textstringrequired- Message text, up to 10,000 characters; Markdown is supported. Example: Deploy finished, all green.
ringcentral_contact_createAdd a contact to the signed-in user's personal address book.WriteCreate Personal Contact
Add a contact to the signed-in user's personal address book. Returns the new contact with its id. Use this to save a new person. Use ringcentral_contact_update to change an existing contact.
Inputs
business_phonestring- Business phone in E.164 format. Example: +16505550123
companystring- Company name. Example: Contoso
emailstring- Email address. Example: dana@contoso.com
first_namestring- First name. Example: Dana
home_phonestring- Home phone in E.164 format. Example: +16505550125
job_titlestring- Job title. Example: Head of IT
last_namestring- Last name. Example: Ruiz
mobile_phonestring- Mobile phone in E.164 format. Example: +16505550124
notesstring- Free-text notes. Example: Met at the Q3 summit
ringcentral_contact_updateChange some fields of a contact in the signed-in user's personal address book.WriteUpdate Personal Contact
Change some fields of a contact in the signed-in user's personal address book. Returns the updated contact. Use this to edit a contact. Only the fields you pass are changed.
- Idempotent
Inputs
contact_idstringrequired- ID of the personal contact. Get it from ringcentral_contacts_list. Example: 623045004
business_phonestring- Business phone in E.164 format. Example: +16505550123
companystring- Company name. Example: Contoso
emailstring- Email address. Example: dana@contoso.com
first_namestring- First name. Example: Dana
home_phonestring- Home phone in E.164 format. Example: +16505550125
job_titlestring- Job title. Example: Head of IT
last_namestring- Last name. Example: Ruiz
mobile_phonestring- Mobile phone in E.164 format. Example: +16505550124
notesstring- Free-text notes. Example: Met at the Q3 summit
ringcentral_message_updateMark a message in the signed-in user's message store as read or unread.WriteMark Message Read
Mark a message in the signed-in user's message store as read or unread. Returns the updated message. Use this after handling a text or voicemail.
- Idempotent
Inputs
message_idstringrequired- ID of the message. Get it from ringcentral_messages_list. Example: 1724099032020
read_statusstringrequired- New read status: Read or Unread. Example: Readone of
ReadUnread
ringcentral_pager_message_sendSend an internal text (pager) message to other extensions in the same RingCentral account.WriteSend Internal Pager Message
Send an internal text (pager) message to other extensions in the same RingCentral account. Returns the created message with its id. Use this for internal messages between colleagues. Use ringcentral_sms_send for external numbers.
Inputs
textstringrequired- Message text, up to 1024 characters. Example: Joining the call in 2 minutes.
to_extension_numbersarrayrequired- Extension numbers to send to. Example: ["102"]
ringcentral_ringout_createPlace a two-legged RingOut call: RingCentral first rings the user's own phone (from), then connects it to the other party (to).WriteMake RingOut Call
Place a two-legged RingOut call: RingCentral first rings the user's own phone (from), then connects it to the other party (to). Returns the RingOut id and its status. Use this to start a call for the user. Use ringcentral_ringout_get to follow it and ringcentral_ringout_cancel to stop it. Uses call minutes and rings real phones.
Inputs
from_numberstringrequired- The user's own phone that rings first: a RingCentral number or a forwarding number of the user. Use E.164 format with +. Example: +16505550100
to_numberstringrequired- The number to call once the user answers. Use E.164 format with +. Example: +16505550199
caller_idstring- Number shown to the called party; must be one of the user's RingCentral numbers. Omit to use the default. Use E.164 format with +. Example: +16505550100
play_promptboolean- Play the 'press 1 to connect' prompt when the user answers. Example: false
ringcentral_sms_sendSend an SMS from one of the signed-in user's SMS-enabled RingCentral numbers.WriteSend SMS
Send an SMS from one of the signed-in user's SMS-enabled RingCentral numbers. Returns the created message with its id, conversationId and messageStatus. Use this to text external numbers. Use ringcentral_pager_message_send for internal messages between extensions. Sends a real, billable message.
Inputs
from_numberstringrequired- The user's own SMS-enabled RingCentral number to send from. Use E.164 format with +. Example: +16505550100
textstringrequired- Message text, up to 1000 characters. Example: Your appointment is confirmed for 3 PM.
to_numbersarrayrequired- Recipient numbers in E.164 format; more than one creates a group message. Example: ["+16505550199"]
ringcentral_contact_deleteDelete a contact from the signed-in user's personal address book.DestructiveDelete Personal Contact
Delete a contact from the signed-in user's personal address book. Returns no content on success. Use this to remove a personal contact.
- Idempotent
Inputs
contact_idstringrequired- ID of the personal contact. Get it from ringcentral_contacts_list. Example: 623045004
ringcentral_message_deleteDelete a message from the signed-in user's message store.DestructiveDelete Message
Delete a message from the signed-in user's message store. Returns no content on success. Without purge the message moves to Deleted and can still be listed with availability Deleted. Use this to remove a text, voicemail or fax.
- Idempotent
Inputs
message_idstringrequired- ID of the message. Get it from ringcentral_messages_list. Example: 1724099032020
purgeboolean- Delete permanently instead of moving to Deleted. Example: false
ringcentral_ringout_cancelCancel a RingOut call that is still ringing.DestructiveCancel RingOut Call
Cancel a RingOut call that is still ringing. Returns no content on success. Use this to stop a call started with ringcentral_ringout_create before it connects.
- Idempotent
Inputs
ringout_idstringrequired- ID returned by ringcentral_ringout_create. Example: 234343434
No tools match.