功能描述
通过 xlsx 文件批量导入用户。
接口说明
超级管理员可新增、删除任意普通成员或系统管理员。
系统管理员可新增、删除任意普通成员。
普通成员不可新增、删除用户。
请求
请求示例
POST /user/v1/allowlist/
{OrganizationId}
/batch-import/{FilePath}
?user_token={UserToken}
请求参数:
OrganizationId:组织 ID,必选参数。
UserToken:用户令牌,必选参数。
FilePath:用户表格文件 path,即获取用户 xlsx 简单上传文件参数中的响应字段 path,必选参数。
请求体
该请求无请求体。
响应
响应码
同步导入完成:HTTP 200 OK
启用异步导入:HTTP 202 Accepted
响应体
application/json
响应体示例:
启用异步导入,返回异步任务 ID,该异步任务支持取消操作。
{"taskId": 28}
同步导入完成,返回导入结果。
[{"taskId": 1,"status": 200,"total": 1,"remaining": 0,"result": [{"phoneNumber": "13888888888","nickname": "张三","status": 200}]}]
响应体字段说明:
taskId:整数,任务 ID。
status:整数,任务状态码。
202:任务进行中。
200:任务成功完成且有返回结果,返回结果在 result 字段中。
204:任务成功完成且无返回结果。
500:任务执行失败。
499:用户取消。
207: 多状态。
total:整数,总的任务数量(如果该任务支持返回 total)。
remaining:整数,剩余任务数量(如果该任务支持返回 remaining)。
result:对象数组,任务成功完成后的返回结果。
phoneNumber:字符串,导入用户手机号。
nickname:字符串,导入用户昵称。
status:数字,导入状态,200 表示导入成功。