# 检查加密信息

调试诊断

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:checkEncryptedData

检查加密信息是否由微信生成(当前只支持手机号加密数据),只能检测最近3天生成的加密数据。

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/wxa/business/checkencryptedmsg?access_token=ACCESS_TOKEN

支持加密请求: 本接口支持服务通信二次加密和签名,可有效防止数据篡改与泄露。查看详情

# 云调用

  • 本接口不支持云调用

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:18

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填说明
encrypted_msg_hashstring加密数据的sha256,通过Hex(Base16)编码后的字符串

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误提示信息
vaildboolean是否是合法的数据
create_timenumber加密数据生成的时间戳

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

{
  "encrypted_msg_hash": "657edd868c9715a9bebe42b833269a557a48498785397a796f1568c29a200b2c"
}

返回示例

{
  "errcode": 0,
  "errmsg": "ok",
  "vaild": true,
  "create_time": 1629121902
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

错误码错误描述解决方案
-1system error系统繁忙,此时请开发者稍候再试
1data not exit加密数据不存在,数据生成的时间超过保存的限制(3天)或者 key 不存在,或者数据和appid不匹配
40097invalid args参数错误
44002empty post dataPOST 的数据包为空。post请求body参数不能为空。
47001data format error解析 JSON/XML 内容错误;post 数据中参数缺失;检查修正后重试。

# 7. 适用范围

本接口在不同账号类型下的可调用情况:
小程序小游戏
  • ✔:该账号可调用此接口
  • 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;