openclaw-ringcentral 2026.1.29-beta1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 danbao
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,186 @@
+# Moltbot RingCentral Channel
+
+RingCentral Team Messaging channel plugin for Moltbot. 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
+
+## Prerequisites
+
+1. A RingCentral account with Team Messaging enabled
+2. A RingCentral REST API App (not Bot Add-in)
+
+## Installation
+
+```bash
+curl -fsSL https://clawd.bot/install.sh | bash -s -- --beta
+moltbot plugins install moltbot-ringcentral@2026.1.29-beta4
+moltbot config set channels.ringcentral.enabled true
+moltbot config set channels.ringcentral.credentials.clientId "your-client-id"
+moltbot config set channels.ringcentral.credentials.clientSecret "your-client-secret"
+moltbot config set channels.ringcentral.credentials.jwt "your-jwt-token"
+moltbot config set channels.ringcentral.credentials.server "https://platform.ringcentral.com"
+moltbot gateway restart
+```
+
+Or install from tarball:
+
+```bash
+moltbot plugins install ./moltbot-ringcentral-2026.1.29-beta4.tgz
+```
+
+## RingCentral App Setup
+
+1. Go to [RingCentral Developer Portal](https://developers.ringcentral.com/)
+2. Create a new app:
+   - **App Type**: REST API App
+   - **Auth**: JWT auth flow
+3. Add permissions:
+   - **Team Messaging** - Read and send messages
+   - **WebSocket Subscriptions** - Real-time event subscriptions
+   - **Read Accounts** - Read user information
+4. Generate a JWT token for your user
+
+## Configuration
+
+Add to `~/.moltbot/moltbot.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 moltbot gateway:
+
+```bash
+moltbot 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"
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+## 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/moltbot/moltbot-*.log | grep ringcentral`
+
+### Rate limit errors
+
+RingCentral has API rate limits. If you see "Request rate exceeded", wait a minute before retrying.
+
+## License
+
+MIT

package/index.ts

@@ -0,0 +1,18 @@
+import type { OpenClawPluginApi } from "openclaw/plugin-sdk";
+import { emptyPluginConfigSchema } from "openclaw/plugin-sdk";
+
+import { ringcentralDock, ringcentralPlugin } from "./src/channel.js";
+import { setRingCentralRuntime } from "./src/runtime.js";
+
+const plugin = {
+  id: "ringcentral",
+  name: "RingCentral",
+  description: "OpenClaw RingCentral Team Messaging channel plugin",
+  configSchema: emptyPluginConfigSchema(),
+  register(api: OpenClawPluginApi) {
+    setRingCentralRuntime(api.runtime);
+    api.registerChannel({ plugin: ringcentralPlugin, dock: ringcentralDock });
+  },
+};
+
+export default plugin;

package/openclaw.plugin.json

@@ -0,0 +1,200 @@
+{
+  "id": "ringcentral",
+  "name": "RingCentral",
+  "description": "OpenClaw RingCentral Team Messaging channel plugin",
+  "channels": ["ringcentral"],
+  "uiHints": {
+    "enabled": {
+      "label": "Enable RingCentral"
+    },
+    "selfOnly": {
+      "label": "Self Only Mode",
+      "help": "When enabled, only respond to your own messages in Personal chat. Set to false to enable Team/Group chats."
+    },
+    "groupPolicy": {
+      "label": "Group Policy",
+      "help": "How to handle messages from Teams/Groups. Options: disabled (ignore all), allowlist (only configured teams), open (all teams with @mention)."
+    },
+    "groups": {
+      "label": "Allowed Teams",
+      "help": "Add Team IDs to enable them. Get Team ID from the RingCentral URL: app.ringcentral.com/messages/{TEAM_ID}",
+      "itemLabel": "Team ID",
+      "placeholder": "1541525766146"
+    },
+    "groups.*": {
+      "label": "Team Configuration"
+    },
+    "groups.*.enabled": {
+      "label": "Enabled",
+      "help": "Enable or disable this team"
+    },
+    "groups.*.requireMention": {
+      "label": "Require @Mention",
+      "help": "When enabled, the bot only responds when @mentioned in this team."
+    },
+    "groups.*.systemPrompt": {
+      "label": "System Prompt",
+      "help": "Custom instructions for the AI in this team. Appended to the default prompt.",
+      "placeholder": "You are a helpful assistant for the engineering team. Focus on technical questions."
+    },
+    "groups.*.users": {
+      "label": "Allowed Users",
+      "help": "List of user IDs who can trigger the bot. Leave empty to allow all team members.",
+      "placeholder": "3218766020"
+    },
+    "requireMention": {
+      "label": "Require @Mention (Global)",
+      "help": "Default setting for all teams. When enabled, the bot only responds when @mentioned."
+    },
+    "credentials": {
+      "label": "API Credentials",
+      "advanced": true
+    },
+    "credentials.clientId": {
+      "label": "Client ID",
+      "placeholder": "Your RingCentral App Client ID",
+      "sensitive": true
+    },
+    "credentials.clientSecret": {
+      "label": "Client Secret",
+      "placeholder": "Your RingCentral App Client Secret",
+      "sensitive": true
+    },
+    "credentials.jwt": {
+      "label": "JWT Token",
+      "placeholder": "eyJraWQiOi...",
+      "sensitive": true
+    },
+    "credentials.server": {
+      "label": "API Server",
+      "placeholder": "https://platform.ringcentral.com",
+      "help": "Use https://platform.devtest.ringcentral.com for sandbox"
+    },
+    "dmPolicy": {
+      "label": "DM Policy",
+      "help": "How to handle direct messages: disabled, allowlist, pairing, or open",
+      "advanced": true
+    },
+    "allowFrom": {
+      "label": "DM Allowlist",
+      "help": "User IDs allowed to send DMs",
+      "placeholder": "3218766020",
+      "advanced": true
+    },
+    "mediaMaxMb": {
+      "label": "Max Media Size (MB)",
+      "placeholder": "20",
+      "advanced": true
+    },
+    "textChunkLimit": {
+      "label": "Text Chunk Limit",
+      "placeholder": "4000",
+      "advanced": true
+    }
+  },
+  "configSchema": {
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "enabled": {
+        "type": "boolean",
+        "description": "Enable the RingCentral channel"
+      },
+      "selfOnly": {
+        "type": "boolean",
+        "description": "Only respond to JWT user in Personal chat (default: true)"
+      },
+      "groupPolicy": {
+        "type": "string",
+        "enum": ["disabled", "allowlist", "open"],
+        "description": "Policy for handling group/team messages"
+      },
+      "groups": {
+        "type": "object",
+        "additionalProperties": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "description": "Enable this team"
+            },
+            "requireMention": {
+              "type": "boolean",
+              "description": "Require @mention to trigger"
+            },
+            "systemPrompt": {
+              "type": "string",
+              "description": "Custom system prompt for this team"
+            },
+            "users": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Allowed user IDs in this team"
+            }
+          }
+        },
+        "description": "Team/Group configurations keyed by Team ID"
+      },
+      "requireMention": {
+        "type": "boolean",
+        "description": "Require @mention in group chats (global default)"
+      },
+      "credentials": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "clientId": {
+            "type": "string"
+          },
+          "clientSecret": {
+            "type": "string"
+          },
+          "jwt": {
+            "type": "string"
+          },
+          "server": {
+            "type": "string"
+          }
+        }
+      },
+      "dmPolicy": {
+        "type": "string",
+        "enum": ["disabled", "allowlist", "pairing", "open"]
+      },
+      "allowFrom": {
+        "type": "array",
+        "items": {
+          "type": ["string", "number"]
+        }
+      },
+      "groupAllowFrom": {
+        "type": "array",
+        "items": {
+          "type": ["string", "number"]
+        }
+      },
+      "mediaMaxMb": {
+        "type": "integer",
+        "minimum": 1
+      },
+      "textChunkLimit": {
+        "type": "integer",
+        "minimum": 1
+      },
+      "name": {
+        "type": "string"
+      },
+      "accounts": {
+        "type": "object",
+        "additionalProperties": {
+          "type": "object"
+        }
+      },
+      "defaultAccount": {
+        "type": "string"
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "openclaw-ringcentral",
+  "version": "2026.1.29-beta1",
+  "type": "module",
+  "main": "index.ts",
+  "description": "OpenClaw RingCentral Team Messaging channel plugin",
+  "license": "MIT",
+  "scripts": {
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/danbao/openclaw-ringcentral.git"
+  },
+  "homepage": "https://github.com/danbao/openclaw-ringcentral#readme",
+  "bugs": {
+    "url": "https://github.com/danbao/openclaw-ringcentral/issues"
+  },
+  "keywords": [
+    "openclaw",
+    "ringcentral",
+    "team-messaging",
+    "chat",
+    "bot"
+  ],
+  "files": [
+    "src",
+    "index.ts",
+    "openclaw.plugin.json",
+    "README.md"
+  ],
+  "openclaw": {
+    "extensions": [
+      "./index.ts"
+    ],
+    "channel": {
+      "id": "ringcentral",
+      "label": "RingCentral",
+      "selectionLabel": "RingCentral Team Messaging",
+      "detailLabel": "RingCentral",
+      "docsPath": "/channels/ringcentral",
+      "docsLabel": "ringcentral",
+      "blurb": "RingCentral Team Messaging via REST API and WebSocket.",
+      "aliases": [
+        "rc",
+        "ringcentral-tm"
+      ],
+      "order": 56
+    },
+    "install": {
+      "npmSpec": "openclaw-ringcentral",
+      "defaultChoice": "npm"
+    }
+  },
+  "dependencies": {
+    "@ringcentral/sdk": "^5.0.0",
+    "@ringcentral/subscriptions": "^5.0.0",
+    "isomorphic-ws": "^5.0.0",
+    "ws": "^8.18.0",
+    "zod": "^4.3.6"
+  },
+  "devDependencies": {
+    "openclaw": "2026.1.29",
+    "typescript": "^5.7.3",
+    "vitest": "^3.0.4"
+  },
+  "peerDependencies": {
+    "openclaw": ">=2026.1.29"
+  }
+}