使用不含版本的 URL
所有請求都使用正式環境基礎 URLhttps://api.brightalk.ai。版本號不屬於路徑的一部分;例如,使用 POST /calls 建立通話。
傳送 Brightalk-Version
客戶端應在每個請求明確傳送支援的日期版本:Brightalk-Version 標頭回傳實際套用的版本。請將標頭值放在設定中,讓契約升級都能先完成審查與測試。
理解省略標頭與預設值
每個組織都有固定的預設 API 版本。若請求省略Brightalk-Version,Brightalk 會使用該固定預設值,並仍在回應標頭傳回實際版本。省略標頭不代表任意選用最新版本。
處理不支援的版本
未知或已停用的值會傳回400 unsupported_version。若回應包含可供機器讀取的 details,其中會列出支援版本: