# 获取用户encryptKey

调试诊断

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

# 接口说明

# 接口英文名

getUserEncryptKey

# 功能描述

该接口用于获取用户encryptKey。 会获取用户最近3次的key,每个key的存活时间为3600s。

# 调用方式

# HTTPS 调用

 GET https://api.weixin.qq.com/wxa/business/getuserencryptkey?access_token=ACCESS_TOKEN&signature=SIGNATURE&openid=OPENID&sig_method=SIG_METHOD 

# 第三方调用

  • 调用方式以及出入参和HTTPS相同,仅是调用的token不同

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

  • 服务商获得其中之一权限集授权后,可通过使用authorizer_access_token代商家进行调用

# 请求参数

属性 类型 必填 说明
access_token string 接口调用凭证,该参数为 URL 参数,非 Body 参数。使用access_token或者authorizer_access_token
openid string 用户的openid
signature string 用sessionkey作为密钥对空字符串签名得到的结果。session_key可通过code2Session接口获得。
sig_method string 签名方法,只支持 hmac_sha256

# 返回参数

属性 类型说明
errcode number 错误码
errmsg string 错误信息
key_info_list array<object> 用户最近三次的加密key列表
属性 类型 说明
encrypt_key string 加密key
version number key的版本号
expire_in number 剩余有效时间
iv string 加密iv
create_time number 创建key的时间戳

# 调用示例

示例说明: HTTPS调用

# 请求数据示例

 GET https://api.weixin.qq.com/wxa/business/getuserencryptkey?access_token=OsAoOMw4niuuVbfSxxxxxxxxxxxxxxxxxxx&signature=fefce01bfba4670c85b228e6ca2b493c90971e7c442f54fc448662eb7cd72509&openid=oGZUI0egBJY1zhBYw2KhdUfwVJJE&sig_method=hmac_sha256  

# 返回数据示例

 { "errcode":0, "errmsg":"ok", "key_info_list": [ { "encrypt_key":"VI6BpyrK9XH4i4AIGe86tg==", "version":10, "expire_in":3597, "iv":"6003f73ec441c386", "create_time":1616572301 }, { "encrypt_key":"aoUGAHltcliiL9f23oTKHA==", "version":9, "expire_in":0, "iv":"7996656384218dbb", "create_time":1616504886 }, { "encrypt_key":"MlZNQNnRQz3zXHHcr6A3mA==", "version":8, "expire_in":0, "iv":"58a1814f88883024", "create_time":1616488061 } ] } 

# 错误码

错误码 错误描述 解决方案
40001 invalid credential  access_token isinvalid or not latest 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口