API リファレンス

開発者ドキュメント

One API. 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 / Go / Python SDK を利用できます。

概要

ワークスペース

ワークスペースはメッセージングアカウント、API Key、Webhook を管理します。対象ワークスペースの X-Api-Key で API を呼び出してください。リクエスト本文にワークスペース ID を追加する必要はありません。

アカウント

メッセージングアカウントは、UnifyPort に接続する Telegram や WhatsApp などのアカウントです。作成後にチャネルの認可を完了し、メッセージを送受信します。

接続状態(Runtime)

アカウントとチャネルの接続状態です。認可とは別に runtime_status を確認します。running は接続の準備完了を示します。

Webhook

受信トラフィックを永続化する入口です。UnifyPort には REST のメッセージ履歴取得 API も、取り逃した配信の保証付き再送もありません。先に webhook を登録して到着時に保存してください。WhatsApp の HistorySync は初回同期や再接続後に限定的な best-effort の直近履歴を届ける場合がありますが、完全なアーカイブではありません。

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 リクエストヘッダで認証します。
  • ワークスペースの API Key、WhatsApp アカウント、公開 HTTPS Webhook を準備します。API Key と署名シークレットはサーバーで保管し、次のリクエストでキーを確認します。
  • JSON success and error responses carry a top-level request_id; requests with no response body, such as successful 204 deletes, expose it only through the X-Request-Id response header. Quote that value when reporting issues. Send your own X-Request-Id request header and it is echoed as client_request_id in JSON responses for client-side reconciliation.

次のステップ