跳至主要内容

服務端 API

服務端 API 由應用後端呼叫。請先閱讀接入指南了解通用請求和錯誤處理,再完成鑑權與簽名。在容器內執行的網頁應用還需要按照免登流程,用授權碼換取目前使用者的身份。

接入與鑑權​

文件入口說明
接入指南https://{gateway_host}統一回應、通用請求規則、錯誤和重試
鑑權與簽名/auth/v1/oauth/token取得應用 access_token,並了解 Webhook 簽名規則
免登流程SDK 取得 code、/auth/v1/oauth/userinfo用頁面授權碼換取使用者身份

API 列表​

API請求入口
取得企業資訊/open/v1/enterprise/info
取得部門列表/open/v1/contact/department/list
取得部門詳情/open/v1/contact/department/get
取得部門成員列表/open/v1/contact/user/list
取得成員詳情/open/v1/contact/user/get
批量發送人與機器人會話中的機器人訊息/open/v1/robot/messages
卡片按鈕回呼使用者點擊後,平台向按鈕 action 位址發送簽名 POST
群聊機器人/webhook/robot/send
事件訂閱應用設定的 HTTPS 地址

版本相容性​

本次新增的卡片 api 按鈕、value 參數與空動作僅展示能力,要求私有化部署版本 > 1.1.13。1.1.13 及更早版本不支援這些新增能力;舊版本請繼續使用既有 url 按鈕方案。

呼叫約定​

  • 所有範例使用 https://{gateway_host}、app_xxx 和 access-token-xxx 作為佔位值。
  • 查詢和發送 API 提供 Shell、PHP、Golang 和 C++ 範例;範例密鑰必須保留在服務端。
  • 成員 ID 和部門 ID 使用字串。統一回應與錯誤處理請參閱接入指南。
  • 機器人寫入 API 應帶上 Idempotency-Key;重試時保持相同的冪等鍵和請求體。