跳转到主要内容

基本网址

默认值为 http://localhost:3000。设置 APP_BASE_PATH=/gowa 后,除 /health 外,所有路由都会移至 /gowa 下。

认证

设置APP_BASIC_AUTH 时,除/health、/statics/*、Chatwoot webhook 和 MCP OAuth 端点外,每条路都需要 HTTP Basic Autth。 见 Authentication。

设备选择

大多数路由都在 WhatsApp 设备上运行。请使用 X-Device-Id 标题(栏位 ID 或 JID),或 device_id 查询参数。 当服务器只有一个设备时,你可以省略它;更多则需要它。 见 Multi-device。

端点组

此选项卡中的端点页面来自GOWA 的 OpenAPI 规格。权威性合同是 docs/openapi.yaml 服务器存储库。 此网站使用 openapi.yml 的同步副本,包括/send/interactive。交互式指南 记录当前限制。

请求

  • JSON 请求体:Content-Type: application/json。
  • 文件上传: multipart/form-data
  • 电话号码:带有国家代码的数字 (628123456789) 或完整的 JID (...@s.whatsapp.net, ...@g.us)

回应

code是SUCCESS或一个错误代码;results 持有数据。请参阅 Errors。

示例

联系人姓名

GET /user/my/contacts 会返回每个联系人的首选显示名称。在 v9.9.0 之后的 GOWA main 分支中,可调用 GET /user/my/contacts/detailed,将存储的 full_name、first_name、push_name 和 business_name 作为独立字段获取。GOWA 会省略空名称;当设备中存在映射时,电话号码 JID 的结果中还会包含 lid。结果包含所选设备的个人联系人,并按 jid 排序。

其他接口

  • WebSocket 在 /ws 处用于在线仪表板事件。
  • 供 AI 智能体使用的 MCP,位于 /mcp(MCP 服务器)。
  • Webhooks 推送到您的 URLs(Webhooks)。