「進階集成可見性」查詢號碼訂閱專為「進階集成可見性」的訂戶而設，讓他們能夠管理以查詢號碼為基礎的webhook項目，並可利用API端點執行與項目相關的操作，例如新增查詢號碼、編輯或檢視作業詳情。

請注意：

• 您必須擁有「進階集成可見性」項目的管理員或貢獻者權限
• 如需進一步了解「進階集成可見性」及其功能，請參閱「進階集成可見性」說明文件頁面。

「進階集成可見性」查詢號碼訂閱的優勢包括：

• 您可使用API端點，輕鬆更新及管理「進階集成可見性」項目的查詢號碼。
• 此API可讓您透過單一API交易，將多個查詢號碼關聯至您的項目，無需逐個查詢號碼關聯。
• 您可連續提交API請求，並檢視各項請求的成功／失敗日誌詳情。

使用以下端點來管理您的「進階集成可見性」項目：

此API僅能透過項目概覽(如上截圖所示)存取。

使用此端點來觸發非同步作業，將一個或多個查詢號碼關聯至特定的「進階集成可見性」項目。

此請求的必須輸入資料為：

• 操作–提交請求時，請指明需執行的操作。範例：ADD
• 查詢號碼詳情–請指明查詢號碼

每次請求最多可關聯1000個查詢號碼。此請求的成功回應將返回jobID、目前作業狀態，以及作業建立及完成的時間戳記。您稍後可使用此jobId，查詢此項非同步作業的狀態。

使用此端點以查詢非同步作業(即佇列中的一項或多項連續請求)的狀態，或者所有已提交作業的狀態。

此請求的必須輸入資料為：

• 作業ID –請指明您想查詢狀態的作業ID。

請注意：此端點中的作業ID為可選填。若您未有指明作業ID，系統將返回所有已提交作業的狀態。

此請求的成功回應將返回jobID、目前作業狀態，以及作業建立及完成的時間戳記。回應將顯示作業的目前狀態，並還將包含成功訊息、錯誤或警告，以供用戶檢視，以及於適用時進行疑難排解。

• 如作業狀態顯示為「已完成」，即代表所有查詢號碼已成功驗證及處理。
  • 「已完成」僅代表查詢號碼已完成驗證及處理，並不表示所有查詢號碼均已成功新增至「進階集成可見性」項目。
  • 若您嘗試關聯多個查詢號碼，而僅部分成功關聯，其餘未能關聯，作業狀態仍會顯示為「已完成」。如需確認關聯請求中每個查詢號碼的狀態，請下載批量報告。

請注意：

• 如作業狀態顯示為「失敗」，表示由於多項原因或嚴重錯誤，請求未能處理，用戶必須重試。

各項狀態及其相應說明如下：

使用此端點來下載處於「已完成」狀態之非同步作業的JSON報告。

與此請求相關的必須輸入資料為：

• 作業ID –請指明您想查詢狀態的作業ID。

請注意：

• 此端點中的作業ID為必填。
• 每次僅可下載一項非同步作業的報告。
• 如作業並非「已完成」，而您嘗試下載報告，系統將顯示錯誤訊息。

對此請求成功回應後，您將取得JSON格式的作業報告。

• 每次請求最多可為一個「進階集成可見性」項目關聯1,000個託運查詢號碼。
• 指定的「進階集成可見性」項目可關聯的查詢號碼數量不設上限。
• 任何已關聯的查詢號碼將於40天後，從指定的「進階集成可見性」項目中解除關聯。
• 指定「進階集成可見性」項目之任何已建立的作業ID狀態和詳情，將於90天後無法再查閱。
• 透過「進階集成可見性」查詢號碼訂閱，將無法取得受保護的查詢資料，例如收件人地址或收件人簽名。