API 集成指南

通过我们简单的 API,连接你的 CRM、预订系统或任何应用来发送 WhatsApp 消息。

5 个简单步骤即可开始

1

下载桌面应用

在你的 Windows 电脑上下载并安装 All-in-One Messenger Hub。

2

连接你的 WhatsApp

通过扫描二维码将你的 WhatsApp 账户添加到应用。

3

创建一个 Session API

进入 WhatsApp 标签页并创建一个新的 Session API。将其关联到你的 WhatsApp 渠道。

4

复制你的 API 密钥

复制生成的 API 密钥。妥善保管 - 它是你的身份凭证。

5

开始发送消息

从你的应用使用该 API。保持桌面应用运行以投递消息。

身份验证

所有 API 端点都需要通过你的 API 密钥进行身份验证。你可以用以下任一方式传递密钥:

方法 示例
X-API-Key 请求头(推荐) X-API-Key: your-api-key
查询/主体参数 key=your-api-key
备用参数 api_key=your-api-key
POST

发送消息

向某个电话号码或群组发送 WhatsApp 消息。消息会排队,并在桌面应用运行时投递。

POST https://onemessengerhub.com/api/whatsapp-session/send

参数

参数 类型 必需 说明
key string 你从桌面应用获取的 API 密钥
mobile string 有条件 带国家/地区代码的电话号码(在没有 group_id 时为必需)
group_id string 有条件 WhatsApp 群组 ID(在没有 mobile 时为必需)。@g.us 后缀会自动添加。
message string 消息文本(最多 4096 个字符)

示例请求

curl -X POST https://onemessengerhub.com/api/whatsapp-session/send \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"mobile": "1234567890", "message": "Hello!"}'

简单的 GET 请求(浏览器或链接)

https://onemessengerhub.com/api/whatsapp-session/send?key=YOUR_API_KEY&mobile=1234567890&message=Hello!

成功响应 (201)

{
  "success": true,
  "message": "Message queued successfully",
  "data": {
    "message_id": 123,
    "recipient": "1234567890",
    "status": "pending"
  }
}
POST

保存联系人

在你的 WhatsApp 中保存或重命名一个联系人。该操作会排队并由桌面应用处理。

POST https://onemessengerhub.com/api/whatsapp-session/save-contact

参数

参数 类型 必需 说明
key string 你从桌面应用获取的 API 密钥
contact_id string 联系人电话号码或 WhatsApp ID(最多 50 个字符)。@c.us 后缀会自动添加。
name string 联系人的显示名称(最多 255 个字符)

示例请求

curl -X POST https://onemessengerhub.com/api/whatsapp-session/save-contact \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"contact_id": "1234567890", "name": "John Doe"}'

成功响应 (201)

{
  "success": true,
  "message": "Contact save operation queued",
  "data": {
    "operation_id": 456,
    "contact_id": "[email protected]",
    "status": "pending"
  }
}
POST

移除联系人

从你的 WhatsApp 中移除一个联系人。该操作会排队并由桌面应用处理。

POST https://onemessengerhub.com/api/whatsapp-session/remove-contact

参数

参数 类型 必需 说明
key string 你从桌面应用获取的 API 密钥
contact_id string 联系人电话号码或 WhatsApp ID(最多 50 个字符)。@c.us 后缀会自动添加。

示例请求

curl -X POST https://onemessengerhub.com/api/whatsapp-session/remove-contact \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"contact_id": "1234567890"}'

成功响应 (201)

{
  "success": true,
  "message": "Contact remove operation queued",
  "data": {
    "operation_id": 789,
    "contact_id": "[email protected]",
    "status": "pending"
  }
}

错误处理

该 API 使用标准 HTTP 状态码。以下是常见的错误响应:

身份验证错误 (401)

{
  "success": false,
  "message": "Invalid or inactive API key"
}

校验错误 (422)

{
  "success": false,
  "message": "Validation failed",
  "errors": {
    "mobile": ["The mobile field is required when group id is not present."],
    "message": ["The message field is required."]
  }
}

你可以构建什么

CRM 集成

直接从你的 CRM 系统发送跟进消息、提醒和更新。

预订确认

自动向客户发送预约确认和提醒。

订单通知

向客户通知订单状态、物流更新和配送信息。

告警系统

向你的团队或客户发送重要告警和通知。

营销活动

向你的联系人列表发送促销消息和更新。

自定义工作流

与 Zapier、Make、n8n 或任何自动化平台集成。

更多 API 即将推出

我们正在扩展 API 产品,以覆盖更多平台和使用场景。

即将推出

聊天机器人 API

以编程方式触发聊天机器人回复并管理对话。

即将推出

联系人 API

跨平台访问和管理你的通讯联系人。

即将推出

Webhooks

在收到或发送消息时接收实时通知。