# API变更日志回调

本文档描述服务器端接收的消息或事件,详细说明参见消息推送

事件英文名:ApiDiffEvent

微信小店会通过该接口将API变更日志相关消息通知给商户,以便商户及时掌握接口变动情况,做好业务调整与适配。

# 1. 消息参数

# 请求体 Request Payload

参数名类型说明
ToUserNamestring接收通知的小店UserName
FromUserNamestring微信平台标识的OpenID,固定值
CreateTimenumber事件时间,Unix时间戳,即格林威治时间1970年01月01日00时00分00秒(北京时间1970年01月01日08时00分00秒)起至当前的总秒数
MsgTypestring消息类型,固定为event
Eventstring事件类型,本接口固定为api_diff
changelog_urlstringAPI变更日志文档链接,可点击查看详细变更信息
api_changesobjarrayAPI具体变更内容数组,每个元素为一个API变更详情对象
change_timenumberAPI变更发生时间,Unix时间戳,即格林威治时间1970年01月01日00时00分00秒(北京时间1970年01月01日08时00分00秒)起至当前的总秒数

# Body.api_changes(Array) Object Payload

API具体变更内容数组,每个元素为一个API变更详情对象

参数名类型说明
chinese_namestringAPI的中文名称,便于商户直观识别接口用途
cgi_pathstringAPI的接口路径(CGI路径),唯一标识该接口
doc_urlstringAPI官方文档的链接,商户可通过该链接查看接口的完整说明
change_contentstringAPI的具体变更内容描述

# 2. 消息返回

# 返回体 Response Payload

回复 success 或空字符串(无需加密)

# 3. 注意事项

  • 回调url设置和消息推送规则需参考消息推送文档 ,如果设置的回调url无法访问,商户将无法收微信小店发送的通知;
  • 商户需密切关注API变更内容,及时评估对自身业务的影响,避免因接口变动导致业务异常。

# 4. 代码示例

请求示例

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

返回示例

success
文档变更日志(1条)
2025 年 11 月 12 日
新增回调便于开发者订阅 API 变更日志