导入公司白名单数据

注意:

  • 导入的数据放在"白名单管理" => "用户白名单"下
  • 每次执行导入操作都会全量替换"用户白名单"下的数据,其它白名单下的数据不受影响
  • 如果选择异步导入(async=true), 通过"查询公司白名单导入状态"接口获取导入执行状态

1. 接口描述

接口名称:

/eventopenapi/mcenter/whitelist/import

发送方式:

POST

参数格式:

accept: application/json;content-type: application/json

2. 输入参数

参数 类型 必须 说明
token String 统一鉴权token
groupName String 白名单分组名称(默认值 "其他")
list Array 白名单列表(导入的数据不能超过20000条)
async Boolean 是否异步导入 true: 是; false: 否(默认值 false)
append Boolean 是否追加记录 true: 是; false: 否(默认false,全量替换)

list 参数说明

参数 类型 必须 说明
groupName String 分组名称(默认取上层的groupName)
name String 名称
company String 公司名称
mobile String 电话信息(电话信息和邮箱至少二选一)
email String 邮箱

mobile 参数说明

参数 类型 必须 说明
country_code String 国家码
phone_number String 电话号码

3. 输出参数

参数 类型 说明
timeStamp Long 返回时间(时间戳,单位毫秒)
requestId String 请求ID(在接口异常时, 需提供请求ID)
code Int 返回的状态码
msg String 当返回结果的状态码不为200时,包含的错误信息
data Json 返回数据

data 参数说明

参数 类型 说明
async Boolean 是否异步导入 true: 是; false: 否
groupName String 分组名称
failed Array 导入失败记录

failed 参数说明

参数 类型 说明
name String 名称
company String 公司名称
email 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"
            }
        },
        {
            "name": "白名单用户2",
            "company": "全时科技",
            "email": "user2@quanshi.com" 
        }
    ]
}

输出示例

{
    "timeStamp": 1642401348535,
    "code": 200,
    "msg": "Successfully to import the company whitelist!",
    "data": {
        "async": false,
        "groupName": "G1",
        "failed": null
    },
    "requestId": "10.255.0.106_20220117_143548_1642401348439"
}