本繁體中文版使用機器翻譯,譯文僅供參考,若與英文版本牴觸,應以英文版本為準。

關於Element軟體API

貢獻者

元素API是以透過HTTPS的JSON-RPC傳輸協定為基礎。JSON-RPC是以輕量化JSON資料交換格式為基礎的簡單文字型RPC傳輸協定。用戶端程式庫適用於所有主要的程式設計語言。

您可以透過HTTPS POST要求、向API端點提出API要求。POST要求的本文是JSON-RPC要求物件。API目前不支援批次要求(單一POST中有多個要求物件)。提交API要求時、您必須使用「application/json-rpc」做為要求的內容類型、並確保實體未編碼格式。

附註 Element Web UI會使用本文所述的API方法。您可以啟用API記錄來監控UI中的API作業;如此可讓您查看發行給系統的方法。您可以同時啟用要求和回應、以查看系統如何回覆所發佈的方法。

除非另有說明、否則API回應中的所有日期字串均為UTC+0格式。

附註 當儲存叢集負載沉重、或是您提交許多連續的API要求而沒有介入延遲時、某種方法可能會失敗、並傳回錯誤「xDBVERionm不符」。如果發生這種情況、請重試方法呼叫。