This document describes server-side received messages or events. For details, see Message Push.

Event Name: ApiDiffEvent

WeChat Mini Programs will use this interface to notify Merchants of API change logs, enabling them to stay informed about interface updates and make timely adjustments and adaptations to their businesses.

1. Message Parameters

Request Body `Request Payload`

Parameter	Type	Description
ToUserName	string	The Mini Program username that receives notifications
FromUserName	string	The OpenID identified by the WeChat platform, a fixed value
CreateTime	number	Event time, in Unix timestamp format, representing the total number of seconds since January 1, 1970, 00:00:00 UTC (08:00:00 Beijing Time on January 1, 1970) up to the present
MsgType	string	Message type, fixed as event
Event	string	Event type. For this interface, it is fixed as api_diff
changelog_url	string	Link to the API change log document, where detailed change information can be viewed
api_changes	objarray	Array of specific API change details, with each element being an API change object
change_time	number	Time when the API change occurred, in Unix timestamp format, representing the total number of seconds since January 1, 1970, 00:00:00 UTC (08:00:00 Beijing Time on January 1, 1970) up to the present

Body.api_changes(Array) `Object Payload`

Array of specific API change details, with each element being an API change object

Parameter	Type	Description
chinese_name	string	Chinese name of the API, for easy identification by Merchants
cgi_path	string	API path (CGI path), uniquely identifying the interface
doc_url	string	Link to the official API documentation, where Merchants can find complete interface descriptions
change_content	string	Detailed description of the API changes

2. Message Response

Response Body `Response Payload`

Reply success or empty string (no encryption required)

3. Notes

For callback URL settings and message push rules, please refer to the Message Push Documentation. If the set callback URL is unreachable, Merchants will not receive notifications from WeChat Mini Programs.
Merchants should closely monitor API changes and promptly assess their impact on their businesses to avoid any disruptions due to interface modifications.

4. Code Example

Request Example

{
    "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": "Electronic Waybill Number Retrieval",
            "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": "Interface update: Adjusted the usage conditions for the 'Cross-store Ordering' mode (input parameters `ewaybill_order_code` and `ewaybill_order_appid`)."
        }
    ],
    "change_time": "1762492842"
}

Response Example

success

API Change Log Callback