跳转到正文
OmniChannels.ai

AI 助手与智能体

Claude Code + OmniChannels.ai:在终端中开发并测试消息功能

通过 MCP 连接通过 API 和 Webhook 连接更新于

简而言之

一条命令即可接入:claude mcp add --transport http,指向我们的 MCP 地址并带 Bearer 请求头。之后可发送测试消息、列出 WhatsApp 模板、读取送达报告,并依据 OpenAPI 3.1 写集成代码。

您可以做什么

  • 依据真实模板编写代码

    Claude Code 通过 MCP 读取你已审核的 WhatsApp 模板,并写出恰好包含各模板所需变量的函数。

    试着这样提问

    “使用 omnichannels 工具列出我已审核的 WhatsApp 模板,然后编写一个 TypeScript 函数,用所需字段发送 order_update。”

  • 构建 webhook 处理程序

    让 Claude Code 参考 webhook 指南,它会写出保存送达状态和入站消息的接口,并兼容各渠道不同的字段。

    试着这样提问

    “编写一个 Express webhook 处理程序,按消息 ID 记录 SUBMITTED、SENT、DELIVERED、READ、FAILED 和 REJECTED 状态,遇到未知字段时只记录日志而不报错。”

  • 依据规范生成带类型的客户端

    把 OpenAPI 规范放进代码仓库后,Claude Code 会使用准确的路径和字段,而不是凭猜测。

    试着这样提问

    “使用 docs/omnichannels-openapi.yaml,编写一个通过 POST /sms/sendSms 发送短信的 Python 模块,并按规范列出你用到的每个字段及其类型。”

  • 用自己的号码做端到端测试

    你批准工具调用后,Claude Code 发送一条测试消息,再查看送达报告,确认代码路径可用。

    试着这样提问

    “以 OmniDemo 为发件人,向我的号码 447700900123 发送一条测试短信,然后查看其送达报告。”

  • 排查发送失败

    读取类工具让 Claude Code 把送达报告与你的日志对照,并追溯到引发失败的那次请求。

    试着这样提问

    “读取昨天活动的送达报告,总结失败原因,并对照错误指南检查我们的重试代码。”

连接方式

通过 MCP 连接通过 API 和 Webhook 连接

Claude Code 使用 claude mcp add --transport http 加 Authorization 请求头来添加远程 MCP 服务器。运行命令时,你的 shell 会从环境变量中展开令牌;团队则可使用项目级 .mcp.json,让每位开发者通过 ${BROADNET_TOKEN} 提供各自的令牌,Claude Code 会在使用前要求每个人批准该服务器。

MCP 用于操作你的账户:发送测试消息、读取模板和送达报告。编写集成代码时,请把我们的 OpenAPI 3.1 规范作为接口路径和字段的权威依据提供给 Claude Code,并附上 webhook 指南,因为规范中不包含 webhook 负载。mcp__omnichannels__get_* 这类权限规则可让读取类工具免确认运行,而发送类工具仍会询问。

  • 命令:claude mcp add --transport http omnichannels https://mcp.broadnet.me/mcp
  • 团队配置:提交使用 Bearer ${BROADNET_TOKEN} 的 .mcp.json,切勿提交密钥
  • 权限规则中的工具名形如 mcp__omnichannels__<tool>
  • OpenAPI 3.1 规范位于 /developers/openapi.json,可查准确的请求字段
  • 单条短信为 JSON;批量及大多数其他渠道发送使用 multipart/form-data

设置步骤

  1. 1

    申请 API 访问权限

    申请测试权限并获取 API 令牌。测试消息只会发送到你已验证的本人号码。

  2. 2

    获取临时密钥

    在管理后台依次打开 Integrations、MCP Integration,选择 Get temporary key,并导出为 BROADNET_TOKEN。

    指南: MCP server for AI agents
  3. 3

    添加服务器

    带 Authorization 请求头运行 claude mcp add --transport http omnichannels https://mcp.broadnet.me/mcp,或为团队提交项目级 .mcp.json,然后用 /mcp 检查。

    指南: Use the MCP server with Claude Code
  4. 4

    设置权限规则

    按需允许 mcp__omnichannels__get_* 等读取类工具,让所有发送类工具保持询问,并禁用项目不需要的工具。

    指南: Use the MCP server with Claude Code
  5. 5

    添加 OpenAPI 规范

    把 openapi.yaml 下载到你的代码仓库,并告诉 Claude Code 以它为准确定接口路径、字段和枚举值。

    指南: OpenAPI 3.1 spec
  6. 6

    用自己的号码测试

    让 Claude Code 向你已验证的号码发送一条测试消息,然后回读送达报告。

厂商文档

Claude Code 是其所有者的商标。OmniChannels.ai 与 Claude Code 无关联,也未获得 Claude Code 的认可;本页介绍的是利用 Claude Code 自身的 MCP、HTTP 或 Webhook 功能建立的连接。

示例工作流程

一个典型请求如何从 Claude Code 传到您的客户,再返回。

  1. 01

    Claude Code

    编写你的集成代码,并在需要时调用工具

  2. 02

    OmniChannels.ai MCP 与 API

    测试用 MCP 工具;你的代码调用 REST API

  3. 03

    你的测试手机

    向已验证号码发送测试短信或 WhatsApp

  4. 04

    你的 webhook 处理程序

    接收送达状态和入站消息

1. Claude Code: 编写你的集成代码,并在需要时调用工具 2. OmniChannels.ai MCP 与 API: 测试用 MCP 工具;你的代码调用 REST API 3. 你的测试手机: 向已验证号码发送测试短信或 WhatsApp 4. 你的 webhook 处理程序: 接收送达状态和入站消息

常见问题

Claude Code 有 OmniChannels.ai 官方插件吗?

没有。Claude Code 通过其对远程 MCP 服务器的标准支持接入,使用我们的公开接入点和你的 API 令牌,并像读取代码仓库里的其他文件一样读取我们公开的 OpenAPI 规范。

如何在团队内共享服务器而不共享密钥?

提交项目级 .mcp.json,其 Authorization 请求头使用 ${BROADNET_TOKEN}。每位开发者在自己的 shell 中设置该变量,Claude Code 会在使用前请他们批准该项目服务器。

Claude Code 会不经询问直接发消息吗?

默认情况下,Claude Code 在使用 MCP 工具前会先询问。由于每次发送都是真实计费的消息,请对发送类工具保持这一设置,只在权限规则中放行读取类工具;工具名取决于服务器版本和你的账户,请先在 /mcp 中确认。

产品里应该用 MCP 还是 REST API?

开发期间用 MCP,让 Claude Code 测试和检查你的账户。要上线的代码应直接调用 REST API,令牌来自你的密钥管理库,并以 OpenAPI 规范确定准确字段。

获取 API 与 MCP 访问权限

请告诉我们您的渠道、国家和使用场景。工程师会签发测试凭证并验证您的测试号码。