# 解码订单包含的敏感数据
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:decodesensitiveinfo
为保护敏感数据(如收货人昵称、电话号码、详细收货地址),平台对这些信息进行了部分隐藏。通过本接口操作订单后,可以获取到这些信息的完整数据。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/order/sensitiveinfo/decode?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:131
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
order_id | string | 是 | 123456 | 订单id |
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 示例 | 说明 |
---|---|---|---|
errcode | number | 0 | 错误码 |
errmsg | string | ok | 错误信息 |
address_info | object | 收货信息 | |
virtual_number_info | object | 虚拟号信息 |
# Res.address_info Object Payload
收货信息
参数名 | 类型 | 说明 |
---|---|---|
user_name | string | 收货人姓名 |
postal_code | string | 邮编 |
province_name | string | 省份 |
city_name | string | 城市 |
county_name | string | 区 |
detail_info | string | 详细地址 |
national_code | string | 国家码 |
tel_number | string | 联系方式 , 如果使用了虚拟号,该字段为脱敏电话号码 |
house_number | string | 门牌号码 |
virtual_order_tel_number | string | 虚拟发货订单联系方式,在发货方式为无需快递(deliver_method=1)时返回 |
# Res.virtual_number_info Object Payload
虚拟号信息
参数名 | 类型 | 说明 |
---|---|---|
virtual_number | string | 虚拟号 |
extension | string | 分机号 |
expiration | number | 过期时间戳 |
# 4. 注意事项
- 本接口仅适用于已付款的订单;
- 解码操作对订单数量有严格限制。请合理调用,避免不必要的重复请求。超出限制将导致接口报错。对同一订单的多次调用,系统仅计算一次;
- 商家可用基础解码数为30次/日,次日重置,若当日次数不满足使用需通过视频号小店后台申请提额,商家可继续使用通过次数,次日失效。详情可见订单信息解密额度调整上线公告
- 2024年10月21日起逐步重新上线虚拟号功能,解密后获得的虚拟号信息通过virtual_number_info字段返回
# 5. 代码示例
请求示例
{
"order_id": "123456"
}
返回示例
{
"errcode": 0,
"errmsg": "ok"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
10020123 | 订单解码数达到当月限制 | |
10020124 | 未完成支付的订单不支持API解码操作 | |
10020248 | 礼物订单不支持查看详细收货信息 | |
10020501 | 基于用户隐私保护,无法解密 |
# 7. 适用范围
本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。