接口文档定义模板登录接口说明方法: POST URL: ${base_url}/account/login 通用登录

参数名称	参数类型	必填	说明
clientId	int	是	系统分配的渠道ID

Key	Value
clientId	99999999

参数名称	参数类型	必填	说明
username	string	是	用户名-
password	string	是	密码
channel	string	是	渠道: app web
captchaKey	string	否	图形验证码key
captchaData	string	否	图形验证码
captchaRule	int	是	图形验证码规则: 0——密码错误1次显示就需要验证图形验证码,错误5次后,1小时才能重试 1——密码错误3次显示需要验证图形验证码,错误5次后1小时才能重试 2——密码错误5次后1小时才能重试不会出现验证图形验证码 3——密码错误3次后显示需要图形验证码,错误5次后10分钟后才能重试默认1
countryAbbr	string	否	国家简码，例子：US
language	string	否	语言，例子：en
osType	int	否	用户设备系统，1-Andriod, 2-IOS, 3- Chrome, 4-Safari, 5-Miui（小米），6-Emui(华为) ，7-Amati， 8-Waston
osVersion	string	否	操作系统版本号，例：10.1
equipment	int	否	设备类型：1-TV, 2-Phone, 3-Pad, 4-PC
clientVersion	string	否	客户端版本（比如TCL home App版本号）3.8.1
macAddress	string	否	设备mac地址，设备唯一识别码
deviceId	string	否	TV设备 S/N码
deviceModel	string	否	设备具体型号，iphone12、oppoR7 等

请求内容样例

{
    "username": "test@tcl.com",
    "password": "a754d06aeb760c325cce57394dfb2f93",
    "channel": "app",
    "captchaKey": "5dd0f5532f7f2e19e43dfeef4454b63697d00f8537f7b61f2750efb22acb313ef3a3f0f7aa401242",
    "captchaData": "9591",
    "captchaRule": 0,
    "countryAbbr":"US",
    "language":"en"
}

返回信息

参数名称	参数类型	说明
status	int	状态值: 1-成功其他-失败
msg	string	返回信息内容
token	string	登录令牌
refreshtoken	string	刷新令牌
thirdToken	string	第三方平台令牌
thirdRefreshToken	string	第三方平台刷新令牌
createTime	date	创建时间
user	object	用户信息
loginCallBack	object	回调信息
data	object	综合信息, loginTyp: 2-邮箱 3-手机号, loginAccount: 登录邮箱或手机号

返回信息样例

成功返回

{
    "createTime": 1624875922135,
    "data": {
        "loginAccount": "920713555@qq.com",
        "loginType": 2
    },
    "firstLogin": 0,
    "loginCallBack": {
        "code": "eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE2Mjc0Njc5MjIsImlhdCI6MTYyNDg3NTkyMiwidXNlcm5hbWUiOiI0MjY3MjExNTIifQ.In4ATHiwbLWwEo1GBj2syPloONTBai7xMUgfI0Ct4dCtnnNLY-1r5RVvKMen44mZLcBtzhNPrAIQGkktr-A9by45VCwBpH8gLuXBPouFa1nfzYd8uq5PSZF_3gWyfT4o_RPhBT68SRTyLkLCLmlRSEcyfj6awmh15tUk9zjpbcU",
        "url": "https://account-inn-test.tcljd.com/account/injectSSOInfo"
    },
    "refreshtoken": "eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE2NTU5Nzk5MjIsImlhdCI6MTYyNDg3NTkyMiwicmVmcmVzaFRva2VuIjp7ImlkIjpudWxsLCJ0b2tlbiI6IjQyNjcyMTE1MiIsInJlZnJlc2hDb3VudCI6MCwiZXhwaXJlIjp7ImVwb2NoU2Vjb25kIjoxNjU1OTc5OTIyLCJuYW5vIjo4NzAwMDAwMH19fQ.qfmQClu2sEx5-Js88zE8o7JnuMTPJPxwmz-CSjvh_1v1YQivDKQoatXgc5Yc2EtgIJAVZqXuoqVrr9_k77g1pBb-smoZuJtrx_tJYXcNpOlY_p7V7WtB7ikhELZSUh3cWUR28TQy9s-Z-uTIFGiPienlRt7NGNpsnIAU6Svb3-Y",
    "status": 1,
    "token": "eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE2Mjc0Njc5MjIsImlhdCI6MTYyNDg3NTkyMiwidXNlcm5hbWUiOiI0MjY3MjExNTIifQ.In4ATHiwbLWwEo1GBj2syPloONTBai7xMUgfI0Ct4dCtnnNLY-1r5RVvKMen44mZLcBtzhNPrAIQGkktr-A9by45VCwBpH8gLuXBPouFa1nfzYd8uq5PSZF_3gWyfT4o_RPhBT68SRTyLkLCLmlRSEcyfj6awmh15tUk9zjpbcU",
    "user": {
        "birthday": "1995-12-31",
        "clientId": 99999999,
        "countryAbbr": "IN",
        "createTime": 1624875723000,
        "crossRegion": false,
        "deviceType": "1234455",
        "email": "920713555@qq.com",
        "firstName": "Jack",
        "headpic": "https://dslpobk9b92aq.cloudfront.net/pic/default",
        "id": 943,
        "identity": 1,
        "isprivate": 0,
        "lastName": "Li",
        "loatLoginIp": 0,
        "modifyStatus": 0,
        "nickname": "Jack Li",
        "operateStatus": 0,
        "osType": 0,
        "phoneAbbr": "86",
        "platform": 102,
        "protocol": 1,
        "region": "IN",
        "secure": 0,
        "source": 0,
        "status": 2,
        "tclid": "tclid_426721152",
        "type": 2,
        "updateTime": 1624875723000,
        "username": "426721152"
    }
}

失败返回 - 非法用户名

{
    "createTime": 1573120602242,
    "msg": "Username is invalid",
    "status": 3
}

失败返回 - 密码错误

{
    "createTime": 1573120661378,
    "msg": "Wrong password",
    "status": -1
}

失败返回 - 密码错误次数到达限制

{
    "createTime": 1573120819183,
    "data": {
        "key": "3a3a8bc1a98897282cef621fca5988f2bdcda23f766563699b37906046a6223435f86bb4089f1d6c",
        "url": "http://relay-test.ua.tclo2o.cn/region1/common/getCaptchaPic?key=3a3a8bc1a98897282cef621fca5988f2bdcda23f766563699b37906046a6223435f86bb4089f1d6c"
    },
    "msg": "Captcha code is needed",
    "status": -4
}

失败返回 - 用户已被删除

{
    "msg": "User has been deleted",
    "status": 99
}

状态码说明

status	msg	comment
-4	Captcha code is needed	用户上次登录密码错误，本次登录需要显示图形验证码
-1	Login failed	登录失败，服务端错误
-1	-1	密码错误，错误一次
-1	-11	密码错误，错误两次
-1	-111	密码错误，错误三次
-1	-1111	密码错误，错误四次
-1	-11111	密码错误，错误五次
1	success	登录成功
3	Username is invalid	用户名不存在
4	Error login attempts reach max limit	用户24小时内密码错误次数超过5次，captchaRule：0,1，2，锁定1小时，3-锁定十分钟
5	Amounts of verification code validation errors	获取登录验证码次数已超过限制
45	Invalid email or phone	电话号码或邮箱地址不合法
99	User has been deleted	用户账号已被删除
110	Verification code wrong	验证码错误
112		用户不存在
-5	Captcha code is wrong	图形校验码错误
202	Captcha code is expired	图形校验码失效

接口文档定义模板

登录

接口说明

请求参数（URL参数）

请求参数样例

请求内容（Body）

请求内容样例

返回信息

返回信息样例

状态码说明