微信
获取微信 openId
获取用户的微信 openId。
- URL:
/app-api/weChat/getWxOpenId/{code} - Method:
GET - 需要登录:是
- 需要鉴权:是
请求参数
| 参数 | 类型 | 约束 | 说明 |
|---|---|---|---|
| code | String | 必传 | 微信 code 值(路径参数) |
请求示例
GET /app-api/weChat/getWxOpenId/123456
响应示例
{
"code": 0,
"data": {
"openId": null,
"sessionKey": null,
"memberUserRespDTO": null
},
"msg": ""
}
响应说明
| 参数 | 类型 | 说明 |
|---|---|---|
| openId | String | 微信 openId |
| sessionKey | String | 微信 sessionKey |
| memberUserRespDTO | Object | 用户信息 |
| memberUserRespDTO.id | Long | 用户ID |
| memberUserRespDTO.nickname | String | 昵称 |
| memberUserRespDTO.name | String | 真实姓名 |
| memberUserRespDTO.status | Integer | 状态,0-开启,1-关闭 |
| memberUserRespDTO.avatar | String | 头像 |
| memberUserRespDTO.mobile | String | 手机号 |
获取微信 AccessToken
获取微信接口调用凭证。
- URL:
/app-api/weChat/getAccessToken - Method:
GET - 需要登录:是
- 需要鉴权:是
请求参数
无请求参数。
请求示例
GET /app-api/weChat/getAccessToken
响应示例
{
"code": 200,
"data": {
"accessToken": "80_mPSnmJZ9lPt7w...",
"expiresIn": 7200
},
"msg": ""
}
响应说明
| 参数 | 类型 | 说明 |
|---|---|---|
| accessToken | String | token 值 |
| expiresIn | Long | 过期时间(秒) |
说明
该接口用于获取 token,一般可不用显式调用。获取手机号接口内部已实现获取 token 的逻辑,会直接返回手机号信息。
获取微信用户手机号
通过微信授权获取用户手机号。
- URL:
/app-api/weChat/getUserPhoneNum - Method:
POST - 需要登录:是
- 需要鉴权:是
请求参数
| 参数 | 类型 | 约束 | 说明 |
|---|---|---|---|
| code | String | 必 传 | 手机号获取凭证 |
| openId | String | 非必传 | 微信 openId |
| accessToken | String | 非必传 | 访问 token,接口内部已实现获取 token 的逻辑 |
请求示例
{
"code": "xxxx"
}
说明
入参只需传 code 一个参数即可。
响应示例
{
"code": 200,
"data": {
"phoneNumber": "xxxxxx",
"purePhoneNumber": "xxxxxx",
"countryCode": 86,
"watermark": {
"timestamp": 1637744274,
"appid": "xxxx"
}
},
"msg": ""
}
响应说明
| 参数 | 类型 | 说明 |
|---|---|---|
| phoneNumber | String | 用户绑定的手机号(国外手机号会有区号) |
| purePhoneNumber | String | 没有区号的手机号 |
| countryCode | Integer | 区号 |
| watermark | Object | 数据水印 |
| watermark.timestamp | Long | 用户获取手机号操作的时间戳 |
| watermark.appid | String | 小程序 appid |