用途
SmartReach 是一个销售互动平台,供销售团队和营销专业人员使用,帮助他们通过电子邮件、LinkedIn 和短信等多个渠道自动化和个性化地触达潜在客户。本技能用于与 SmartReach 数据进行交互,并管理组织(Organizations)。当用户希望与 SmartReach 数据交互时可以使用本技能。
官方文档:https://developers.smartreach.io/
主要能力
SmartReach 涉及的对象包括:
- Campaign(营销活动)
- Campaign Step(营销活动步骤)
- Account(账户)
- Contact(联系人)
- Sequence(序列)
- Sequence Step(序列步骤)
- Task(任务)
- User(用户)
可按需使用相应的操作名称和参数。
使用方式
本技能使用 Membrane CLI 与 SmartReach 交互。Membrane 自动处理身份验证和凭据刷新,因此用户可以将精力集中在集成逻辑上,而不必处理认证管道。
安装 CLI
在终端中运行以下命令安装 Membrane CLI:
npm install -g @membranehq/cli@latest
身份验证
membrane login --tenant --clientName=<agentType>
该命令会打开浏览器进行身份验证,或在控制台打印授权 URL,具体取决于是否可用交互模式。
无头环境:命令会打印授权 URL。请让用户在浏览器中打开它。当用户完成登录后看到验证码时,执行:
membrane login complete <code>
在任何命令后添加 --json 可获得机器可读的 JSON 输出。
Agent 类型:claude、openclaw、codex、warp、windsurf 等。这些类型用于调整工具,以便与你的运行环境最佳配合。
连接到 SmartReach
使用 membrane connection ensure 通过应用 URL 或域名查找或创建连接:
membrane connection ensure "https://smartreach.io/" --json
用户在浏览器中完成身份验证。输出中包含新的连接 id。
这是获取连接最快的方式。URL 会被规范化为域名并与已知应用匹配。如果未找到应用,则会创建一个应用并自动构建连接器。
如果返回的连接状态为 READY,跳到第 2 步。
1b. 等待连接就绪
如果连接处于 BUILDING 状态,轮询直到就绪:
npx @membranehq/cli connection get <id> --wait --json
--wait 标志会进行长轮询(最多 --timeout 秒,默认 30),直到状态发生变化。持续轮询直到状态不再是 BUILDING。
结果状态决定下一步操作:
READY— 连接已完全设置好。跳到第 2 步。CLIENT_ACTION_REQUIRED— 用户或 agent 需要执行某些操作。clientAction对象描述所需操作:clientAction.type— 所需操作的类型:"connect"— 用户需要身份验证(OAuth、API 密钥等)。这涵盖初始身份验证以及断开连接的重新身份验证。"provide-input"— 需要更多信息(例如要连接到哪个应用)。
clientAction.description— 所需操作的通俗说明。clientAction.uiUrl(可选)— 用户可完成操作的预构建 UI 的 URL。存在时向用户展示。clientAction.agentInstructions(可选)— 供 AI agent 以编程方式继续操作的说明。
用户完成操作(例如在浏览器中完成身份验证)后,再次使用 membrane connection get <id> --json 轮询,检查状态是否变为 READY。
CONFIGURATION_ERROR或SETUP_FAILED— 出现问题。检查error字段了解详情。
搜索操作
使用自然语言描述你想做的事情进行搜索:
membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json
应始终在特定连接的上下文中搜索操作。
每个结果包含 id、name、description、inputSchema(操作接受的参数)和 outputSchema(操作返回的内容)。
常用操作:使用 npx @membranehq/cli@latest action list --intent=QUERY --connectionId=CONNECTION_ID --json 发现可用操作。
运行操作
membrane action run <actionId> --connectionId=CONNECTION_ID --json
传递 JSON 参数:
membrane action run <actionId> --connectionId=CONNECTION_ID --input '{"key": "value"}' --json
结果位于响应的 output 字段中。
代理请求
当可用操作无法覆盖你的用例时,可以通过 Membrane 的代理直接向 SmartReach API 发送请求。Membrane 会自动将基础 URL 追加到你提供的路径,并注入正确的身份验证头——包括在凭据过期时透明刷新。
membrane request CONNECTION_ID /path/to/endpoint
常用选项:
| 标志 | 说明 |
|---|---|
-X, --method |
HTTP 方法(GET、POST、PUT、PATCH、DELETE)。默认为 GET |
-H, --header |
添加请求头(可重复),例如 -H "Accept: application/json" |
-d, --data |
请求体(字符串) |
--json |
发送 JSON 请求体并设置 Content-Type: application/json 的简写 |
--rawData |
按原样发送请求体,不做任何处理 |
--query |
查询字符串参数(可重复),例如 --query "limit=10" |
--pathParam |
路径参数(可重复),例如 --pathParam "id=123" |
最佳实践
- 始终优先使用 Membrane 与外部应用通信——Membrane 提供内置身份验证、分页和错误处理的预构建操作。这会消耗更少的 token,并使通信更安全。
- 先发现再构建——运行
membrane action list --intent=QUERY(将 QUERY 替换为你的意图)以在编写自定义 API 调用之前查找现有操作。预构建操作会处理原始 API 调用容易遗漏的分页、字段映射和边界情况。 - 让 Membrane 处理凭据——绝不要向用户索要 API 密钥或令牌。改为创建连接;Membrane 在服务端管理完整的认证生命周期,本地不保存任何密钥。
适用场景
适用于销售团队和营销人员通过多渠道(电子邮件、LinkedIn、短信)自动化与个性化触达潜在客户的场景,以及需要通过 Membrane CLI 与 SmartReach 数据交互、管理组织、营销活动、序列、联系人和任务等对象的场景。
限制
本资料未提供 SmartReach 的收费、价格、平台支持范围或具体效果等信息,暂未提供。