跳到主要内容

服务器端 API

服务器端 API 供应用后端调用。应用后端应先按接入指南了解通用请求与错误处理,再完成鉴权与签名;端内网页应用还需要按免登流程换取当前用户身份。

接入与鉴权​

文档入口说明
接入指南https://{gateway_host}统一响应、通用请求规则、错误与重试
鉴权与签名/auth/v1/oauth/token获取应用 access_token 与 Webhook 签名规则
免登流程SDK 获取 code、/auth/v1/oauth/userinfo页面授权码换取用户身份

接口一览​

接口请求入口
获取企业基础信息/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 占位值。
  • 查询和发送接口均提供 Shell、PHP、Golang、C++ 示例;示例中的密钥只能放在服务端。
  • 成员 ID、部门 ID 使用字符串;统一响应和错误处理见接入指南。
  • 机器人写接口应携带 Idempotency-Key,重试时保持同一幂等键和请求体。