# 获取手机号

调试工具

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

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

# 接口说明

# 接口英文名

getPhoneNumber

# 功能描述

该接口用于将code换取用户手机号。 说明,每个code只能使用一次,code的有效期为5min。

# 调用方式

# HTTPS 调用


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

# 云调用

  • 出入参和HTTPS调用相同,调用方式可查看云调用说明文档

  • 接口方法为: openapi.phonenumber.getPhoneNumber

# 第三方调用

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

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

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

# 请求参数

属性 类型 必填 说明
access_token string 接口调用凭证,该参数为 URL 参数,非 Body 参数。使用access_token或者authorizer_access_token
code string 手机号获取凭证
openid string

# 返回参数

属性 类型说明
errcode number 错误码
errmsg string 错误信息
phone_info object 用户手机号信息
属性 类型 说明
phoneNumber string 用户绑定的手机号(国外手机号会有区号)
purePhoneNumber string 没有区号的手机号
countryCode string 区号
watermark object 数据水印
属性 类型 说明
timestamp number 用户获取手机号操作的时间戳
appid string 小程序appid

# 调用示例

示例说明: HTTPS请求示例

# 请求数据示例


{
"code": "e31968a7f94cc5ee25fafc2aef2773f0bb8c3937b22520eb8ee345274d00c144"
} 

# 返回数据示例


{
    "errcode":0,
    "errmsg":"ok",
    "phone_info": {
        "phoneNumber":"xxxxxx",
        "purePhoneNumber": "xxxxxx",
        "countryCode": 86,
        "watermark": {
            "timestamp": 1637744274,
            "appid": "xxxx"
        }
    }
} 

# 错误码

错误码 错误描述 解决方案
-1 system error 系统繁忙,此时请开发者稍候再试
40029 code 无效 js_code无效
45011 api minute-quota reach limit  mustslower  retry next minute API 调用太频繁,请稍候再试
40013 invalid appid 请求appid身份与获取code的小程序appid不匹配