• 下载
  • 社区

my.getPhoneNumber

版本要求基础库 1.16.4 或更高版本;支付宝客户端 10.1.35 或更高版本,若版本较低,建议做 兼容处理


获取支付宝用户绑定的手机号。因为需要用户主动触发才能发起获取手机号,所以该功能不由 API 直接调用,需用 button 组件 的点击来触发。

相关问题请参见 获取会员手机号 FAQ


注意:目前该功能需要在开发者后台完成敏感信息申请才可以使用此功能,入口为 开发管理 > 功能列表 > 添加功能  > 获取会员手机号 > 用户信息申请,此功能需谨慎使用,若支付宝发现信息存在超出约定范围使用或者不合理使用等情况,支付宝有权永久回收该小程序的该接口权限。


使用注意

需要将 <button> 组件 open-type 的值设置为 getAuthorize,当用户点击并同意之后,可以通过my.getPhoneNumber() 接口获取到支付宝服务器返回的加密数据, 然后在第三方服务端结合签名算法和AES密钥进行解密获取手机号,方法详见 敏感信息加解密方法,若用户未授权,直接调用my.getPhoneNumber() 接口,则无法返回正确信息。


示例代码

唤起授权框,推荐兼容方案。

<button a:if="{{canIUseAuthButton}}" open-type="getAuthorize"
        onGetAuthorize="onGetAuthorize" onError="onAuthError" scope='phoneNumber'>
    授权手机号
</button>

Button属性说明

属性说明
open-typegetAuthorize 为授权组件。
scopephoneNumber
onGetAuthorize授权成功回调(在回调里可以调用获取信息的接口)。
onError授权失败回调(包括用户拒绝和系统异常)。

用户点击同意后,即可通过my.getPhoneNumber()获取用户绑定的手机号。

my.getPhoneNumber({
    success: (res) => {
        let encryptedData = res.response;
        my.request({
            url: '你的后端服务端',
            data: encryptedData,
        });
    },
    fail: (res) => {
        console.log(res);
        console.log('getPhoneNumber_fail');
    },
});


返回结果说明

res.response 为完整的报文数据,前端需要将该报文发送到开发者服务端做验签和解密处理(详细的服务端处理流程参考 敏感信息加解密方法),服务端解密后的明文示例如下:


正常响应

{
  "code": "10000",
  "msg": "Success",
  "mobile": "1597671905"
}

异常响应

{
  "code": "40003",
  "msg": "Insufficient Conditions",
  "subCode": "isv.invalid-auth-relations",
  "subMsg": "无效的授权关系"
}
{
  "code": "20000",
  "msg": "Service Currently Unavailable",
  "subCode": "aop.unknow-error",
  "subMsg": "系统繁忙"
}
{
  "code": "40001",
  "msg": "Missing Required Arguments",
  "subCode": "isv.missing-default-signature-type",
  "subMsg": "应用未设置默认签名类型"
}
// 解决方案:重新保存下开发者的密钥,或者设置下小程序的应用网关地址
{
  "code": "40002",
  "msg": "Invalid Arguments",
  "subCode": "isv.invalid-encrypt",
  "subMsg": "加密异常"
}
// 解决方案:按文档重新设置AES密钥


故障排查

调用 my.getPhoneNumber 获取手机号报错时,请检查以下配置内容:


  • 请检查小程序后台已添加 获取会员手机号 功能包,并已在 隐私内容申请 中 申请手机号(若在小程序后台看不到敏感信息申请的入口,请使用主账号登录)。申请路径为:小程序后台 > 开发管理 > 功能列表添加功能 > 获取会员手机号 > 敏感信息申请。


  • 请确保小程序添加了 JSAPI 基础包 (否则会报无权限)。


  • 请确保前端 AXML 中按照 button 授权方式,先获取用户授权然后使用 my.getPhoneNumber 进行获取(否则会报无效的授权关系)。
<button a:if="{{canIUseAuthButton}}" open-type="getAuthorize" onGetAuthorize="onGetAuthorize" onError="onAuthError" scope='phoneNumber'>    授权手机号</button>


  • 请确保已在 小程序后台 > 设置 > 开发设置 中,设置 支付宝公钥aes 秘钥应用网关,aes 相关信息可参见 内容加密接入指引。(若缺失这三个设置,在调用 my.getPhoneNumber 时可能只返回 response 不会返回sign)。