Skip to content

回调配置 ​

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

本模块接口全部 POST。{BASE_URL} 是含 /wx-api 的完整 API Base;直接复制接口页的请求示例。

接口用途安全级别
设置或更新回调地址
/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)。只读

安全级别与「实测 日期」标记的含义见API 参考的表格说明。

使用要点 ​

  • 首次接入:按回调说明 · 三步接上设置地址、测试连通,再接收一条真实消息;没有接收服务时,使用本地完整示例。
  • 判断测试结果:data.ok=true 且 data.httpStatus 为 2xx 才算测试通过,不能只看测试接口的 HTTP 200 或 code=0。
  • 保存密钥:secret 只在首次创建时返回;更新已有配置不返回也不改密钥,继续使用原值。丢失时按密钥恢复说明处理;仅更换地址不用删除配置。