Xsolla-logo

通过手机号码开始认证

post/login/phone/request

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

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

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

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

发布商帐户中的登录管理器项目ID。

login_url
string

URL to redirect the user to after account confirmation, successful authentication, two-factor authentication configuration, or password reset confirmation. Must be identical to the Callback URL specified in the URL block of Publisher Account. To find it, go to Login > your Login project and select the Callback URLs section in the upper block of the navigation page. Required if there are several Callback URLs.

payload
string

您的自定义数据。参数的值将在用户JWTpayload声明中返回。

with_logout
string
Default: "0"

显示是否停用现有用户JWT值并激活此调用生成的值。可以是以下值:

  • 1,停用现有值并激活新值;
  • 0,保持现有值的激活状态。
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

确定

404

未找到

422

无法处理的实体

429

请求过多

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