Developer Docs

One Port, Every Channel.

Connect every messaging route through one unified API, with standard Webhook events for inbound traffic.

Getting Started

Introduction

UnifyPort is one REST API plus one standard webhook event stream for Telegram, WhatsApp, LINE, X (Twitter), Zalo, and TikTok. Send with POST /v1/messages, receive everything as normalized events — no per-channel SDKs.

Overview

Workspace

Your isolation boundary. The X-Api-Key header resolves to exactly one workspace and grants full access to it — no extra workspace ids in request bodies.

Account

One channel login = one virtual device. Create it via the API, authorize it with the flow the provider supports (QR, code, or session import), then send and receive through it.

Runtime

The live connection process behind each account. It starts automatically after authorization succeeds; its state is exposed as runtime_status. See Account lifecycle for the full state machine.

Webhook

The only record of inbound traffic. UnifyPort does not persist message history and missed events are not replayed — register a webhook endpoint first and store what you need on arrival.

Verify your API key

Shell
curl https://api.unifyport.ai/v1/workspace \
  -H "X-Api-Key: <YOUR_API_KEY>"

Notes

  • Base URL: https://api.unifyport.ai. Every /v1 endpoint authenticates with the X-Api-Key request header.
  • UnifyPort is currently available to selected customers. Contact the team to get workspace access and your first API key.
  • Every response (success and error) carries a top-level request_id, also returned as the X-Request-Id response header — quote it when reporting issues. Send your own X-Request-Id request header and it is echoed back as client_request_id for client-side reconciliation.

Next steps

Quickstart

From an empty workspace to your first WhatsApp message and your first inbound event.

Provider capabilities

Which message types, actions, and events each channel actually supports today.

Receiving events

Delivery headers, HMAC signature verification, retries, and ordering guarantees.

Error reference

The error envelope and every machine-readable error code, grouped by HTTP status.