导入公司白名单联系人数据
1. 接口描述
接口名称：
/eventopenapi/mcenter/whitelist/contacts/import
发送方式：
POST
参数格式：
accept: application/json;content-type: application/json
2. 输入参数
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| token | String | 是 | 统一鉴权token |
| groupId | Long | 否 | 分组ID（groupId或groupName二选一） |
| groupName | String | 否 | 白名单分组名称 |
| list | Array | 是 | 白名单列表（导入的数据不能超过20000条） |
| append | Boolean | 否 | 是否追加记录 true: 是; false: 否（默认false，全量替换） |
| async | Boolean | 否 | 是否异步导入 true: 是; false: 否（默认值 false） |
list 参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| name | String | 是 | 名称 |
| company | String | 否 | 公司名称 |
| mobile | Object | 否 | 电话信息（电话信息和邮箱至少二选一） |
| String | 否 | 邮箱 | |
| extraInfo | Object | 否 | 其它个人信息 |
mobile 参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| country_code | String | 否 | 国家码 |
| phone_number | String | 是 | 电话号码 |
extraInfo 参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| position | String | 否 | 职位 |
| department | String | 是 | 部门 |
3. 输出参数
| 参数 | 类型 | 说明 |
|---|---|---|
| timeStamp | Long | 返回时间（时间戳，单位毫秒） |
| requestId | String | 请求ID（在接口异常时, 需提供请求ID） |
| code | Int | 返回的状态码 |
| msg | String | 当返回结果的状态码不为200时，包含的错误信息 |
| data | Json | 返回数据 |
data 参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| groupId | Long | 分组ID |
| groupName | String | 白名单分组名称 |
| append | Boolean | 是否追加记录 true: 是; false: 否 |
| failed | Array | 导入失败记录 |
| async | Boolean | 是否异步导入 true: 是; false: 否 |
| asyncJobId | String | 异步导入任务ID |
failed 参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| name | String | 名称 |
| company | String | 公司名称 |
| String | 邮箱 | |
| mobile | Json | 电话信息 |
| reason | String | 导入失败原因 |
mobile 参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| country_code | String | 国家码 |
| phone_number | String | 电话号码 |
4. 示例
输入示例
{
"token":"5d41c4ac806c6440eb6aa8e071115f2b",
"groupName": "G1",
"async": false,
"append": false,
"list": [
{
"name": "白名单用户122",
"company": "金山珠海分公司",
"mobile": {
"country_code": "86",
"phone_number": "19856745652"
},
"extraInfo":{
"position":"董事长"
}
},
{
"name": "白名单用户2",
"company": "全时科技",
"email": "user2@quanshi.com" ,
"extraInfo":{
"position":"董事长"
}
}
]
}
输出示例
{
"timeStamp": 1642401348535,
"code": 200,
"msg": "Successfully to import the company whitelist!",
"data": {
"groupId": 12208065,
"groupName": "G1",
"async": false,
"asyncJobId": null,
"append": false,
"failed": null
},
"requestId": "10.255.0.106_20220117_143548_1642401348439"
}
