開発者ドキュメント

One Port, Every Channel.

すべてのメッセージルートを 1 つの API に統合し、入站イベントを標準 Webhook で受け取れます。

はじめに

イントロダクション

UnifyPort は、Telegram・WhatsApp・LINE・X (Twitter)・Zalo・TikTok を 1 つの REST API と 1 本の標準 webhook イベントストリームに統合します。送信は POST /v1/messages、受信はすべて正規化されたイベントとして届きます — プロバイダ固有 SDK は不要で、必要に応じて公式 UnifyPort Node.js / PHP SDK を利用できます。

概要

ワークスペース

分離の境界。X-Api-Key ヘッダはちょうど 1 つのワークスペースに解決され、そのワークスペースへのフルアクセスを付与します — リクエストボディに追加の workspace id は不要です。

アカウント

1 つのチャネルログイン = 1 台の仮想デバイス。API で作成し、プロバイダが対応するフロー(QR、認証コード、またはセッション取り込み)で認証してから、そのアカウントで送受信します。

ランタイム

各アカウントの背後にあるライブ接続プロセス。認証成功後に自動で起動し、その状態は runtime_status として公開されます。完全なステートマシンはアカウントライフサイクルを参照してください。

Webhook

受信トラフィックの唯一の記録。UnifyPort はメッセージ履歴を永続化せず、取り逃したイベントの再送もありません — まず webhook エンドポイントを登録し、到着時に必要なデータを保存してください。

API キーを検証

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

注記

  • ベース URL:https://api.unifyport.ai。すべての /v1 エンドポイントは X-Api-Key リクエストヘッダで認証します。
  • UnifyPort は現在、限定されたお客様に提供しています。ワークスペースへのアクセスと最初の API キーの取得については、チームまでお問い合わせください。
  • 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.

次のステップ