API 參考

群組

列出入群申請

列出已開啟入群審核之群組的待審核申請。group_id 走 query 參數。上游的即時推播不保證可靠,請以輪詢本端點為準。

GEThttps://api.unifyport.ai/v1/accounts/{account_id}/groups/join-requests

呼叫前準備

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

參數從哪裡取得
account_id
從建立或查詢帳號的回應取得 data.id。帳號屬於 X-Api-Key 對應的工作區。 取得帳號
group_id
要操作的群組 — 即列出群組時回傳的 id。因渠道 id 可能含有 @ 或 :,故保留於查詢字串中。

請求參數

請求標頭

X-Api-Key
string必填

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

路徑參數

account_id
string必填

用於該 groups 路由的識別字。

查詢參數

group_id
string必填

要操作的群組 — 即列出群組時回傳的 id。因渠道 id 可能含有 @ 或 :,故保留於查詢字串中。

請求內容

此介面無需 JSON 請求內容。

如何理解結果

依文件解讀回應欄位與 HTTP 狀態。204 成功沒有回應本文,排查時使用 X-Request-Id。下一步請參閱相關操作。

回應 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "group_id": "group_example",
    "items": [
      {
        "id": "member_example",
        "phone": "8613912345678",
        "requested_at": "2026-06-08T12:34:56Z"
      }
    ]
  }
}

回應內容

id
string

加入申請識別字;核准或拒絕時請以 member_ids 傳入。

phone
string

申請者的電話號碼(當渠道有提供時)。

lid
string

渠道有提供時回傳的申請者 LID。

requested_at
string

提出加入申請時的 RFC3339 時間戳記。

format: date-time

group_id
string

這些加入申請所屬的群組。

回應

200

200 OK

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

400

請求錯誤

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

401

未授權

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

404

找不到資源

找不到請求的渠道資源。

409

衝突

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

500

伺服器錯誤

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

501

渠道尚未實作

所選渠道尚未實作此操作。

502

上游閘道錯誤

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

失敗後如何處理

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

invalid_request · 10000 · 400
檢查必填欄位、格式與渠道條件,修正請求後再呼叫。
invalid_api_key · 11001 · 401
檢查 X-Api-Key 與工作區是否有效。