为了更安全的网络访问,请务必使用TLS1.2协议及规定内的加密套件。若使用协议是TLS1.0、TLS1.1或规定外的加密套件,可能无法正常访问华为账号服务。
关于TLS1.2协议及规定内加密套件的信息,可以点击这里进行详细了解:TLS协议及加密套件。
华为账号一键登录(获取手机号和UnionID/OpenID)场景,应用服务端向华为账号服务器调用该接口获取UnionID,OpenID,华为账号绑定的手机号码及其相关信息。该服务仅对中国境内(香港特别行政区、澳门特别行政区、中国台湾除外)用户提供。
需确保调用端网络正常。
华为账号一键登录服务仅对中国境内(香港特别行政区、澳门特别行政区、中国台湾除外)用户提供。
应用使用华为账号一键登录功能之前,需要完成华为账号一键登录权限申请,详见申请账号权限。
承载协议: HTTPS POST
接口方向: 开发者服务器->华为账号服务器
接口URL: https://account-api.cloud.huawei.com/oauth2/v6/quickLogin/getPhoneNumber
数据格式:
请求消息:Content-Type: application/json
响应消息:Content-Type: application/json
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 取值为:application/json。 说明: Request Body传参,请务必遵循此请求头格式,否则可能导致请求失败,具体传参方式可参考示例代码。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| code | 是 | String | 通过华为账号一键登录(获取手机号和UnionID/OpenID)场景获取的Authorization Code,详情可参考一键登录客户端开发。 |
| clientId | 是 | String | 在创建应用后,由HarmonyOS 开发者中心为应用分配的唯一标识。参数取值详见查看应用信息中的OAuth 2.0客户端ID(凭据)-Client ID参数。 说明: 该参数与获取code参数时的Client ID必须一致,否则会报错(响应消息中resultCode=60180003),如出现此报错,请参考配置Client ID排查处理。 |
| clientSecret | 是 | String | 在创建应用后,由HarmonyOS 开发者中心为应用分配的密钥(Client Secret)。参数取值详见查看应用信息中的OAuth 2.0客户端ID(凭据)-Client Secret参数。 |
请通过POST方式调用,示例如下:
POST /oauth2/v6/quickLogin/getPhoneNumber HTTP/1.1
Host: account-api.cloud.huawei.com
Content-Type: application/json
{"code":"<code>","clientId": "<clientId>","clientSecret": "<clientSecret>"} 调用成功时,响应消息返回如下:
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| openId | 是 | String | 用户OpenID。具体格式要求请参考OpenID和UnionID的格式说明。 |
| unionId | 是 | String | 用户UnionID。具体格式要求请参考OpenID和UnionID的格式说明。 |
| phoneNumber | 是 | String | 华为账号绑定号码(含国家码),使用该手机号完成一键登录的功能,详见华为账号一键登录(获取手机号和UnionID/OpenID)。 |
| phoneNumberValid | 是 | Integer | 通过一键登录功能获取的华为账号绑定号码的实时有效性。 若发起一键登录时LoginPanelParams的verifyPhoneNumber参数值传递为true,表示华为代为验证手机号有效性,开发者无需关注此返回值; 若verifyPhoneNumber参数值传递为false,需要根据返回的状态值进行处理。 0:在过去90天内,无法证明当前手机号码可以触达用户, 需要进行验证。 1:在过去90天内,当前手机号码被证明可以触达用户,可以直接使用。 |
| purePhoneNumber | 是 | String | 不带国家码的手机号,此处为phoneNumber去除国际冠码与国际电话区号的形式。 |
| phoneCountryCode | 是 | String | purePhoneNumber的国际冠码(00)+国际电话区号。 |
调用失败时,响应消息返回如下:
| 参数 | 参数类型 | 描述 |
|---|---|---|
| resultCode | int | 错误码,详见本章节错误码。 |
| resultDesc | String | 错误描述信息。 |
HTTP/1.1 200 OK
Content-Type: application/json
{
"openId": "AQAxrBzThFv*****lv9tV_4rMCc",
"unionId": "AQAxrB1HNA*****n-IfWRSUVq2M7xU",
// 华为账号绑定号码,使用该手机号完成一键登录(返回数据实际为明文)
"phoneNumber": "0086191******08",
// 通过一键登录功能获取的华为账号绑定号码的实时有效性,0表示需要进一步验证有效性,1表示可以直接使用
"phoneNumberValid": 1,
// 不带国际冠码与国际电话区号的形式(返回数据实际为明文)
"purePhoneNumber": "191******08",
"phoneCountryCode": "0086"
} HTTP/1.1 200 OK
Content-Type: application/json
{
"resultCode": 60180008,
"resultDesc": "user or phone number not exist"
} Java示例代码如下,运行前需要进行示例代码环境配置(请将此示例代码与工具类CallUtils放于同一路径下,如不在同一路径,请手动添加import)
import com.alibaba.fastjson2.JSONObject;
import org.apache.http.client.methods.HttpPost;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
/**
* 一键登录获取华为账号绑定号码和OpenID/UnionID
*/
public class GetQuickLoginMobilePhoneByCodeDemo {
public static void main(String[] args) throws IOException {
// 一键登录获取华为账号绑定号码和OpenID/UnionID的接口URL
String url = "https://account-api.cloud.huawei.com/oauth2/v6/quickLogin/getPhoneNumber";
// 替换为一键登录场景获取到的Authorization Code
String authorizationCode = "<Authorization Code>";
// 替换为一键登录场景获取Authorization Code时使用的Client ID
String clientId = "<Client ID>";
// 替换为Client ID对应的Client Secret
String clientSecret = "<Client Secret>";
JSONObject result = getQuickLoginMobile(url, authorizationCode, clientId, clientSecret);
// 解析获取openId
String openId = result.getString("openId");
// 解析获取unionId
String unionId = result.getString("unionId");
// 解析获取phoneNumber
String phoneNumber = result.getString("phoneNumber");
// 解析获取phoneNumberValid
Integer phoneNumberValid = result.getInteger("phoneNumberValid");
// 解析获取purePhoneNumber
String purePhoneNumber = result.getString("purePhoneNumber");
// 解析获取phoneCountryCode
String phoneCountryCode = result.getString("phoneCountryCode");
}
private static JSONObject getQuickLoginMobile(
String url, String authorizationCode, String clientId, String clientSecret) throws IOException {
HttpPost httpPost = new HttpPost(url);
Map<String, Object> reqBody = new HashMap<>();
reqBody.put("code", authorizationCode);
reqBody.put("clientId", clientId);
reqBody.put("clientSecret", clientSecret);
httpPost.setHeader("Content-Type", "application/json");
httpPost.setEntity(CallUtils.wrapJsonEntity(reqBody));
// 如需要自定义异常处理请使用api CallUtils#remoteCall(HttpUriRequest, BiFunction<CloseableHttpResponse,String,E>)
return CallUtils.toJsonObject(CallUtils.remoteCallAccountApi(httpPost));
}
} | HTTP响应码 | 描述 | 解决方法 |
|---|---|---|
| 200 | 仅表示本次接口调用成功,实际业务处理结果需要通过Response Body中的resultCode(错误码) 进行判断。 | - |
| 400 | 参数错误。 | 请根据文档排查请求参数是否符合规范。 |
| 403 | 无权限访问。 | 通常是调用方网络安全策略阻止了访问,请检查网络环境配置。若仍无法解决,请通过在线提单提交问题。 |
| 404 | 找不到服务。 | 请检查请求URI是否正确。 |
| 405 | 不支持的http请求method。 | 请检查http请求method是否与接口说明一致。 |
| 500 | 服务内部错误。 | 请通过在线提单提交问题。 |
| 502 | 请求连接异常,常见于网络状况不稳定。 | 建议稍后重试,若仍无法解决,请通过在线提单提交问题。 |
| 503 | 系统流控。 | 触发系统流控,请稍后重试。 |
| 504 | 请求连接超时,常见于网络状况不稳定。 | 建议稍后重试,若仍无法解决,请通过在线提单提交问题。 |
| 590 | 服务内部错误。 | 请通过在线提单提交问题。 |
| 错误码 | 描述 | 解决方法 |
|---|---|---|
| 60010002 | 参数不合法。 | 请按照错误描述及接口Request Body参数说明检查入参。 |
| 60010012 | code参数不正确。 | code参数传值不正确,可能原因:伪造的无效code或code被篡改。 |
| 60010013 | clientSecret参数不正确。 | clientSecret参数传值不正确,参数取值详见查看应用信息中的OAuth 2.0客户端ID(凭据)-Client Secret参数。 |
| 60180003 | code解析得到的Client ID与入参clientId不一致。 | code参数获取时的clientId与当前接口参数clientId不一致导致,请检查入参clientId是否与配置Client ID中的值一致。 |
| 60180004 | code过期,code只有5分钟有效期,超过有效期后将无法继续使用。 | 请引导用户重新授权,获取新的code再重试。 |
| 60180005 | code已经被使用过。 | code只能用一次,请重新获取code再重试。 |
| 60180006 | code已失效。正常code有效期为5分钟,但是由于用户的行为(如更改密码、取消应用的授权等行为),导致华为服务器提前失效已颁发的code。 | 请引导用户重新授权,获取新的code再重试。 |
| 60180007 | code未授权华为账号一键登录权限。 | code未授权华为账号一键登录权限,可能原因如下: - 在进行华为账号一键登录客户端功能开发时,登录按钮的LoginWithHuaweiIDButtonParams.loginType属性未设置为LoginType.QUICK_LOGIN。 - 客户端传给服务器的Authorization Code,是通过华为账号一键登录预取号阶段获取到的Authorization Code。 - 客户端传给服务器的Authorization Code,不是华为账号一键登录场景获取到的。 以上可能原因的解决方法,请参考60180007 服务端通过Authorization Code无法获取到华为账号一键登录手机号如何解决。 |
| 60180008 | 用户无手机号。 | 用户华为账号未绑定手机号,该异常场景应用需要展示其他登录方式。 |
| 60180009 | 手机号信息获取受限。 | 华为账号一键登录服务仅对中国境内(香港特别行政区、澳门特别行政区、中国台湾除外)用户提供。 |
| 60010001 | 系统内部错误。 | 请稍后重试,若仍无法解决,请通过在线提单提交问题。 |