开发者文档
一处连接,万路畅通
统一 API 接入多渠道消息,标准 Webhook 承接所有入站事件。
快速开始
简介
UnifyPort 用一套 REST API 加一条标准 webhook 事件流,统一接入 Telegram、WhatsApp、LINE、X (Twitter)、Zalo 和 TikTok。发送统一走 POST /v1/messages,接收统一为标准化事件——无需接入各渠道自己的 SDK,也可选用官方 UnifyPort Node.js 或 PHP SDK。
概览
工作区
你的隔离边界。X-Api-Key 请求头唯一对应一个工作区并拥有其全部访问权限——请求体中无需再传任何 workspace id。
账号
一个渠道登录 = 一台虚拟设备。先通过 API 创建,再用该渠道支持的流程完成授权(扫码、验证码或会话导入),之后即可通过它收发消息。
运行时
每个账号背后的实时连接进程。授权成功后自动启动,状态通过 runtime_status 暴露。完整状态机见「账号生命周期」。
Webhook
入站流量的唯一记录。UnifyPort 不持久化消息历史,漏掉的事件也不会重放——请先注册 webhook 端点,并在事件到达时存下需要的内容。
验证你的 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。
- 每个响应(成功与错误)顶层都带 request_id,并通过 X-Request-Id 响应头返回——反馈问题时请提供此值。你也可以自带 X-Request-Id 请求头,它会原样回显为 client_request_id,供客户端对账。