支付宝小程序获取用户手机号

Question

记录下支付宝小程序获取会员手机号的踩坑过程。

使用限制

• 基础库 1.16.4 或更高版本；支付宝客户端 10.1.35 或更高版本，若版本较低，建议采取兼容处理。
• 此 API 暂仅支持企业支付宝账户使用。
• IDE 模拟器暂不支持调试，请以真机调试结果为准。
• 目前该功能需要在开发者后台完成敏感信息申请才可以使用此功能，入口为开发管理 > 功能列表 > 添加功能 > 获取会员手机号 > 用户信息申请，此功能需谨慎使用，若支付宝发现信息存在超出约定范围使用或者不合理使用等情况，支付宝有权永久回收该小程序的该接口权限。
• 需要将 <button> 组件 open-type 的值设置为 getAuthorize，当用户点击并同意之后，可以通过 my.getPhoneNumber() 接口获取到支付宝服务器返回的加密数据， 然后在第三方服务端结合签名算法和 AES 密钥进行解密获取手机号，方法详见敏感信息加解密方法，若用户未授权，直接调用my.getPhoneNumber() 接口，则无法返回正确信息。

配置工作

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

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

前端工作

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

<button
  open-type="getAuthorize"
  scope="phoneNumber"
  onGetAuthorize="getPhoneNumber"
  onError="getPhoneNumberError"
>
  获取手机号码
</button>

Page({
  /**
   * 获取手机号码，用户点击并同意回调函数
   *
   * @param {object} e 授权成功回调信息 { type: 'getAuthorize', target, currentTarget, timeStamp }
   */
  async getPhoneNumber(e) {
    my.getPhoneNumber({
      success: res => {
        // 获取到支付宝服务器返回的加密数据
        // 其中 response 为 JSON 字符串，结构为：'{"response":"xxxxx","sign":"xxx"}'
        const { respone, ariverRpcTraceId } = res

        // 将加密数据传给后端，结合签名算法和AES密钥进行解密获取手机号
        my.request({
          url: '后端服务端 URL',
          data: respone,
          success: res => {
            // 解密成功返回
          },
          fail: err => {
            console.warn('my.request fail: ', err)
          }
        })
      },
      fail: err => {
        console.warn('my.getPhoneNumber fail: ', err)
      }
    })
  },

  /**
   * 获取手机号异常，包括用户拒绝和系统异常
   * @param {object} e 授权失败回调信息
   */
  getPhoneNumberError(e) {
    console.warn('getPhoneNumberError fail: ', e)
    // 异常信息如下：
    // {
    //   type: 'error',
    //   timeStamp: 1610937854940,
    //   target: {
    //     targetDataset: {},
    //     tagName: 'button',
    //     dataset: {}
    //   },
    //   currentTarget: {
    //     tagName: 'button',
    //     dataset: {}
    //   },
    //   detail: {
    //     errorMessage: '用户取消授权',
    //     type: 'getAuthorize'
    //   }
    // }
  }
})

后端解密

由于对后端不是很了解，具体看内容加密指引。

常见问题

调用 my.getPhoneNumber()，报错 isv.insufficient-isv-permissions（ISV 权限不足）。

{
  "code":"40006",
  "msg":"Insufficient Permissions",
  "subCode":"isv.insufficient-isv-permissions",
  "subMsg":"ISV权限不足，建议在开发者中心检查对应功能是否已经添加，解决办法详见：https://docs.open.alipay.com/common/isverror"
}

原因可能是，没有添加 获取会员手机号 功能包或者没有 申请用户信息。

解决方法：

1. 在小程序开发管理后台的能力列表中，点击添加能力；
2. 添加获取会员手机号功能包；
3. 点击用户信息申请；（这一步不能忽略）
4. 在申请权限中申请用户手机号；
5. 填写申请原因、使用场景等信息，提交申请，等待审核。

关于添加了相关能力之后，没有 用户信息申请 的入口，可以看这里。我就遇到过这个坑，是小程序一些基础信息未设置，完善信息保存之后，入口就出来了。

相关链接

• my.getPhoneNumber API
• 获取会员手机号 FAQ
• 获取会员手机号
• 用户信息申请入口不显示