Ringcentral

Name: Ringcentral
Rating: 4.5 (1 reviews)
Author: danbao

By danbao ⭐ 1 stars 👁 28 views ▲ 1 votes

RingCentral Team Messaging channel plugin for Moltbot(Clawdbot)

GitHub

Install

npm install -g

Configuration Example

{
  "channels": {
    "ringcentral": {
      "enabled": true,
      "credentials": {
        "clientId": "your-client-id",
        "clientSecret": "your-client-secret",
        "jwt": "your-jwt-token",
        "server": "https://platform.ringcentral.com"
      }
    }
  }
}

README

# OpenClaw RingCentral Channel

RingCentral Team Messaging channel plugin for OpenClaw. Enables bidirectional messaging with AI assistants through RingCentral Team Messaging.

## Features

- WebSocket-based real-time messaging (no public webhook required)
- JWT authentication
- Self-only mode (talk to AI as yourself)
- Support for text messages and attachments
- Typing indicators
- Adaptive Cards support (create, read, update, delete)
- **Message Actions** - Read, edit, delete messages and get chat info via agent tools

## Prerequisites

1. A RingCentral account with Team Messaging enabled
2. A RingCentral REST API App (not Bot Add-in)

## Installation

```bash
npm install -g openclaw@latest
openclaw onboard --install-daemon

openclaw plugins install openclaw-ringcentral
openclaw config set channels.ringcentral.enabled true
openclaw config set channels.ringcentral.credentials.clientId "your-client-id"
openclaw config set channels.ringcentral.credentials.clientSecret "your-client-secret"
openclaw config set channels.ringcentral.credentials.jwt "your-jwt-token"
openclaw config set channels.ringcentral.credentials.server "https://platform.ringcentral.com"
openclaw gateway restart
```

Or install from tarball:

```bash
npm pack
openclaw plugins install ./openclaw-ringcentral-<version>.tgz
```

## RingCentral App Setup

1. Go to [RingCentral Developer Portal](https://developers.ringcentral.com/)
2. Create a new app:
   - **App Type**: REST API App (most common)
   - **Auth**: JWT auth flow
3. Add permissions:
   - **Team Messaging** - Read and send messages
   - **WebSocket Subscriptions** - Real-time event subscriptions
   - **Read Accounts** - Read user information
   - **Read Messages** - Read messages
   - **WebSocket** - WebSocket access
4. Generate a JWT token for your user

## Configuration

Add to `~/.openclaw/openclaw.json`:

```json
{
  "channels": {
    "ringcentral": {
      "enabled": true,
      "credentials": {
        "clientId": "your-client-id",
        "clientSecret": "your-client-secret",
        "jwt": "your-jwt-token",
        "server": "https://platform.ringcentral.com"
      }
    }
  }
}
```

Or use environment variables:

```bash
export RINGCENTRAL_CLIENT_ID="your-client-id"
export RINGCENTRAL_CLIENT_SECRET="your-client-secret"
export RINGCENTRAL_JWT="your-jwt-token"
```

### Configuration Options

| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `enabled` | boolean | `false` | Enable the RingCentral channel |
| `credentials.clientId` | string | - | RingCentral app client ID |
| `credentials.clientSecret` | string | - | RingCentral app client secret |
| `credentials.jwt` | string | - | JWT token for authentication |
| `credentials.server` | string | `https://platform.ringcentral.com` | RingCentral API server URL |
| `selfOnly` | boolean | `true` | Only respond to JWT user in Personal chat |
| `name` | string | - | Bot display name |
| `textChunkLimit` | number | `4000` | Maximum characters per message chunk |
| `dmPolicy` | string | `"allowlist"` | DM policy (only when `selfOnly: false`) |
| `groupPolicy` | string | `"allowlist"` | Group policy (only when `selfOnly: false`) |

> **Note:** When `selfOnly: true` (default), the bot only responds to the JWT user in their Personal chat. All other policy settings (`dmPolicy`, `allowFrom`, `groupPolicy`, etc.) are ignored.

## Usage

1. Start the openclaw gateway:

```bash
openclaw gateway run
```

2. Open RingCentral app and go to your "Personal" chat (conversation with yourself)

3. Send a message - the AI will respond!

## How It Works

This plugin uses JWT authentication, which means:

- **Messages appear from your own account** (not a separate bot)
- **Default mode (`selfOnly: true`)**: Only processes messages you send to yourself
- **Personal chat only**: By default, only responds in your "Personal" chat

This is ideal for personal AI assistant use without needing to set up a separate bot account.

## Advanced Configuration

### Allow Group Chats

To enable the bot in group chats:

```json
{
  "channels": {
    "ringcentral": {
      "enabled": true,
      "selfOnly": false,
      "groupPolicy": "open",
      "dmPolicy": "open"
    }
  }
}
```

### Multiple Accounts

```json
{
  "channels": {
    "ringcentral": {
      "enabled": true,
      "defaultAccount": "work",
      "accounts": {
        "work": {
          "credentials": {
            "clientId": "work-client-id",
            "clientSecret": "work-client-secret",
            "jwt": "work-jwt-token"
          }
        },
        "personal": {
          "credentials": {
            "clientId": "personal-client-id",
            "clientSecret": "personal-client-secret",
            "jwt": "personal-jwt-token"
          }
        }
      }
    }
  }
}
```

## Message Actions

The plugin supports message actions that allow the AI agent to read, edit, and delete messages in RingCentral chats.

### Supported Actions

| Action | Description | Parameters |
|--------|-------------|------------|
| `read` | Fetch message history from a chat | `chatId`, `limit` (optional), `pageToken` (optional) |
| `edit` | Edit an existing message | `chatId`, `messageId`, `message` |
| `delete` | Delete a message | `chatId`, `messageId` |
| `channel-info` | Get chat/channel information | `chatId` |

### Configuration

Message actions are enabled by default. To disable specific actions:

```json
{
  "channels": {
    "ringcentral": {
      "actions": {
        "messages": false,
        "channelInfo": false
      }
    }
  }
}
```

### Usage Examples

Ask the AI to read messages from a chat:

```
Read the last 10 messages from chat 123456789
```

Ask the AI to summarize a conversation:

```
Summarize the messages in chat 123456789
```

### Chat Name to ID Mapping

RingCentral requires a numeric `chatId` for message actions. The agent can remember chat name to ID mappings:

1. Tell the agent the chatId once:
   ```
   The Engineering Team chat ID is 123456789, please remember this
   ```

2. Then refer to it by name:
   ```
   Read messages from Engineering Team
   ```

The agent uses OpenClaw's memory system to store and retrieve these mappings.

## Troubleshooting

### "Unauthorized for this grant type"

Your app type is wrong. Create a **REST API App** (not Bot Add-in) with JWT auth flow.

### "In order to call this API endpoint, application needs to have [Read Accounts, WebSocket Subscriptions, Team Messaging, WebSocket, Read Messages] permission"

Add **WebSocket Subscriptions** permission in your app settings. Permission changes may take a few minutes to propagate.

### Messages not being processed

1. Check that `selfOnly` mode matches your use case
2. Verify you're sending messages in a "Personal" chat (conversation with yourself)
3. Check gateway logs: `tail -f /tmp/openclaw/openclaw-*.log | grep ringcentral`

### Rate limit errors

RingCentral has API rate limits. If you see "Request rate exceeded", wait a minute before retrying.

## Supported Team Messaging APIs

This plugin implements the following RingCentral Team Messaging APIs:

### Implemented

| Category | APIs | Required Scopes |
|----------|------|-----------------|
| **Chats** | List Chats, Get Chat | `TeamMessaging` |
| **Conversations** | List, Get, Create/Open | `TeamMessaging` |
| **Posts** | List Posts, Get Post, Create, Update, Delete | `TeamMessaging` |
| **Adaptive Cards** | Create, Get, Update, Delete | `TeamMessaging` |
| **Profile** | Get Person, Get Current User, Get Company Info | `ReadAccounts`, `TeamMessaging` |
| **Attachments** | Upload, Download | `TeamMessaging` |
| **Favorite Chats** | List, Add, Remove | `TeamMessaging` |
| **Tasks** | List, Create, Get, Update, Delete, Complete | `TeamMessaging` |
| **Calendar Events** | List, Create, Get, Update, Delete | `TeamMessaging` |
| **Notes** | List, Create, Get, Update, Delete, Lock, Unlock, Publish | `TeamMessaging`, `Glip` |
| **Incoming Webhooks** | List, Create, Get, Delete, Activate, Suspend | `TeamMessaging` |
| **Teams** | List, Create, Get, Update, Delete, Join, Leave, Add/Remove Members, Archive/Unarchive | `TeamMessaging` |

### Not Yet Implemented

| Category | APIs | Required Scopes |
|----------|------|-----------------|
| **Compliance Exports** | List, Create, Get | `TeamMessaging` (admin) |

## License

MIT

channels