通过手机号码开始认证

post/login/phone/request

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

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

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

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

Request

projectId required	string <uuid> 发布商帐户中的登录管理器项目ID。
login_url	string 在帐户确认、成功认证、双因素认证配置或密码重置确认后将用户重定向到的URL。必须与发布商帐户URL部分中指定的回调URL相同。要找到它，请前往登录管理器 > 您的登录管理器项目，在导航页的顶部区块中选择回调部分。如果有多个回调URL，此参数为必需。
payload	string Your custom data. The value of the parameter will be returned in the `payload` claim of the user JWT. Recommended maximum length less than 500 characters. Note, that this parameter is only available if you use a custom user data storage.
with_logout	string Default: "0" 显示是否停用现有用户JWT值并激活此调用生成的值。可以是以下值： `1`，停用现有值并激活新值； `0`，保持现有值的激活状态。

phone_number required	string^\+(\d){5,25}$ 用户手机号码。
link_url	string <uri> 将用户重定向到状态认证页面的URL。如果参数`send_link`为`true`，则为必需。
send_link	boolean 显示发送的验证码短信中是否包含链接。可以使用链接代替验证码登录。如果参数值为`true`，则链接包含在短信中发送。

Responses

200

确定

404

未找到

422

无法处理的实体

429

请求过多

Request samples

application/json

{"link_url": "http://example.com",
"phone_number": "string",
"send_link": true
}

Response samples

application/json

{"operation_id": "string"
}