# auth.checkEncryptedData

本接口应在服务器端调用，详细说明参见服务端API。

本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载），wx-server-sdk >= 0.4.0

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

调用方式：

HTTPS 调用
云调用

# HTTPS 调用

# 请求地址

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

# 请求参数

属性	类型	默认值	必填	说明
encrypted_msg_hash	string		是	加密数据的sha256，通过Hex（Base16）编码后的字符串

# 返回值

# Object

返回的 JSON 数据

属性	类型	说明
errcode	number	错误码
errmsg	string	错误提示信息
vaild	boolean	是否是合法的数据
create_time	number	加密数据生成的时间戳

errcode 的合法值

值	说明	最低版本
0	请求成功
-1	系统繁忙，此时请开发者稍候再试
1	加密数据不存在，数据生成的时间超过保存的限制（3天）或者key不存在
40097	请求里的encrypted_msg_hash参数无效
44002	传入的数据为空
47001	传入的数据格式错误

# 调用示例

加密数据为: hsSuSUsePBqSQw2rYMtf9Nvha603xX8f2BMQBcYRoJiMNwOqt/UEhrqekebG5ar0LFNAm5MD4Uz6zorRwiXJwbySJ/FEJHav4NsobBIU1PwdjbJWVQLFy7+YFkHB32OnQXWMh6ugW7Dyk2KS5BXp1f5lniKPp1KNLyNLlFlNZ2mgJCJmWvHj5AI7BLpWwoRvqRyZvVXo+9FsWqvBdxmAPA==
sha256: 657edd868c9715a9bebe42b833269a557a48498785397a796f1568c29a200b2c

curl -H "Accept: application/json" -H "Content-type: application/json" -X POST -d '{"encrypted_msg_hash": "657edd868c9715a9bebe42b833269a557a48498785397a796f1568c29a200b2c"}' http://api.weixin.qq.com/wxa/business/checkencryptedmsg?access_token=ACCESS_TOKEN

# 返回结果示例

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

# 云调用

云调用是微信云开发提供的在云函数中调用微信开放接口的能力，需要在云函数中通过 wx-server-sdk 使用。

# 接口方法

openapi.auth.checkEncryptedData

需在 config.json 中配置 auth.checkEncryptedData API 的权限，详情

# 请求参数

属性	类型	默认值	必填	说明
encryptedMsgHash	string		是	加密数据的sha256，通过Hex（Base16）编码后的字符串

# 返回值

# Object

返回的 JSON 数据

属性	类型	说明
errCode	number	错误码
errMsg	string	错误提示信息
vaild	boolean	是否是合法的数据
createTime	number	加密数据生成的时间戳

errCode 的合法值

值	说明	最低版本
0	成功

# 异常

# Object

抛出的异常

属性	类型	说明
errCode	number	错误码
errMsg	string	错误提示信息

errCode 的合法值

值	说明	最低版本
-1	系统繁忙，此时请开发者稍候再试
1	加密数据不存在，数据生成的时间超过保存的限制（3天）或者key不存在
40097	请求里的encrypted_msg_hash参数无效
44002	传入的数据为空
47001	传入的数据格式错误