# Ring Central

{% hint style="success" %}
**Audience:** Admins, Developers, Solution Architects

**Purpose:** Explains how to install, configure, and use the RingCentral plugin in <code class="expression">space.vars.Kizen\_company\_name</code> to support calling, call logging, and call recordings.
{% endhint %}

## Overview

The RingCentral plugin is used to integrate your RingCentral dialer account with <code class="expression">space.vars.Kizen\_company\_name</code>. It supports incoming and outgoing calls, automatic <code class="expression">space.vars.contact</code> linking, and automatic call logging, including storing call recordings.

### Installation <a href="#installation" id="installation"></a>

When enabling the RingCentral plugin for the first time in a new business, the default configuration will look for an <code class="expression">space.vars.object</code> with an API name of `phone_call`. In order to use the plugin with default settings, your business will need to have a <code class="expression">space.vars.object</code> configured currently. The following kzn file contains the <code class="expression">space.vars.object</code> needed. It can be imported to your business to get started right away.&#x20;

{% file src="/files/hEGseAiKlxKZGvosTzm4" %}

To override this behavior, add a config key `callSummaryObject.objectID`, set to the ID of the desired <code class="expression">space.vars.object</code> to store call logs instead of the default.

***

## Features <a href="#features" id="features"></a>

The RingCentral plugin supports handling both incoming calls and outgoing calls, as well as storing call log information and call recordings.

### Incoming Call

When a call comes in and the <code class="expression">space.vars.Kizen\_company\_name</code> application is open, the incoming call will attempt to be matched to a <code class="expression">space.vars.contact</code>. If the caller matches one or more <code class="expression">space.vars.contacts</code>, the toast will show the <code class="expression">space.vars.contact</code> name. Otherwise, it shows the caller phone number.

<div data-with-frame="true"><figure><img src="/files/MB5jI7Pj0bXgLEZeHyQG" alt="" width="563"><figcaption></figcaption></figure></div>

When a call starts ringing, the RingCentral embedded dialer will automatically expand if it was hidden to show the call controls.

{% hint style="info" %}
**Note:** By default, the plugin searches for matching contacts based on the phone number. If you store people in <code class="expression">space.vars.Kizen\_company\_name</code> using a different approach, this search endpoint can be configured using the config key `callerLookupEndpoint`.
{% endhint %}

### Active Call

When a call is active, a screen is shown with a list of any matching <code class="expression">space.vars.contacts</code>, and an option to create a new <code class="expression">space.vars.contact</code> for the call. Selecting on a matching <code class="expression">space.vars.contact</code> will open the <code class="expression">space.vars.entity</code> in <code class="expression">space.vars.Kizen\_company\_name</code>, while selecting **New Contact** will show a dialog to create a new <code class="expression">space.vars.contact</code> based on the phone number currently active in the call.

<div data-with-frame="true"><figure><img src="/files/28NndXSp1KxIZGbFycKp" alt="" width="563"><figcaption></figcaption></figure></div>

### Completed Call

After a call is completed, it will show in the RingCentral dialer calls section. Once it has been successfully logged to <code class="expression">space.vars.Kizen\_company\_name</code>, a small icon showing a piece of paper and a pencil will appear next to the duration indicator:

<div data-with-frame="true"><figure><img src="/files/NuvvWA8aX42pJ1wqtHvb" alt="" width="563"><figcaption></figcaption></figure></div>

If this icon is missing, it means the call hasn’t been linked to a call log in <code class="expression">space.vars.Kizen\_company\_name</code>. This usually happens automatically, but if the call was made outside of <code class="expression">space.vars.Kizen\_company\_name</code>, or the window was closed before the call was logged, it may need to be manually logged. Simply select the plus icon to manually create a call log entry:

<div data-with-frame="true"><figure><img src="/files/duADXQejT3v98bdX3kH3" alt="" width="563"><figcaption></figcaption></figure></div>

After a call has been logged, selecting the edit button (pencil icon) will fetch the call details and update the <code class="expression">space.vars.Kizen\_company\_name</code> call log. This is useful if the call log was updated later, such as a call recording being added. Selecting on the 3-dot menu will give additional options, including **View log details**. Selecting this option will open the associated call log <code class="expression">space.vars.entity</code> in <code class="expression">space.vars.Kizen\_company\_name</code>:

<div data-with-frame="true"><figure><img src="/files/vBAcXE7iYFzZ1kxZPnOG" alt="" width="563"><figcaption></figcaption></figure></div>

### Call Recordings

When a call is recorded, <code class="expression">space.vars.Kizen\_company\_name</code> will store a copy of the recording on the call log <code class="expression">space.vars.entity</code>. After a call is completed, RingCentral takes some time to process and deliver the recording. In most cases, the plugin handles updating the call log automatically, as long as the <code class="expression">space.vars.Kizen\_company\_name</code> application is still open. When this happens, a toast will appear with the text “A call recording was processed and added to the call log.” This call recording will be downloaded as an mp3 file and uploaded to <code class="expression">space.vars.Kizen\_company\_name</code>, so the recording never expires.

If the application is not open when a call recording is processed, it can manually by uploaded to the call log entry by selecting the edit or log call button on the entry in the RingCentral dialer.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.kizen.com/docs/integrations-and-plugins/integrations/ring-central.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.