# 更新服务卡片扩展信息
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:setUserNotifyExt
更新服务卡片扩展信息
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/set_user_notifyext?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:18
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| openid | string | 是 | 用户身份标识符。 当使用微信支付订单号作为 code 时,需要与实际支付用户一致;当通过前端获取 code 时,需要与点击 button 的用户一致。 |
| notify_type | number | 是 | 卡片id。可在文中(1.1)中查阅。 |
| notify_code | string | 是 | 动态更新令牌。获取方式可在文中(1.3或1.4)中查阅。 需要注意的是,微信支付订单号从生成到可被校验存在一定的时延可能,若收到报错为 notify_code 不存在,建议在1分钟后重试。 |
| ext_json | string | 是 | 扩展信息,不同卡片的定义不同,可在文中(1.1中各模版定义链接)中查阅。 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
# 4. 注意事项
服务卡片详细介绍可参考文章
# 5. 代码示例
请求示例
{
"notify_type": 1003,
"openid": "xxx",
"notify_code": "xxx",
"ext_json": "{\"pay_info\":\"{\\\"transaction_id\\\":\\\"4200001855202305090060871147\\\",\\\"pay_amount\\\":2001,\\\"pay_time\\\":1683546394}\",\"store_info\":\"{\\\"store_name\\\":\\\"westore\\\",\\\"store_address\\\":\\\"深圳市南山区南山大道18号\\\",\\\"latitude\\\":22,\\\"longitude\\\":114}\"}"
}
返回示例
{
"errcode": 0,
"errmsg": "ok"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 40003 | invalid openid | 不合法的 OpenID ,请开发者确认 OpenID 的有效性 |
| 85431 | system error | 系统繁忙,稍后重试 |
| 85434 | invalid notify_type | notify_type 参数不合法 |
| 85436 | notify_code abnormal | notify_code 异常(被封禁) |
| 85437 | invalid notify_code | notify_code 不存在 |
| 85444 | pay_info check fail | pay_info 校验不通过 |
| 85445 | store_info check fail | store_info 校验不通过 |
| 85446 | shipping_list check fail | shipping_list 校验不通过 |
| 85447 | product_list check fail | product_list 校验不通过 |
| 85461 | notify_type access deny | notify_type 准入驳回 |
| 85462 | app aceess deny | 小程序准入驳回 |
| 85470 | invalid ext_json | ext_json 参数不合法 |
| 85471 | ext_json has illegal utf8 char | ext_json 包含非utf8字符 |
# 7. 适用范围
本接口在不同账号类型下的可调用情况:
| 小程序 | 小游戏 |
|---|---|
| ✔ | ✔ |
- ✔:该账号可调用此接口
- 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;