Xsolla-logo

通过手机号码开始认证

post/oauth2/login/phone/request

通过用户手机号和验证码开始认证并将验证码发送至其手机号码。验证码有效期为3分钟。

此调用仅可与通过手机号码完成认证调用一起使用。

使用此调用的工作流如下:

  1. 应用程序打开一个认证表单,以便用户可以输入其手机号码。
  2. 用户输入其手机号码。
  3. 应用程序将此请求发送给艾克索拉登录管理器服务器: a. 如果参数send_linktrue,则在此请求之后,您应该发送获取验证码请求,使短信包含验证码和链接。 b. 如果参数send_linkfalse或未传入,则短信将仅包含验证码。
  4. 艾克索拉登录管理器服务器发送短信并返回验证码的ID。
  5. 应用程序显示一个字段,以便用户可以填写验证码。
  6. 用户输入收到的验证码或点击链接。
  7. 应用程序将通过手机号码完成认证请求连同收到的ID发送给艾克索拉登录管理器服务器。
  8. 用户被视为已授权。
Request
query Parameters
response_type
required
string

启用了OAuth 2.0协议项目中使用的授权类型。必须是code才能在响应中获取用户认证代码。必须通过生成JWT调用将收到的代码交换给JWT以完成用户认证。

client_id
required
integer

您的应用程序ID。在创建OAuth 2.0客户端后获取。

state
required
string

用于额外用户验证的值。通常用于抵御CSRF攻击。该值将在响应中返回。必须长于8个符号。

scope
string

范围是OAuth 2.0中的一种机制,用于限制应用程序对用户帐户的访问。

可以是:

  • offline,使用来自生成JWT调用的refresh_token以在JWT过期时刷新。
  • playfab,将SessionTicket写入JWT的session_ticket声明(如果您在PlayFab中存储用户数据)。

如果您处理上面未提及的自己的scope参数值,则可以在使用此调用时设置它们。艾克索拉登录管理器服务器不处理这些值,而是在收到的JWT中返回它们。

redirect_uri
string

在帐户确认、成功认证或密码重置确认后将用户重定向到的URL。要设置此参数,请联系您的帐户经理。

注:如果项目设置中有多个重定向URI,则该参数为必需。
Request Body schema: application/json
phone_number
required
string^\+(\d){5,25}$

用户手机号码。

link_url
string <uri>

将用户重定向到状态认证页面的URL。如果参数send_linktrue,则为必需

send_link
boolean

显示发送的验证码短信中是否包含链接。

可以使用链接代替验证码登录。

如果参数值为true,则链接包含在短信中发送。

Responses
200

确定

400

错误的请求

404

未找到

422

无法处理的实体

429

请求过多

Request samples
application/json
{}
Response samples
application/json
{
  • "operation_id": "string"
}