帳戶連線
停止執行環境
停止帳號嘅執行環境,但係唔會刪除帳號。
https://api.unifyport.ai/v1/accounts/{account_id}/runtime/stop支援渠道
呼叫前準備
在伺服器端使用資源所屬工作區的 X-Api-Key,執行範例前替換所有預留位置。
先查詢目前授權與執行狀態,再依目標選擇操作。啟動、停止、重新整理和重新連線的用途不同;帳號離線本身不代表需要重新授權。
參數從哪裡取得
- account_id
- 從建立或查詢帳號的回應取得 data.id。帳號屬於 X-Api-Key 對應的工作區。 攞帳號
請求參數
請求標頭
X-Api-Key工作區 API Key,工作區會由呢個標頭解析得出嚟。
Content-Type發送 JSON 請求內容嘅時候請用 application/json。
路徑參數
account_id用嚟識別嗰條 runtime 路由嘅 ID。
請求內容
呢個介面接收空 JSON 物件;請跟請求例子傳送 {}。
如何理解結果
透過 runtime_status 確認停止結果:stopping 仍須後續查詢,stopped 表示停止完成。帳號仍保留,再次啟動須另行操作。
回應 200 OK
{
"request_id": "<REQUEST_ID>",
"data": {
"runtime_status": "stopped"
}
}
回應內容
account_id呢個回應所指嘅渠道帳號。
provider管道識別碼。呼叫其他介面時原樣使用 API 回傳的值;此介面的回傳範圍請看下方列舉。
enum: telegram, whatsapp, line, twitter, zalo, tiktok, whatsapp-protocol
action今次請求嘅操作。
enum: refresh_status, start, stop, reconnect
operation_status運行操作已受理或者完成嘅狀態。
runtime_status標準化嘅運行狀態,係 unknown、starting、running、stopping、stopped、reconnecting、disconnected 或者 error 其中一個。
enum: unknown, starting, running, stopping, stopped, reconnecting, disconnected, error
runtime_error操作未完成時嘅渠道運行錯誤。
auth_required為 true 時,繼續對應渠道的授權流程。僅在渠道回傳授權資料,或已有經確認但尚未完成的授權流程時回傳此提示。未回傳或為 false 不代表上線,連線狀態請查看 runtime_status;僅有 disconnected 不能推斷需要重新授權。執行階段介面不回傳 code、qrcode、auth_payload 或 provider_data,請從渠道的授權介面取得授權資料。
auth_status選用的授權狀態,例如 pending、awaiting_qr_scan 或 passkey_required。有授權資料或經確認的未完成授權流程時才回傳。依渠道指南繼續操作;完整狀態與授權資料從授權介面查詢,連線狀態查看 runtime_status。
回應
200200 OK
請求成功,回應內容嘅例子如上。
400請求錯誤
請求內容、路徑或者參數無效。
401未授權
X-Api-Key 請求標頭缺少或者無效。
409衝突
目前操作同現有嘅渠道帳號或者資源衝突。
500伺服器錯誤
服務遇到咗未預期嘅錯誤。
502上游閘道錯誤
渠道轉接器或者上游渠道未能完成呢個操作。
失敗後如何處理
檢查 HTTP 狀態、error.code/numeric_code 與目前狀態,保留 request_id。核對所選動作及管道支援範圍;有明確授權提示時才繼續授權,重試前先確認執行狀態。 錯誤碼參考
- invalid_request · 10000 · 400
- 檢查必填欄位、格式與渠道條件,修正請求後再呼叫。
- missing_api_key · 11000 · 401
- 檢查 X-Api-Key 與工作區是否有效。
- invalid_api_key · 11001 · 401
- 檢查 X-Api-Key 與工作區是否有效。
- provider_not_ready · 30009 · 409
- 檢查 HTTP 狀態、error.code/numeric_code 與目前狀態,保留 request_id。核對所選動作及管道支援範圍;有明確授權提示時才繼續授權,重試前先確認執行狀態。