Skip to content

回调配置

设置、查询、删除、测试回调地址,查看可订阅事件。

本模块接口全部 POST,请求地址 = {BASE_URL} + 路径。

接口用途安全级别
设置或更新回调地址
/wx-api/webhook/set
用 App Token 设置你的回调地址;系统收到企微事件后按此地址推送给你。写操作
查询当前回调配置
/wx-api/webhook/get
返回当前应用的回调配置(未设置则 webhook 为 null)。只读
删除回调配置
/wx-api/webhook/delete
删除当前应用的回调;删除后系统不再推送(可重新 set)。高风险
测试投递
/wx-api/webhook/test
向当前回调地址推送一条 webhook.test 事件,返回推送结果(HTTP 状态/响应片段)。写操作
可订阅事件列表
/wx-api/webhook/event-types
返回可订阅的事件类型(message.received / friend.added / friend.deleted / contact.modified / instance.online / instance.offline)。只读

安全级别与「实测 日期」标记的含义见接口总览的图例

使用要点

  • 设置或更新回调地址测试投递,收到 webhook.test 并返回 HTTP 2xx(建议返回 {});测试响应的 data.ok=truedata.httpStatus 为 2xx 才算配置完成,不能只看接口 HTTP 200。
  • secret 只在首次创建时返回一次,保存到服务端配置里;再次设置是更新,不返回也不改密钥。丢失后先删除回调配置重新设置获取新 secret,同时更新验签密钥;也可联系对接人。配置流程、验签与事件说明见 回调说明