# 获取手机号
接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南
接口英文名：getPhoneNumber
该接口用于将code换取用户手机号。 说明，每个code只能使用一次，code的有效期为5min。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/business/getuserphonenumber?access_token=ACCESS_TOKEN
支持加密请求： 本接口支持服务通信二次加密和签名，可有效防止数据篡改与泄露。查看详情
# 云调用
调用方法：phonenumber.getPhoneNumber
出入参和 HTTPS 调用相同，调用方式可查看 云调用 说明文档
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为：18
服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证，可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| code | string | 是 | 手机号获取凭证 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| phone_info | object | 用户手机号信息 |
# Res.phone_info Object Payload
用户手机号信息
| 参数名 | 类型 | 说明 |
|---|---|---|
| phoneNumber | string | 用户绑定的手机号（国外手机号会有区号） |
| purePhoneNumber | string | 没有区号的手机号 |
| countryCode | string | 区号 |
| watermark | object | 数据水印 |
# Res.phone_info.watermark Object Payload
数据水印
| 参数名 | 类型 | 说明 |
|---|---|---|
| timestamp | number | 用户获取手机号操作的时间戳 |
| appid | string | 小程序appid |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"code": "e31968a7f94cc5ee25fafc2aef2773f0bb8c3937b22520eb8ee345274d00c144"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"phone_info": {
"phoneNumber": "xxxxxx",
"purePhoneNumber": "xxxxxx",
"countryCode": 86,
"watermark": {
"timestamp": 1637744274,
"appid": "xxxx"
}
}
}
# 6. 错误码
以下是本接口的错误码列表，其他错误码可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40013 | invalid appid | 请求appid身份与获取code的小程序appid不匹配 |
| 40029 | code 无效 | js_code无效 |
| 45011 | api minute-quota reach limit mustslower retry next minute | API 调用太频繁，请稍候再试 |
# 7. 适用范围
本接口在不同账号类型下的可调用情况：
| 小程序 | 小游戏 |
|---|---|
| ✔ | ✔ |
- ✔：该账号可调用此接口
- 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口；