# API变更日志回调

> 本文档描述服务器端接收的消息或事件，详细说明参见[消息推送](/miniprogram/dev/framework/server-ability/message-push.md)。

事件英文名：ApiDiffEvent

微信小店通过该接口向商户推送 API 变更日志消息，帮助商户及时掌握接口变动情况，做好业务调整与适配。

## 1. 消息参数

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "ToUserName",
    "类型": "string",
    "说明": "接收通知的微信小店 UserName"
  },
  {
    "参数名": "FromUserName",
    "类型": "string",
    "说明": "微信平台标识的 OpenID，为固定值"
  },
  {
    "参数名": "CreateTime",
    "类型": "number",
    "说明": "事件时间，Unix 时间戳，即自 1970-01-01 00:00:00 UTC（北京时间 1970-01-01 08:00:00）起至当前的总秒数"
  },
  {
    "参数名": "MsgType",
    "类型": "string",
    "说明": "消息类型，固定为 event"
  },
  {
    "参数名": "Event",
    "类型": "string",
    "说明": "事件类型，本接口固定为 api_diff"
  },
  {
    "参数名": "changelog_url",
    "类型": "string",
    "说明": "API 变更日志文档链接，可点击查看详细变更信息"
  },
  {
    "参数名": "api_changes",
    "类型": "objarray",
    "说明": "API 变更详情数组，每个元素为一个 API 变更对象"
  },
  {
    "参数名": "change_time",
    "类型": "number",
    "说明": "API 变更发生时间，Unix 时间戳，即自 1970-01-01 00:00:00 UTC（北京时间 1970-01-01 08:00:00）起至当前的总秒数"
  }
]
```

">

### Body.api_changes(Array) `Object Payload`

API 变更详情数组，每个元素为一个 API 变更对象

```json
[
  {
    "参数名": "chinese_name",
    "类型": "string",
    "说明": "API 的中文名称，便于商户直观识别接口用途"
  },
  {
    "参数名": "cgi_path",
    "类型": "string",
    "说明": "API 的接口路径（CGI 路径），唯一标识该接口"
  },
  {
    "参数名": "doc_url",
    "类型": "string",
    "说明": "API 官方文档链接，商户可通过该链接查看接口的完整说明"
  },
  {
    "参数名": "change_content",
    "类型": "string",
    "说明": "API 的具体变更内容描述"
  }
]
```

## 2. 消息返回

### 返回体 `Response Payload`

回复 `success` 或空字符串（无需加密）

## 3. 注意事项

- 回调 URL 设置和消息推送规则需参考[消息推送文档](/doc/store/shop/dev_before/message_push.md)，如果设置的回调 URL 无法访问，商户将无法收到微信小店发送的通知；
- 商户需密切关注 API 变更内容，及时评估对自身业务的影响，避免因接口变动导致业务异常。

## 4. 代码示例

请求示例

```json
{
    "ToUserName": "gh_6a4cebfd5b9c", 
    "FromUserName": "oM0yI7WiASw6i5e3ZXKVKFYa9A9c", 
    "CreateTime": 1762492842, 
    "MsgType": "event", 
    "Event": "api_diff", 
    "changelog_url": "/doc/store/shop/changelog.md",
    "api_changes": [
        {
            "chinese_name": "电子面单取号",
            "cgi_path": "/channels/ec/logistics/ewaybill/biz/order/create",
            "doc_url": "/doc/store/shop/API/channels-shop-delivery/ewaybill/api_ewaybill_createorder.md",
            "change_content": "更新接口：调整「跨店打单」模式（入参`ewaybill_order_code` `ewaybill_order_appid`字段）的使用条件。"
        }
    ],
    "change_time": "1762492842"
}
```

返回示例

```
success
```

![](https://res8.wxqcloud.qq.com.cn/wxdoc/56617deb-b17d-4cf1-bccd-71d2c41ccc76.svg)文档变更日志（1条）
2025 年 11 月 12 日新增回调便于开发者订阅 API 变更日志