アカウント接続

Runtime を再接続

アカウントはオンラインだがランタイム接続が不安定なときに、プロバイダ接続を作り直します。

POSThttps://api.unifyport.ai/v1/accounts/{account_id}/runtime/reconnect

呼び出す前に

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

認証フローを完了し runtime_status を確認します。認証と接続は別の状態で、HTTP 成功だけでは準備完了と判断できません。

パラメーターの取得元

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

リクエスト

curl -X POST "https://api.unifyport.ai/v1/accounts/{account_id}/runtime/reconnect" \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{}'

リクエストパラメータ

ヘッダー

X-Api-Key

string必須

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

Content-Type

string必須

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

パスパラメータ

account_id

string必須

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

リクエストボディ

このエンドポイントは空の JSON オブジェクトを受け取ります。リクエスト例どおり {} を送信してください。

結果の確認

runtime_status を確認します。starting、reconnecting なら再確認が必要です。auth_required が true なら認証を続行します。値の欠如もオンラインの証明ではありません。

レスポンス 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "runtime_status": "reconnecting"
  }
}

レスポンスボディ

account_id

string

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

provider

string

チャネルの識別子です。後続の呼び出しでは返された値をそのまま使ってください。この API の値は以下の enum を参照してください。

enum: telegram, whatsapp, line, twitter, zalo, tiktok, whatsapp-protocol

action

string

要求されたランタイム操作。

enum: refresh_status, start, stop, reconnect

operation_status

string

ランタイム操作が受理または完了したかを示す状態。

runtime_status

string

正規化されたランタイム状態。unknown、starting、running、stopping、stopped、reconnecting、disconnected、error のいずれか。

enum: unknown, starting, running, stopping, stopped, reconnecting, disconnected, error

runtime_error

string

操作を完了できなかった場合のプロバイダランタイムエラー。

auth_required

boolean

true の場合はチャネルの認可フローを続けます。認可用データが返された場合、または確認済みの認可フローが進行中の場合にのみ返されます。未返却や false はオンラインを意味しません。runtime_status を確認してください。disconnected だけで再認可が必要とは判断できません。ランタイム API は code、qrcode、auth_payload、provider_data を返しません。認可用データはチャネルの認可 API で取得してください。

auth_status

string

任意の認可状態です。例：pending、awaiting_qr_scan、passkey_required。認可用データまたは確認済みの進行中フローがある場合に返されます。次の操作はチャネルガイドを参照し、完全な状態とデータは認可 API、接続状態は runtime_status で確認してください。

レスポンス

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_not_ready · 30009 · 409: 認証と接続を復旧し、前回の結果を確認してから再試行します。