Use the RingCentral CLI from KosmoKrator to call RingCentral tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.
RingCentral can be configured headlessly with `kosmokrator integrations:configure ringcentral`.
# Install KosmoKrator first if it is not available on PATH.curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash# Configure and verify this integration.kosmokrator integrations:configure ringcentral --set access_token="$RINGCENTRAL_ACCESS_TOKEN" --enable --read allow --write ask --jsonkosmokrator integrations:doctor ringcentral --jsonkosmokrator integrations:status --json
Credentials
Authentication type: Manual OAuth tokenoauth2_manual_token. Configure credentials once, then use the same stored profile from
scripts, coding CLIs, Lua code mode, and the MCP gateway.
Key
Env var
Type
Required
Label
access_token
RINGCENTRAL_ACCESS_TOKEN
Secret secret
yes
Access Token
url
RINGCENTRAL_URL
URL url
no
API Base URL
Call RingCentral Headlessly
Use the generic call form when another coding CLI or script needs a stable universal interface.
Every function below can be called headlessly. The generic form is stable across all integrations;
the provider shortcut is shorter but specific to RingCentral.
ringcentral.ringcentral_list_messages
Read read
List messages from the RingCentral message store. Supports filtering by type (SMS, Fax, VoiceMail), date range, read status, and direction. Returns paginated message records.
Get detailed information about a specific message in the RingCentral message store by its ID. Returns the full message record including sender, recipient, subject, and content.
Send an SMS message via RingCentral. The "from" number must be a phone number assigned to the authenticated extension. The "to" number is the destination phone number.
List call log records for the authenticated RingCentral extension. Supports filtering by date range, direction, type, and phone number. Returns paginated call records with caller, receiver, duration, and result.
List contacts from the RingCentral personal address book. Supports filtering by name prefix and pagination. Returns contact records with names, phone numbers, and email addresses.
Use these parameter tables when building CLI payloads without calling integrations:schema first.
ringcentral.ringcentral_list_messages
List messages from the RingCentral message store. Supports filtering by type (SMS, Fax, VoiceMail), date range, read status, and direction. Returns paginated message records.
Filter by message type: Sms, Fax, VoiceMail, Pager, or All (default: All).
dateFrom
string
no
Start date for filtering (ISO 8601, e.g., "2025-01-01T00:00:00Z").
dateTo
string
no
End date for filtering (ISO 8601, e.g., "2025-01-31T23:59:59Z").
direction
string
no
Filter by direction: Inbound, Outbound, or All.
readStatus
string
no
Filter by read status: Read, Unread, or All.
perPage
integer
no
Number of records per page (default: 100, max: 1000).
page
integer
no
Page number for pagination (default: 1).
ringcentral.ringcentral_get_message
Get detailed information about a specific message in the RingCentral message store by its ID. Returns the full message record including sender, recipient, subject, and content.
Send an SMS message via RingCentral. The "from" number must be a phone number assigned to the authenticated extension. The "to" number is the destination phone number.
The phone number to send from (must be a RingCentral number assigned to the extension, e.g., "+16505551234").
to
string
yes
The destination phone number (e.g., "+16505559876").
text
string
yes
The SMS message body text. Maximum 160 characters per segment; longer messages are concatenated.
ringcentral.ringcentral_list_calls
List call log records for the authenticated RingCentral extension. Supports filtering by date range, direction, type, and phone number. Returns paginated call records with caller, receiver, duration, and result.
Start date for filtering (ISO 8601, e.g., "2025-01-01T00:00:00Z").
dateTo
string
no
End date for filtering (ISO 8601, e.g., "2025-01-31T23:59:59Z").
direction
string
no
Filter by direction: Inbound, Outbound, or All.
type
string
no
Filter by call type: Voice, Fax, or All.
phoneNumber
string
no
Filter by phone number (caller or receiver).
perPage
integer
no
Number of records per page (default: 100, max: 1000).
page
integer
no
Page number for pagination (default: 1).
ringcentral.ringcentral_list_contacts
List contacts from the RingCentral personal address book. Supports filtering by name prefix and pagination. Returns contact records with names, phone numbers, and email addresses.
Headless calls still follow the integration read/write permission policy. Configure read/write defaults
with integrations:configure. Add --force only for trusted automation that should bypass that policy.
