根据认证邮箱查询
1. 接口描述
接口名称:
/eventopenapi/user/v2/search/emails
发送方式:
POST
参数格式:
accept: application/json;content-type: application/json
2. 输入参数
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
token | String | 否 | 统一鉴权token 支持非token查询 (需要在http header提供AppKey, Nonce, CurTime, CheckSum ) |
emails | Array | 是 | 邮箱地址(只能是已认证的邮箱) |
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 | 客户编码 |
displayName | String | 显示名称 |
firstName | String | 首部名称 |
middleName | String | 中间名称 |
lastName | String | 尾部名称 |
userStatus | Int | 用户状态 0:离职或禁用; 1:已激活; 3:已删除 |
mailVerified | Boolean | 邮箱已认证 |
phoneVerified | Boolean | 电话已认证 |
4. 示例
输入示例
{
"token":"5d41c4ac806c6440eb6aa8e071115f2b",
"emails": [
"lizhen.dong@qstest1.com"
]
}
输出示例
{
"timeStamp": 1664508403701,
"code": 200,
"msg": "Successfully to get the user by emails!",
"data": {
"lizhen.dong@qstest1.com": [
{
"lastName": "lizhen.dong",
"userStatus": 1,
"displayName": "lizhen.dong",
"phoneVerified": false,
"mobile": "",
"customerCode": "153857",
"userId": 88732497,
"firstName": "",
"countryCode": "86",
"loginName": "1ae399aa-1bcf-4d8f-bf60-f5595d932e27",
"middleName": "",
"mailVerified": true,
"email": "lizhen.dong@qstest1.com"
}
]
},
"requestId": "10.255.0.106_20220930_112643_1664508403666"
}