一、使用场景
·允许用户通过手机号进行登录,简化用户登录流程。
·开发者需要通过手机号验证当前用户身份或绑定账号。
二、交互表现
·PC 端:会弹出获取手机号弹窗,弹窗提示字段允许开发者自定义。
·移动端:会弹出获取手机号弹窗,弹窗提示字段允许开发者自定义。
三、步骤2:通过 JSAPI 获取手机号动态 Code
·接口名:data.getPhoneNumber
·描述:用于获取手机号的动态令牌。
·支持客户端:iOS、Android、Windows、Mac。
·支持的版本:3.11.0版本以上。
·是否需要鉴权:需要,需开启权限:获取用户的手机号。
四、参数说明
输入参数
| 参数名称 | 参数类型 | 参数描述 |
| success | Function | 授权成功回调函数。 |
| fail | Function | 授权失败回调函数。 |
输出参数
| 参数名称 | 参数类型 | 参数描述 |
| code | Int | 错误码。 |
| message | String | 错误信息。 |
| token | String | 动态令牌,可通过 RestApi 接口换取用户手机号;有效期5min,只能消费一次。 |
code success := 0 成功cancel := 1 取消message success := "success" 成功cancel := "get auto_code is canceled" 取消
示例
import * as wemeet from '@tencent/wemeet-js-sdk';wemeet.data.getPhoneNumber({success: ({ code, message, token }) => {// handler},fail: ({ code, message }) => {// handler},}).catch(e => console.error(e));
五、步骤3:RestAPI 通过手机号动态 Code 换取手机号
·描述: 通过 RestAPI,使用 token 向后台换取手机号。
·调用方式: GET
·接口请求域名:
https://api.meeting.qq.com/v1/user/info/phonenumber
六、输入参数
HTTP 请求头公共参数参见:第三方应用鉴权(OAuth2.0)。
| 参数名称 | 是否必填 | 参数类型 | 参数描述 |
| token | 是 | String | 动态令牌,可通过 JS-API 接口获取;有效期5min,只能消费一次。 |
七、输出参数
| 参数名称 | 参数类型 | 参数描述 |
| phone_info | Object | 电话号码相关信息。 |
phone_info
| 参数名称 | 参数类型 | 参数描述 |
| phone_number | String | 用户的手机号。 |
| country_code | String | 手机号区号。 |
八、错误码
| 错误码 | 说明 |
| 3501 | 未开启获取授权手机号的权限点。 |
| 3502 | 获取授权手机号服务异常。 |
| 3506 | 超过获取授权手机号动态令牌的最大频率。 |
| 3507 | 授权手机号的动态令牌非法。 |