rcs-channel
v0.0.6
Published
OpenClaw channel plugin for connecting to RCS (5G messaging) platform
Readme
RCS Channel Plugin 插件说明文档
RCS Channel Plugin 是适配 OpenClaw 平台的专用通道插件,核心作用是实现与 RCS(5G 消息)通道的稳定对接,助力开发者快速搭建 5G 消息交互能力,打通 OpenClaw 与 5G 消息生态的连接链路。
Protocol Support 协议支持
该插件依托标准化通信协议实现数据交互,保障传输安全性与交互规范性,具体协议适配如下:
传输协议:基于 TLS 加密的 WebSocket 协议(wss://),实现安全、低延迟的长连接通信,杜绝数据传输过程中的泄露风险
消息协议:JSON-RPC 2.0 规范,采用轻量级远程过程调用协议,简化接口交互逻辑,提升消息处理效率
鉴权方式:请求头签名鉴权,通过专属签名校验机制,严格验证接入身份合法性,保障通道接入安全
Installation 安装教程
插件提供两种安装方式,脚本工具安装操作简便、适配性强,为官方推荐方案;本地安装适合有自定义配置需求、熟悉命令行操作的开发者,可按需选择。
Method 1: Using Tool 脚本工具安装(推荐)
通过一键脚本可快速完成插件下载、部署与基础配置,全程无需手动编译,大幅简化安装流程,具体操作命令如下:
# 一键安装并完成初始配置
bash <(curl -fsSL https://minio.fontdo.com/public/openclaw-channel-install.sh)
# 备选安装命令
curl -fsSL https://minio.fontdo.com/public/openclaw-channel-install.sh -o install.sh && bash install.sh脚本运行过程中,按照终端指引依次输入 APP ID、APP KEY、绑定手机号码即可完成配置。配置生效需重启 OpenClaw 服务,执行以下命令:
# 重启 OpenClaw 网关服务,加载新配置
openclaw gateway restartMethod 2: Local Installation 本地手动安装
适合需要自定义部署路径、精细化配置的场景,通过 OpenClaw 原生插件指令完成安装,再手动补充配置文件参数,步骤如下:
# 通过 OpenClaw 插件指令安装 rcs-channel 扩展
openclaw plugins install rcs-channel安装完成后,需在 ~/.openclaw/openclaw.json 配置文件中添加对应参数(配置规则详见下文【Configuration 配置】章节),配置完毕后重启服务生效:
# 重启 OpenClaw 网关服务
openclaw gateway restart关键信息补充:所需 APP ID 与 APP KEY 需前往官方平台注册申领,申领地址:https://5g.fontdo.com/ 请妥善保管密钥信息,避免泄露。
Configuration 配置说明
插件核心配置需写入 OpenClaw 主配置文件 ~/.openclaw/openclaw.json,通过 JSON 格式定义通道参数、账号信息与运行策略,基础配置模板如下:
{
"channels": {
"rcs-channel": {
"enabled": true,
"accounts": {
"1": {
"host": "5g.fontdo.com", // RCS 平台对接地址(不含协议前缀)
"appId": "your-app-id", // 官方平台申领的应用ID
"appKey": "your-app-key", // 官方平台申领的应用密钥
"chnId": "130000000009351681", // 手机绑定后自动生成的通道ID
"phoneNumber": "13700000000", // 通道绑定的手机号码
"botName": "蜂动Claw", // 5G消息端侧显示的机器人名称
"enabled": true // 账号启用状态
}
},
"dmPolicy": "pairing",
"allowFrom": []
}
}
}Configuration Fields 配置项详解
为便于开发者精准配置参数,现将各配置项的含义、必填属性整理为表格,清晰区分必填项与选填项,避免配置失误:
| 配置项字段 | 字段说明 | 必填属性 |
| ------------- | -------------------------------------- | --------------- |
| host | RCS 对接服务器地址,无需携带 wss:// 等协议前缀,直接填写域名即可 | 是(✅) |
| appId | 平台分配的唯一应用标识,用于身份校验与通道绑定 | 是(✅) |
| appKey | 平台分配的应用密钥,配合 appId 完成签名鉴权,需严格保密 | 是(✅) |
| chnId | 完成手机号绑定后,系统自动生成的通道唯一ID,不可手动篡改 | 是(✅) |
| phoneNumber | 用于绑定 RCS 通道的手机号码,需为平台合规备案号码 | 是(✅) |
| botName | 5G 消息对话界面展示的机器人名称,支持自定义 | 否(❌,默认值:蜂动Claw) |
| enabled | 控制当前账号的启用状态,true 为启用,false 为禁用 | 否(❌,默认值:true) |
Multiple Accounts 多账号配置
插件支持多账号并行部署,可区分生产环境、测试环境账号,或配置多个业务通道,通过 defaultAccount 指定默认使用账号,多账号配置模板如下:
{
"channels": {
"rcs-channel": {
"defaultAccount": "1", // 指定默认调用的账号ID
"accounts": {
"1": {
"host": "5g.fontdo.com",
"appId": "your-app-id",
"appKey": "your-app-key",
"chnId": "130000000009351681",
"phoneNumber": "13700000000",
"botName": "Production Bot" // 生产环境机器人名称
},
"2": {
"host": "5g.fontdo.com", // 测试环境RCS平台地址
"appId": "your-app-id",
"appKey": "your-app-key",
"chnId": "130000000009351681",
"phoneNumber": "13700000000",
"botName": "Dev Bot" // 测试环境机器人名称
}
}
}
}
}Notes 注意事项
配置生效规则:无论修改插件配置还是更换账号参数,均需执行
openclaw gateway restart命令重启 OpenClaw 服务,否则新配置无法加载网络环境要求:需保障服务器网络连通性,确保可正常访问 RCS 平台域名(5g.fontdo.com),无防火墙拦截、端口限制等问题
CLI 工具使用:如需通过专属命令行工具精细化操作安装、配置流程,可调用
openclaw-rcs工具包,适配高阶运维场景密钥安全管理:APP ID 与 APP KEY 属于敏感信息,禁止明文上传至代码仓库、泄露给无关人员,建议通过环境变量或加密配置文件存储
