短信API集成服务

Mobizon MCP Server是一个用于与Mobizon巴西API集成的服务器,提供短信发送、余额查询、用户列表等功能。

  • by caioagiani
  • JavaScript
  • 本地部署
  • 2 星标
  • 更新于
在 GitHub 查看 caioagiani/mobizon-mcp

使用说明

Mobizon MCP服务器

用于与Mobizon巴西API集成的MCP服务器(mobizon.com.br).

外露工具

  • mobizon_get_balance:呼叫 user/getOwnBalance
  • mobizon_send_sms:呼叫 message/sendSmsMessage
  • mobizon_get_sms_status:呼叫 message/getSMSStatus
  • mobizon_list_sms:呼叫 message/list
  • mobizon_list_users:呼叫 user/list 带有分页和可选条件过滤器
  • mobizon_list_moderation_campaigns:呼叫 campaign/listglobal 用于审核队列
  • mobizon_approve_moderation_campaigns:呼叫 campaign/approveglobal 随着 ids
  • mobizon_decline_moderation_campaigns:呼叫 campaign/declineglobal 随着 ids 和 comment (或自动生成的评论)
  • mobizon_call:对任何API模块/方法的通用调用

在 mobizon_send_sms, recipient 标准化为BR移动格式: 55 + DDD + 9 + number (例如: 5511999999999).

需求

  • Node.js 20+
  • Mobizon API密钥

设置

  1. 安装依赖项:
npm install
  1. 配置环境变量(基于 .env.example):
  • MOBIZON_API_KEY (必填)
  • MOBIZON_BASE_URL (默认值: https://api.mobizon.com.br/service)
  • MOBIZON_API_VERSION (默认值: v1)
  • MOBIZON_TIMEOUT_MS (默认值: 30000)

在本地运行

MOBIZON_API_KEY=your_token npm start

MCP配置示例(克劳德桌面/Codex)

{
  "mcpServers": {
    "mobizon": {
      "command": "node",
      "args": ["/path/to/mobizon-mcp/src/index.js"],
      "env": {
        "MOBIZON_API_KEY": "YOUR_TOKEN_HERE",
        "MOBIZON_BASE_URL": "https://api.mobizon.com.br/service",
        "MOBIZON_API_VERSION": "v1",
        "MOBIZON_TIMEOUT_MS": "30000"
      }
    }
  }
}

备注

  • 身份验证是通过以下方式完成的 apiKey 在查询字符串中,使用 api=v1 和 output=json.
  • 服务器发送 application/x-www-form-urlencoded 对于标准 POST 电话。
  • 一些审核终点(approveglobal, declineglobal)使用JSON有效载荷。
  • mobizon_call 支持 GET 和 POST.
  • mobizon_list_users 默认值为:
    • withConfig=1
    • withProfile=1
    • withAccessGroup=1
    • withCPRestriction=1
    • withCountryRestriction=1
    • pagination.currentPage=0
    • pagination.pageSize=25
  • 对于搜索,请使用 criteria 直接或快捷方式字段 email 和 number.
  • mobizon_list_users 也会返回(默认情况下) summary.items 包括:
    • status
    • lastLoginTs
    • balance
    • totalSpending
    • 集 includeSummary=false 以仅接收原始API有效载荷。

建筑

  • 入口点: src/index.js
  • 服务器引导: src/server.js
  • 环境配置: src/config/env.js
  • Mobizon HTTP客户端: src/core/mobizon-client.js
  • 适度逻辑: src/moderation/auto-comment.js
  • 公用设施: src/utils/params.js, src/utils/phone.js, src/utils/mcp.js
  • MCP工具(每个工具一个文件): src/tools/

详细的架构和扩展约定:

  • docs/ARCHITECTURE.md

参考

  • API文件:https://mobizon.com.br/en/help/api-docs