API 参考
快速开始

简介

UnifyPort 用一套 REST API 加一条标准 webhook 事件流,统一接入 Telegram、WhatsApp、LINE、X(原 Twitter)、Zalo 和 TikTok。发送统一走 POST /v1/messages,接收统一为标准化事件——无需接入各渠道自己的 SDK,也可选用官方 UnifyPort Node.js、PHP、Go 或 Python SDK。

概览

工作区

你的隔离边界。X-Api-Key 请求头唯一对应一个工作区并拥有其全部访问权限——请求体中无需再传任何 workspace id。

账号

一个渠道登录 = 一台虚拟设备。先通过 API 创建,再用该渠道支持的流程完成授权(扫码、验证码或会话导入),之后即可通过它收发消息。

运行时

每个账号背后的实时连接进程。授权成功后自动启动,状态通过 runtime_status 暴露。完整状态机见「账号生命周期」。

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 请求头认证。
  • UnifyPort 目前面向受邀客户开放。请联系团队获取工作区访问权限和你的第一个 API Key。
  • 有 JSON 内容的成功与错误响应会在顶层携带 request_id;成功删除等 204 无响应体请求只通过 X-Request-Id 响应头返回该值。反馈问题时请提供它。你也可以自带 X-Request-Id 请求头,有 JSON 响应时会回显为 client_request_id,供客户端对账。

下一步