用途:在智能体中通过 Kapso Meta 代理处理 WhatsApp 消息,包括发送文本、模板和交互式消息,管理模板,上传媒体,以及读取收件箱历史。
配置:需设置环境变量 KAPSO_API_BASE_URL(仅主机,不含 /platform/v1)、KAPSO_API_KEY,以及可选的 META_GRAPH_VERSION(默认 v24.0)。
关键 ID:模板 CRUD 需要 business_account_id(WABA);发送消息和上传媒体需要 phone_number_id。两者均可用 node scripts/list-platform-phone-numbers.mjs 发现。
SDK:安装 npm install @kapso/whatsapp-cloud-api,并使用 WhatsAppClient 创建客户端,baseUrl 为 https://api.kapso.ai/meta/whatsapp。发送文本可调用 client.messages.sendText。
主要操作:发送模板需先创建模板、检查状态再发送;交互式消息要求处于有效的 24 小时会话窗口内,窗口外用模板;读取收件箱可用代理接口 GET /{phone_number_id}/messages 与 GET /{phone_number_id}/conversations,或用 SDK 的 client.messages.query() 和 client.conversations.list()。
脚本:提供 list-platform-phone-numbers.mjs、list-connected-numbers.mjs、list-templates.mjs、template-status.mjs、create-template.mjs、update-template.mjs、send-template.mjs、send-interactive.mjs、upload-media.mjs 等,分别用于发现 ID、列出号码与模板、检查状态、创建更新模板、发送模板与交互消息、上传媒体。资产文件涵盖订单状态更新、命名参数、媒体头部、OTP、交互按钮、列表、CTA URL、位置请求和目录消息等示例。
模板规则:创建时建议参数格式用 NAMED 与 {{param_name}},为变量提供示例,使用 language 而非 language_code,不要混排 QUICK_REPLY 与 URL/PHONE_NUMBER 按钮,URL 按钮变量需在末尾且为位置参数 {{1}};发送时 NAMED 模板需带 parameter_name,URL 按钮需 button 组件与 index,媒体头只能使用 id 或 link 之一。
限制:交互式消息受 24 小时会话窗口约束;具体定价与官方限制资料未提供。