开发者文档
One API. Every Channel.
统一 API 接入多渠道消息,标准 Webhook 承接所有入站事件。
快速开始
简介
UnifyPort 用一套 REST API 加一条标准 webhook 事件流,统一接入 Telegram、WhatsApp、LINE、X(原 Twitter)、Zalo 和 TikTok。发送统一走 POST /v1/messages,接收统一为标准化事件——无需接入各渠道自己的 SDK,也可选用官方 UnifyPort Node.js、PHP、Go 或 Python SDK。
概览
工作区
工作区用于管理消息账号、API Key 和 Webhook。调用接口时使用目标工作区的 X-Api-Key,无需在请求体中另外填写工作区 ID。
账号
消息账号是你接入 UnifyPort 的一个 Telegram、WhatsApp 等渠道账号。创建后完成渠道授权,再通过它收发消息。
连接状态(Runtime)
消息账号与渠道之间的连接状态。通过 runtime_status 查询,与账号授权状态分开判断;running 表示连接已就绪。
Webhook
Webhook 是你持久保存入站流量的入口。UnifyPort 不提供 REST 消息历史读取接口,也不保证重放漏掉的投递;请先注册端点并在事件到达时存储。WhatsApp 在首次同步或重连后可能下发有限的 best-effort HistorySync,但它不是完整归档。
验证你的 API Key
Shell
curl "https://api.unifyport.ai/v1/workspace" \
-H "X-Api-Key: <YOUR_API_KEY>"
备注
- Base URL:https://api.unifyport.ai。所有 /v1 端点均通过 X-Api-Key 请求头认证。
- 准备工作区 API Key、WhatsApp 账号和可接收公网 HTTPS 请求的 Webhook 地址。API Key 与签名密钥保存在服务端。先用下面的请求检查 API Key。
- 有 JSON 内容的成功与错误响应会在顶层携带 request_id;成功删除等 204 无响应体请求只通过 X-Request-Id 响应头返回该值。反馈问题时请提供它。你也可以自带 X-Request-Id 请求头,有 JSON 响应时会回显为 client_request_id,供客户端对账。