API 參考

渠道說明

Telegram 接入授權

你可以透過驗證碼、掃碼或現有工作階段連接 Telegram。先選擇一種方式,再依步驟完成授權。

選擇授權方式

code

驗證碼流程:平台發起驗證碼請求,使用者經由 SMS 或 App 內收到後回傳。

  1. 1. POST /v1/accounts,指定 provider=telegram、auth_mode=code 與 provider_data.phone。provider_data 中的 api_id、api_hash 為選填;未提供時使用平台預設應用程式憑證。
  2. 2. POST /v1/accounts/{account_id}/auth/start,請 Telegram 下發驗證碼。
  3. 3. 使用者拿到驗證碼後 POST /v1/accounts/{account_id}/auth/code 送出驗證碼。
  4. 4. 若帳號啟用二階段驗證,status 會變為 awaiting_password — 呼叫 POST /v1/accounts/{account_id}/auth/password 送出密碼。
  5. 5. 授權成功後先檢查 runtime_status,僅在仍需啟動時呼叫 POST /v1/accounts/{account_id}/runtime/start。
  • provider_data.api_id — 選填,從 my.telegram.org 取得的 Telegram App ID。未提供時使用平台預設應用程式憑證;使用自有應用程式時,請將同一應用程式的 api_id 與 api_hash 以字串成對提供。
  • provider_data.api_hash — 選填,從 my.telegram.org 取得的 Telegram App Hash。未提供時使用平台預設應用程式憑證;使用自有應用程式時,請將同一應用程式的 api_id 與 api_hash 以字串成對提供。
  • provider_data.phone — 帳號綁定的 E.164 手機號。只有 code 流程需要。

qrcode

QR Code 流程:取得 QR token,請使用者於 Telegram App 內掃碼。

  1. 1. POST /v1/accounts,指定 provider=telegram、auth_mode=qrcode。provider_data 中的 api_id、api_hash 為選填;未提供時使用平台預設應用程式憑證。
  2. 2. POST /v1/accounts/{account_id}/auth/qr/start,回應中提供要顯示的 QR token。
  3. 3. 輪詢 POST /v1/accounts/{account_id}/auth/qr/check 直到 status=authorized。QR 約 30 秒會過期,過期再呼叫一次 qr/start 即可更新。
  4. 4. 授權成功後先檢查 runtime_status,僅在仍需啟動時呼叫 POST /v1/accounts/{account_id}/runtime/start。
  • provider_data.api_id — 選填,從 my.telegram.org 取得的 Telegram App ID。未提供時使用平台預設應用程式憑證;使用自有應用程式時,請將同一應用程式的 api_id 與 api_hash 以字串成對提供。
  • provider_data.api_hash — 選填,從 my.telegram.org 取得的 Telegram App Hash。未提供時使用平台預設應用程式憑證;使用自有應用程式時,請將同一應用程式的 api_id 與 api_hash 以字串成對提供。

session

會話匯入流程:將既有授權會話匯入 UnifyPort。

  1. 1. POST /v1/accounts,provider=telegram、auth_mode=session。
  2. 2. POST /v1/accounts/{account_id}/auth/session,params.session_url 指向可下載的 .session 檔。
  3. 3. 授權成功後先檢查 runtime_status,僅在仍需啟動時呼叫 POST /v1/accounts/{account_id}/runtime/start。
  • params.session_url — 既有 Telegram 會話的 URL 或參考。

備註

  • Telegram 的 code、qrcode、session 三種授權模式均不需要呼叫方自行提供 api_id 與 api_hash,未提供時使用平台預設應用程式憑證。使用自有應用程式時,請在 provider_data 中將同一 Telegram 應用程式的兩項憑證以字串成對提供。
  • 二階段密碼每次嘗試都是無狀態。輸錯密碼時請先 cancel,再重新走 /auth/qr/start 或 /auth/start。
  • QR token 約 30 秒就過期。過期後再呼叫一次 qr/start 即可更新 — 前端需重新繪製 QR。
  • 帳號設定階段就會自動注入 webhook URL,授權狀態變化與登入事件會與入站訊息走同一個 webhook 端點。