Skip to main content
每個非 2xx 回應都使用一致的 JSON 格式。請依穩定的 error.code 分類錯誤,不要依賴供人閱讀的 message

錯誤回應格式

details 為非必填且可供機器讀取的內容。客戶端應忽略 details 中的未知欄位。

請求關聯

每個回應都包含 X-Request-Id 標頭,錯誤內容也會在 error.request_id 重複同一值。請將該識別碼與失敗操作一起記錄,並在聯絡 Brightalk 支援時提供。不要記錄 API 金鑰或完整聯絡人資料。 您可以傳送 X-Request-Id,使用 1–64 個 A-Za-z0-9._:- 字元。若省略或傳送不合格式的值,Brightalk 會改用產生的識別碼。

身分驗證錯誤的差異

這些回應只描述憑證是否可用,不會洩漏其他組織的資源。

狀態與錯誤目錄

對已知路徑使用不支援的方法時,回應也包含 Allow。適合等待後重試的情況會包含 Retry-After。錯誤回應絕不揭露實作名稱、內部資料內容、查詢細節或堆疊追蹤。

下載錄音的錯誤格式較單純,且與上述格式不同

download_url 回傳的簽名網址並不屬於上面這套有版本號的 JSON API——它由另一個不需要 API 金鑰的主機提供服務,請求失敗時回傳 {"error": "<code>"},是一個純字串錯誤碼,沒有 messagerequest_id,也沒有 details。其中兩個錯誤碼帶有必須分開處理的意義: 請把這兩者視為相反的訊號,而不是同一種失敗的不同程度:503 代表稍後再試,410 代表位元組已永久消失。若同步程式把兩者都當成「放棄」處理,就會悄悄丟掉稍後其實抓得到的錄音。此網址的其他錯誤碼(403 invalid_link404 not_found502 upstream_unavailable503 server_configuration_error)不帶有這種明確的重試/不重試意義,但 502503 server_configuration_error 同樣可以退避後重試——兩者都代表問題出在我們這端,而不是對這筆錄音下了永久性的判斷。