アカウント認可

認証セッションをインポート

既存のセッション URL や cookie/セッションペイロードをインポートして認証を完了します。クライアントのサンプルではプレースホルダを使用し、セッション情報をログに出さないでください。

POSThttps://api.unifyport.ai/v1/accounts/{account_id}/auth/session

呼び出す前に

対象ワークスペースの X-Api-Key をサーバー側で使用します。実行前にすべてのプレースホルダーを置き換えます。

WhatsApp Protocol は provider=whatsapp-protocol で指定する独立したチャネルです。現在はセッションのインポート（auth_mode=session）のみに対応し、既存のセッション認証情報でアカウントを認証します。 WhatsApp Protocol 認証

パラメーターの取得元

account_id: アカウント作成・取得応答の data.id を使います。識別子は X-Api-Key のワークスペースに属します。アカウント取得

リクエスト

curl -X POST "https://api.unifyport.ai/v1/accounts/{account_id}/auth/session" \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "session_url": "https://example.com/account.session"
}'

リクエストパラメータ

ヘッダー

X-Api-Key

string必須

ワークスペース API キー。このヘッダーからワークスペースを特定します。

Content-Type

string必須

JSON のリクエストボディを送る場合は application/json を使用します。

パスパラメータ

account_id

string必須

authentication ルートで使用される識別子。

リクエストボディ

session_url

string

既存のプロバイダセッションアーティファクトの URL または参照。

format: uri

whatsapp-protocol

object

WhatsApp Protocol のセッションインポート認証情報。このネストされたオブジェクトで /v1/accounts/{account_id}/auth/session にのみ送信でき、provider_data では送信できません。指定する場合は phone、static_pub_key、static_pri_key、identity_pub_key、identity_pri_key が必須です。レスポンスにプロトコル鍵やその他の機密認証情報は含まれません。phone は本人情報の整合性確認に、プロトコル公開鍵と秘密鍵は上流の起動にのみ使用します。edge_routing はプラットフォームが固定で注入するため送信禁止です。

phone

string

電話番号には空白、ハイフン、括弧、プラス記号を含められます。サーバーは正の数を表す文字列に正規化します。

minLength: 1

platform

integer

WhatsApp Protocol セッションインポートのプラットフォーム値（int32）。

format: int32

app_version

string

WhatsApp Protocol セッションインポートのアプリバージョン。

server_address

string

WhatsApp Protocol セッションインポートのプロバイダサーバーアドレス。

fallback_server_addresses[]

string[]

WhatsApp Protocol セッションインポートの予備サーバーアドレス一覧。

country

string

WhatsApp Protocol セッションインポートの国コード。

device

integer

WhatsApp Protocol セッションインポートのデバイス値（uint32）。

format: uint32

static_pub_key

string

プロトコル公開鍵。書き込み専用。

minLength: 1

static_pri_key

string

プロトコル秘密鍵。書き込み専用。

minLength: 1

identity_pub_key

string

ID 公開鍵。書き込み専用。

minLength: 1

identity_pri_key

string

ID 秘密鍵。書き込み専用。

minLength: 1

hash

string

非推奨の互換フィールド。現在は値が無視され、保存されません。省略してください。

peer_kem_public

string

相手側の KEM 公開鍵。書き込み専用。

auth_hex_data

string

現在の認証データ（16 進数）。書き込み専用。

authhexdata

string

非推奨の旧認証データフィールド（16 進数）。書き込み専用。

pq_handshake_mode

string

WhatsApp Protocol セッションインポートの PQ ハンドシェイクモード。

use_xxkem_handshake

boolean

WhatsApp Protocol セッションインポートで XXKEM ハンドシェイクを使用するか。

結果の確認

認証結果を確認してから runtime_status を確認します。インポートとオンライン接続は別の段階です。

レスポンス 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "account_id": "acc_example",
    "status": "authorized"
  }
}

レスポンスボディ

account_id

string

このレスポンスが対象とするプロバイダアカウント。

status

string

現在の認可フロー状態。pending_auth、awaiting_qr_scan、awaiting_code、pending、passkey_required、passkey_pending、passkey_confirmation、passkey_confirmation_sent、authorized、failed など。

レスポンス

200

200 OK

リクエスト成功。レスポンスボディの例を参照してください。

400

Bad Request

リクエストボディ、パス、またはパラメータが不正です。

401

Unauthorized

X-Api-Key ヘッダが欠落しているか無効です。

409

Conflict

要求された操作が、既存のプロバイダアカウントまたはリソースと競合しています。

500

Internal Server Error

サービスで予期しないエラーが発生しました。

502

Bad Gateway

プロバイダアダプタまたは上流サービスが操作を完了できませんでした。

失敗時の対応

HTTP 状態と error.code/numeric_code を確認し、request_id を保存します。原因に応じてパラメーター修正・認証・状態確認を行い、送信や書き込みの再試行前に前回の結果を確認します。エラーリファレンス

invalid_request · 10000 · 400: 必須項目、形式、チャネルの条件を確認して修正します。
invalid_api_key · 11001 · 401: X-Api-Key とワークスペースの有効性を確認します。
provider_invalid_request · 30001 · 400: 必須項目、形式、チャネルの条件を確認して修正します。