API 參考

帳號連線

停止執行環境

停止帳號的執行環境,但不會刪除帳號。

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

呼叫前準備

在伺服器端使用資源所屬工作區的 X-Api-Key,執行範例前替換所有預留位置。

完成所選授權流程並檢查 runtime_status。授權與連線狀態不同,HTTP 成功不等於已就緒。

參數從哪裡取得
account_id
從建立或查詢帳號的回應取得 data.id。帳號屬於 X-Api-Key 對應的工作區。 取得帳號

請求參數

請求標頭

X-Api-Key
string必填

工作區 API Key,工作區會由此標頭解析得到。

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": "stopped"
  }
}

回應內容

account_id
string

本回應所對應的渠道帳號。

provider
string

管道識別碼。呼叫其他介面時原樣使用 API 回傳的值;此介面的回傳範圍請看下方列舉。

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 不能推斷需要重新授權。執行階段介面不回傳 code、qrcode、auth_payload 或 provider_data,請從管道的授權介面取得授權資料。

auth_status
string

選用的授權狀態,例如 pending、awaiting_qr_scan 或 passkey_required。有授權資料或經確認的未完成授權流程時才回傳。依管道指南繼續操作;完整狀態與授權資料從授權介面查詢,連線狀態查看 runtime_status。

回應

200

200 OK

請求成功,回應內容範例如上。

400

請求錯誤

請求內容、路徑或參數無效。

401

未授權

X-Api-Key 請求標頭缺少或無效。

409

衝突

目前操作與既有的渠道帳號或資源衝突。

500

伺服器錯誤

服務遇到了未預期的錯誤。

502

上游閘道錯誤

渠道轉接器或上游渠道未能完成此操作。

失敗後如何處理

檢查 HTTP 狀態和 error.code/numeric_code,保留 request_id。依原因修正參數、繼續授權或檢查狀態。重試傳送及寫入前確認上次結果,避免重複操作。 錯誤碼參考

invalid_request · 10000 · 400
檢查必填欄位、格式與渠道條件,修正請求後再呼叫。
invalid_api_key · 11001 · 401
檢查 X-Api-Key 與工作區是否有效。
provider_not_ready · 30009 · 409
檢查授權與執行狀態,恢復連線後先確認上次結果,再決定是否重試。