Skip to main content

SignIn

The signIn API is used for a player to log in to LI PASS through their account and password.

Request Parameter

ParameterTypeDescriptionRemark
accountstringAccount
Email or phone number (currently not supported)
Required
account_typenumberAccount type
1: Email
2: Phone number (currently not supported)
Required
passwordstringPassword. For more information, see Password Rules.Required
phone_area_codestringPhone area codeRequired when account_type is 2
machine_check_typenumberCAPTCHA type
3: Tencent Captcha
Required when CAPTCHA is configured on Player Network
tencent_responsestringTencent Captcha response value
Converts the value to string, for example, JSON.stringify({"appid":"xxx","ret":0, "ticket":"t030...ECE*","randstr":"@BHo"}).
Required when machine_check_type is 3

Request Sample

accountApi.signIn(
{
account: 'xxx@gmail.com',
account_type: 1,
password: 'xxx',
}
).then((res) => {
console.log(res);
});

Response Parameter

ParameterTypeDescription
retnumberReturn code
0: Request success, parse related returned field information.
!=0: Request failure, check msg for the detailed return message.
msgstringReturn message
tokenstringPlayer Network SDK user authorization token
uidstringLI PASS UID
seqstringSequence number of the message in the data stream
expireint64Expiration time of the token
Unix time

Response Sample

{
expire: 1638490279
msg: "Success",
ret: 0,
seq: "1638190279-0180225865-002725-0000290492",
token: "xxx",
uid: "xxx",
}