跳到主要内容

微信

获取微信 openId

获取用户的微信 openId。

  • URL/app-api/weChat/getWxOpenId/{code}
  • MethodGET
  • 需要登录:是
  • 需要鉴权:是

请求参数

参数类型约束说明
codeString必传微信 code 值(路径参数)

请求示例

GET /app-api/weChat/getWxOpenId/123456

响应示例

{
"code": 0,
"data": {
"openId": null,
"sessionKey": null,
"memberUserRespDTO": null
},
"msg": ""
}

响应说明

参数类型说明
openIdString微信 openId
sessionKeyString微信 sessionKey
memberUserRespDTOObject用户信息
memberUserRespDTO.idLong用户ID
memberUserRespDTO.nicknameString昵称
memberUserRespDTO.nameString真实姓名
memberUserRespDTO.statusInteger状态,0-开启,1-关闭
memberUserRespDTO.avatarString头像
memberUserRespDTO.mobileString手机号

获取微信 AccessToken

获取微信接口调用凭证。

  • URL/app-api/weChat/getAccessToken
  • MethodGET
  • 需要登录:是
  • 需要鉴权:是

请求参数

无请求参数。

请求示例

GET /app-api/weChat/getAccessToken

响应示例

{
"code": 200,
"data": {
"accessToken": "80_mPSnmJZ9lPt7w...",
"expiresIn": 7200
},
"msg": ""
}

响应说明

参数类型说明
accessTokenStringtoken 值
expiresInLong过期时间(秒)
说明

该接口用于获取 token,一般可不用显式调用。获取手机号接口内部已实现获取 token 的逻辑,会直接返回手机号信息。


获取微信用户手机号

通过微信授权获取用户手机号。

  • URL/app-api/weChat/getUserPhoneNum
  • MethodPOST
  • 需要登录:是
  • 需要鉴权:是

请求参数

参数类型约束说明
codeString必传手机号获取凭证
openIdString非必传微信 openId
accessTokenString非必传访问 token,接口内部已实现获取 token 的逻辑

请求示例

{
"code": "xxxx"
}
说明

入参只需传 code 一个参数即可。

响应示例

{
"code": 200,
"data": {
"phoneNumber": "xxxxxx",
"purePhoneNumber": "xxxxxx",
"countryCode": 86,
"watermark": {
"timestamp": 1637744274,
"appid": "xxxx"
}
},
"msg": ""
}

响应说明

参数类型说明
phoneNumberString用户绑定的手机号(国外手机号会有区号)
purePhoneNumberString没有区号的手机号
countryCodeInteger区号
watermarkObject数据水印
watermark.timestampLong用户获取手机号操作的时间戳
watermark.appidString小程序 appid