botstar

Botstar

Botstar 是一个平台，允许用户在各种消息渠道中构建和部署聊天机器人。企业和个人可以使用它来自动处理客户服务、潜在客户开发及其他对话交互。

官方文档：https://docs.botstar.com/

Botstar 概览

• Bot
  • Flow
  • Integration
• User

根据需要使用操作名称和参数。

使用 Botstar

此技能使用 Membrane CLI 与 Botstar 交互。Membrane 会自动处理身份验证和凭据刷新，因此你可以专注于集成逻辑，而不必处理身份验证配置。

安装 CLI

安装 Membrane CLI，以便在终端中运行 membrane：

npm install -g @membranehq/cli@latest

身份验证

membrane login --tenant --clientName=<agentType>

根据是否提供交互模式，这会打开浏览器进行身份验证，或在控制台中输出授权 URL。

无头环境： 命令会输出授权 URL。请让用户在浏览器中打开该 URL。用户完成登录并看到验证码后，使用以下命令完成操作：

membrane login complete <code>

在任何命令中添加 --json，即可输出机器可读的 JSON。

Agent 类型：claude、openclaw、codex、warp、windsurf 等。系统会根据这些类型调整工具，以便更好地配合你的运行环境。

连接到 Botstar

使用 membrane connection ensure，通过应用 URL 或域名查找或创建连接：

membrane connection ensure "https://botstar.com" --json

用户在浏览器中完成身份验证。输出中包含新连接的 ID。

这是获取连接最快的方法。URL 会被规范化为域名，并与已知应用进行匹配。如果找不到应用，则会创建一个应用并自动构建连接器。

如果返回的连接包含 state: "READY"，请跳到步骤 2。

1b. 等待连接就绪

如果连接处于 BUILDING 状态，请轮询，直到连接就绪：

npx @membranehq/cli connection get <id> --wait --json

--wait 标志会进行长轮询（最长等待 --timeout 秒，默认值为 30），直到状态发生变化。请持续轮询，直到 state 不再是 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（操作返回的内容）。

常用操作

名称	键	描述
列出机器人	list-bots	获取所有机器人的列表
列出实体	list-entities	获取机器人的所有 CMS 实体
列出实体项	list-entity-items	分页获取 CMS 实体的所有项
列出机器人属性	list-bot-attributes	获取机器人的所有属性
获取机器人	get-bot	按 ID 获取机器人
获取实体	get-entity	按 ID 获取 CMS 实体
获取实体项	get-entity-item	按 ID 获取单个 CMS 实体项
获取用户	get-user	获取机器人的用户信息
创建机器人	create-bot	创建新机器人
创建实体	create-entity	创建新的 CMS 实体
创建实体项	create-entity-item	创建新的 CMS 实体项
创建机器人属性	create-bot-attribute	创建新的机器人属性
创建用户属性	create-user-attribute	为机器人创建自定义用户属性
更新实体	update-entity	更新 CMS 实体
更新实体项	update-entity-item	更新 CMS 实体项
更新机器人属性	update-bot-attribute	更新现有机器人属性
更新用户	update-user	更新机器人用户的用户属性
删除实体	delete-entity	删除 CMS 实体
删除实体项	delete-entity-item	删除 CMS 实体项
发送消息	send-message	通过 Botstar 向 Facebook 受众发送消息

运行操作

membrane action run <actionId> --connectionId=CONNECTION_ID --json

传递 JSON 参数：

membrane action run <actionId> --connectionId=CONNECTION_ID --input '{"key": "value"}' --json

结果位于响应的 output 字段中。

代理请求

如果现有操作无法满足你的使用场景，可以通过 Membrane 的代理直接向 Botstar 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 密钥或 Token。请改为创建连接；Membrane 会在服务器端管理完整的身份验证生命周期，无需本地密钥。