> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/ringcentral.md).

# RingCentral

Review RingCentral calls and recordings, message team chats, place RingOut calls, and send SMS.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector   | Authentication |
| ----------- | -------------- |
| RingCentral | OAuth sign-in  |

### RingCentral

Connect RingCentral to review calls and recordings, message team chats, place RingOut calls, and send SMS.

#### Set up in RingCentral

1. Use a RingCentral account with access to the records and operations that your workflow needs.
2. If your organization restricts application access or user consent, have its administrator approve the connection before you sign in.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **RingCentral**.
2. Select **Connect**, sign in to the provider account, and review the requested access. Complete authorization to return to StackAI.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

StackAI obtains the OAuth credentials during sign-in. You do not need to paste an access token or refresh token.

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **RingCentral** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Get Call Recording

Fetch a call recording and make its audio available to later workflow steps.

**Required permissions:** `ReadCallLog`, `ReadCallRecording`.

#### Inputs

| Field     | Type            | Required | Description                                                                                                             |
| --------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------- |
| Recording | select (string) | Yes      | Recorded call to fetch. The list shows recorded calls from the last 30 days. Options load from the selected connection. |

#### Outputs

| Field          | Type    | Description                                        |
| -------------- | ------- | -------------------------------------------------- |
| Recording ID   | string  | ID of the fetched recording.                       |
| Recording file | object  | Audio file stored for use by later workflow steps. |
| Content type   | string  | MIME type of the recording audio.                  |
| Duration       | integer | Recording duration value reported by RingCentral.  |

### List Call Log Records

List recent inbound and outbound calls for the connected RingCentral user.

**Required permissions:** `ReadCallLog`.

#### Inputs

| Field                    | Type            | Required | Description                                                                                                                             |
| ------------------------ | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| From                     | datetime        | No       | Beginning of the call-log time range.                                                                                                   |
| To                       | datetime        | No       | End of the call-log time range.                                                                                                         |
| Call direction           | select (string) | No       | Whether to include inbound calls, outbound calls, or both. Available values: All, Inbound, Outbound. Default: All.                      |
| Recording type           | select (string) | No       | Optionally return only calls with a selected recording type. Available values: Any, Automatic, On demand, All recordings. Default: Any. |
| Maximum records          | integer         | No       | Maximum call records to return. Minimum: 1. Maximum: 1000. Default: 100.                                                                |
| Advanced options         | boolean         | No       | Reveal detail level, participant, and starting-page controls. Default: false.                                                           |
| Detail level             | select (string) | No       | Amount of detail returned for each call. Available values: Simple, Detailed. Default: Simple.                                           |
| Participant phone number | string          | No       | Only include calls to or from this phone number.                                                                                        |
| Starting page            | integer         | No       | Page number to start from. Minimum: 1. Default: 1.                                                                                      |

#### Outputs

| Field         | Type          | Description                                          |
| ------------- | ------------- | ---------------------------------------------------- |
| Call records  | object\_array | Structured call-log records returned by RingCentral. |
| Record count  | integer       | Number of records returned in this page.             |
| Next page     | integer       | Page number for the next batch of calls.             |
| Total records | integer       | Total matching records reported by RingCentral.      |

### List Chats

List RingCentral team chats available to the connected user.

**Required permissions:** `TeamMessaging`.

#### Inputs

| Field         | Type            | Required | Description                                                                                             |
| ------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------- |
| Chat type     | select (string) | No       | Type of chats to include. Available values: All, Personal, Direct, Group, Team, Everyone. Default: All. |
| Page token    | string          | No       | Continuation token from an earlier chat listing.                                                        |
| Maximum chats | integer         | No       | Maximum chats to return. Minimum: 1. Maximum: 250. Default: 100.                                        |

#### Outputs

| Field           | Type          | Description                                     |
| --------------- | ------------- | ----------------------------------------------- |
| Chats           | object\_array | Structured chats visible to the connected user. |
| Chat count      | integer       | Number of chats returned in this page.          |
| Next page token | string        | Token for the next batch of chats.              |

### Make Ring-Out Call

Start a two-legged outbound call from the connected user to a destination.

**Required permissions:** `ReadAccounts`, `RingOut`.

#### Inputs

| Field                | Type            | Required | Description                                                                                                                                         |
| -------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| Ring me at           | select (string) | Yes      | Number RingCentral rings first. Pick a forwarding number of the connected user or type any phone number. Options load from the selected connection. |
| Call                 | string          | Yes      | Destination phone number to connect.                                                                                                                |
| Caller ID            | select (string) | No       | Caller ID shown to the destination. Options load from the selected connection.                                                                      |
| Require confirmation | boolean         | No       | Ask the connected user to confirm before dialing the destination. Default: true.                                                                    |

#### Outputs

| Field         | Type   | Description                         |
| ------------- | ------ | ----------------------------------- |
| RingOut ID    | string | ID assigned to the RingOut request. |
| Call status   | string | Overall RingOut setup status.       |
| Caller status | string | Status of the first call leg.       |
| Callee status | string | Status of the destination call leg. |

### Send SMS

Send a business SMS from a number assigned to the connected RingCentral user.

**Required permissions:** `ReadAccounts`, `SMS`.

#### Inputs

| Field               | Type            | Required | Description                                                                                           |
| ------------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------- |
| From                | select (string) | Yes      | SMS-enabled RingCentral number that will send the message. Options load from the selected connection. |
| To                  | string          | Yes      | Phone number that will receive the SMS.                                                               |
| Message             | textarea        | Yes      | Text of the SMS message.                                                                              |
| Destination country | string          | No       | Two-letter destination country code when RingCentral needs routing context.                           |

#### Outputs

| Field           | Type     | Description                                     |
| --------------- | -------- | ----------------------------------------------- |
| Message ID      | string   | ID assigned to the outbound SMS.                |
| Message status  | string   | Current status of the outbound SMS.             |
| Conversation ID | string   | Conversation associated with the SMS.           |
| Created at      | datetime | Time RingCentral accepted the message.          |
| Sender          | string   | Phone number RingCentral used as the sender.    |
| Recipient       | string   | Phone number RingCentral used as the recipient. |

### Send Team Message

Post a text message to an accessible RingCentral team chat.

**Required permissions:** `TeamMessaging`.

#### Inputs

| Field          | Type            | Required | Description                                                                    |
| -------------- | --------------- | -------- | ------------------------------------------------------------------------------ |
| Chat           | select (string) | Yes      | Chat that will receive the message. Options load from the selected connection. |
| Message        | textarea        | Yes      | Text to post in the selected chat.                                             |
| Parent post ID | string          | No       | Post to reply to in a chat thread.                                             |
| Thread ID      | string          | No       | Existing chat thread that will receive the reply.                              |

#### Outputs

| Field        | Type     | Description                         |
| ------------ | -------- | ----------------------------------- |
| Post ID      | string   | ID of the created team post.        |
| Chat ID      | string   | ID of the destination chat.         |
| Message text | string   | Text returned for the created post. |
| Created at   | datetime | Time the post was created.          |

## Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

### New Call Record

Poll RingCentral's incremental user call-log sync no more often than every five minutes and emit new or changed call records after the initial baseline. A call whose record changes later, for example when its recording attaches, can trigger another run.

**Required permissions:** `ReadCallLog`.

#### Configuration

| Field          | Type            | Required | Description                                                                                                                                  |
| -------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| Call status    | select (string) | No       | Whether to trigger for all calls or only missed calls. Available values: All calls, Missed calls. Default: All.                              |
| Recording type | select (string) | No       | Optionally trigger only for calls with a selected recording type. Available values: Any, Automatic, On demand, All recordings. Default: Any. |
| Detail level   | select (string) | No       | Amount of call detail included in each event. Available values: Simple, Detailed. Default: Simple.                                           |

#### Event inputs

| Field       | Type   | Required | Description                                     |
| ----------- | ------ | -------- | ----------------------------------------------- |
| Call record | object | Yes      | Structured call record that caused the trigger. |

#### Outputs

| Field       | Type   | Description                                     |
| ----------- | ------ | ----------------------------------------------- |
| Call record | object | Structured call record that caused the trigger. |

## Important behavior

If an operation is denied, check the connection’s granted permissions and the account’s access in the provider. Reauthorize the connection when it needs additional permissions.

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/ringcentral.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
