账号信息查询
账号信息查询接口,为用户提供了查询全时用户ID的一些方法。用户可以根据登录名称、邮箱或者电话信息,来查询在全时系统中所对应用户ID。注意,此用户ID在调用其他接口时会作为必填参数
根据登陆名称查询
1. 接口描述
接口名称:
/eventopenapi/user/loginName
发送方式:
POST
参数格式:
accept: application/json;content-type: application/json
2. 输入参数
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
token | String | 否 | 统一鉴权token 支持非token查询(需要在http header提供AppKey, Nonce, CurTime, CheckSum ) |
loginName | String | 是 | 账号登陆名称(只查询已认证的用户) |
Http Headers
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
AppKey | String | 是 | 开发者平台分配的AppKey |
Nonce | String | 是 | 随机数(随机数,最大长度128个字符) |
CurTime | String | 是 | 当前UTC时间戳,从1970年1月1日0点0分0秒开始到现在的毫秒数 |
CheckSum | String | 是 | 服务器认证需要,16进制字符小写SHA1(AppSecret+Nonce+CurTime) |
3. 输出参数
参数 | 类型 | 说明 |
---|---|---|
timeStamp | Long | 返回时间(时间戳,单位毫秒) |
requestId | String | 请求ID(在接口异常时, 需提供请求ID) |
code | Int | 返回的状态码 |
msg | String | 当返回结果的状态码不为200时,包含的错误信息 |
data | Json | 返回数据 |
data 参数说明
参数 | 类型 | 说明 |
---|---|---|
userId | Long | 用户ID |
loginName | String | 登录名 |
String | 邮箱 | |
countryCode | String | 国家码 |
mobile | String | 手机 |
customerCode | String | 客户编码 |
customerName | String | 客户名称 |
displayName | String | 显示名称 |
firstName | String | 首部名称 |
middleName | String | 中间名称 |
lastName | String | 尾部名称 |
userStatus | Int | 用户状态 0:离职或禁用; 1:已激活; 3:已删除 |
productStatus | Int | 产品类型 0: 未知状态 1: 已开通 2: 未开通 默认为0 |
accountType | Int | 账号类型 0: 个人账号(个人站点或电商站点下的账号); 1: 企业账号(非个人站点、电商站点的账号) |
products | Array | 产品列表 |
products 参数说明
参数 | 类型 | 说明 |
---|---|---|
productId | Long | 产品ID |
accountStatus | Int | 账号状态 9:试用 82:正式 91:过期 81:欠费 0:禁用 |
accountCostStatus | Int | 费用状态 82-正式,9-试用,91-过期,81-欠费,71-合同终止;过期或者欠费的不能启用产品,需要先由qsboss系统修改为正式或者试用账号,61-免费账号,62-付费账号 |
4. 示例
输入示例
{
"token":"5d41c4ac806c6440eb6aa8e071115f2b",
"loginName": "72988684-15f4-490a-9d55-61038647f9c2"
}
输出示例
{
"timeStamp": 1646983520639,
"code": 200,
"msg": "Successfully to get the user's info!",
"data": {
"lastName": "test004",
"userStatus": 1,
"displayName": "test004",
"accountType": 1,
"mobile": "13011112224",
"customerCode": "154079",
"productStatus": 1,
"userId": 88424203,
"customerName": "",
"products": [
{
"accountStatus": 82,
"productId": 80,
"accountCostStatus": 62
},
{
"accountStatus": 82,
"productId": 60000,
"accountCostStatus": 62
}
],
"firstName": "",
"countryCode": "86",
"loginName": "72988684-15f4-490a-9d55-61038647f9c2",
"middleName": "",
"email": "test004@quanshi.com"
},
"requestId": "10.255.0.106_20220311_152520_1646983520372"
}