# 激活与更新服务卡片
接口应在服务器端调用,详细说明参见服务端API。
# 接口说明
# 接口英文名
setUserNotify
# 功能描述
激活与更新服务卡片
# 注意事项
服务卡片详细介绍可参考文章
# 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/set_user_notify?access_token=ACCESS_TOKEN
# 第三方调用
调用方式以及出入参和HTTPS相同,仅是调用的token不同
该接口所属的权限集id为:18
服务商获得其中之一权限集授权后,可通过使用authorizer_access_token代商家进行调用
# 请求参数
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证,该参数为 URL 参数,非 Body 参数。使用access_token或者authorizer_access_token |
openid | string | 是 | 用户身份标识符。 当使用微信支付订单号作为 code 时,需要与实际支付用户一致;当通过前端获取 code 时,需要与点击 button 的用户一致。 |
notify_type | number | 是 | 卡片id。可在文中(1.1)中查阅。 |
notify_code | string | 是 | 动态更新令牌。获取方式可在文中(1.3或1.4)中查阅。 需要注意的是,微信支付订单号从生成到可被校验存在一定的时延可能,若收到报错为 notify_code 不存在,建议在1分钟后重试。 |
content_json | string | 是 | 卡片状态与状态相关字段,不同卡片的定义不同,可在文中(1.1中各模版定义链接)中查阅。 |
check_json | string | 否 | 微信支付订单号验证字段。 当将微信支付订单号作为 notify_code 时,在激活时需要传入 |
# 返回参数
属性 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
# 其他说明
# check_json定义
参数 | 是否必填 | 类型 | 说明 | 格式要求 |
---|---|---|---|---|
pay_amount | 是 | uint32 | 订单支付金额。若订单有优惠,支持传入下单金额或实际支付金额。 若为合单支付的子订单号,可传入子单的下单金额、子单的实际支付金额、合单的下单金额或合单的实际支付金额。 | 单位为分 |
pay_time | 是 | uint32 | 支付时间 | 秒级时间戳 |
pay_channel | 否 | uint32 | 订单渠道,0:普通微信支付,1001:支付分 |
# 调用示例
示例说明: 通过前端获取code的卡片:激活与更新示例
# 请求数据示例
{
"notify_type": 1001,
"openid": "xxx",
"notify_code": "xxx",
"content_json": "{\"cur_status\":2,\"license_plate\":\"粤A12345A\",\"arrival_time\":1679569348,\"wxa_path_query\":\"\"}"
}
# 返回数据示例
{
"errcode": 0,
"errmsg": "ok"
}
示例说明: 使用微信支付订单号作为code的卡片:激活示例
# 请求数据示例
{
"notify_type": 2001,
"openid": "xxx",
"notify_code": "xxx",
"check_json": "{\"pay_amount\":1005,\"pay_time\": 1683525070}",
"content_json": "{\"cur_status\":1,\"product_count\": 1,\"product_list\":{\"info_list\":[{\"product_img\":\"https://res.wx.qq.com/op_res/DiSd8fVjXuHr5K9U73oRr74fMqnT5r9_GmI3mbfLOn2RpC_aENIPjYPPhPN_YnNKnUhyuAy8yLqNRAlh_JCsWQ\",\"product_name\":\"阿白\",\"product_path_query\":\"pages/index/index\"}]},\"wxa_path_query\":\"pages/index/index\"}"
}
# 返回数据示例
{
"errcode": 0,
"errmsg": "ok"
}
示例说明: 使用微信支付订单号作为code的卡片:更新示例
# 请求数据示例
{
"notify_type": 2001,
"openid": "xxx",
"notify_code": "xxx",
"content_json": "{\"cur_status\":2,\"product_count\": 1,\"product_list\":{\"info_list\":[{\"product_img\":\"https://res.wx.qq.com/op_res/DiSd8fVjXuHr5K9U73oRr74fMqnT5r9_GmI3mbfLOn2RpC_aENIPjYPPhPN_YnNKnUhyuAy8yLqNRAlh_JCsWQ\",\"product_name\":\"阿白\",\"product_path_query\":\"pages/index/index\"}]},\"send_time\": 1696157643,\"wxa_path_query\":\"pages/index/index\"}"
}
# 返回数据示例
{
"errcode": 0,
"errmsg": "ok"
}
# 错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
40003 | invalid openid | 不合法的 OpenID ,请开发者确认 OpenID 的有效性 |
85431 | system error | 系统繁忙,稍后重试 |
85433 | invalid check_json | check_json 参数不合法 |
85434 | invalid notify_type | notify_type 参数不合法 |
85435 | invalid content_json | content_json 参数不合法 |
85436 | notify_code abnormal | notify_code 异常(被封禁) |
85437 | invalid notify_code | notify_code 不存在 |
85438 | notify_code expired | notify_code 已过期 |
85439 | content_json with wrong status | content_json 状态不合法 |
85440 | content_json lack need field | content_json 缺少字段 |
85441 | content_json has unformat field | content_json 字段格式不对 |
85442 | content_json blocked by securiy audit | content_json 包含审核不通过信息 |
85443 | content_json has illegal utf8 char | content_json 包含非utf8字符 |
85461 | notify_type access deny | notify_type 准入驳回 |
85462 | app aceess deny | 小程序准入驳回 |
85448 | notify_code has used | notify_code 已经推送过 |
85449 | notify_code is dealing and locked, retry later | notify_code 正在更新,已加锁,稍后重试 |