创建用户(批量)
一、接口URL
/umsopenapi/official/batch/user/create
二、功能
用户同步(*注: 每次最多1000条)
三、请求参数
http header 请求参数
| 名称 | 类型 | 是否必传 | 传参方式 | 说明 |
|---|---|---|---|---|
| token | String | true | http header | 调用全时API的身份验证token |
http body 请求参数
| 名称 | 类型 | 是否必传 | 传参方式 | 说明 |
|---|---|---|---|---|
| callback | String | false | RequestBody | 回调地址，任务执行完成后回调 |
| data | Array | true | RequestBody | 部门数据 |
data结构
| 名称 | 类型 | 是否必传 | 传参方式 | 说明 |
|---|---|---|---|---|
| String | false | RequestBody | 邮箱, 和mobile二选一必填； 必须是邮件地址格式。。 | |
| mobile | String | false | RequestBody | 手机号，和email二选一必填。 |
| password | String | false | RequestBody | 用户登陆密码,非必填 |
| name | String | true | RequestBody | 姓名。 |
| position | String | false | RequestBody | 职务，选填。 |
| office | String | false | RequestBody | 办公地点， 选填。 |
| organizationId | Long | true | RequestBody | 部门id |
| buyFeePropss | Array | false | RequestBody | 购买或者取消账号付费项目，包含字段buyPropss(销售端 salesEnd)、type(create开通/delete取消)，如：[{"buyPropss":"salesEnd","type":"create"},{"buyPropss":"clipTools","type":"create"}] |
四、请求体
{
"token": "78ae6ab90f5a43555efa27efb3911a36",
"callback": "http://www.quanshi.com/api/callback",
"data":[
{
"email": "test@quanshi.com",
"mobile": "13912345678",
"name": "王小明",
"position": "软件工程师",
"office": "苏州",
"organizationId": 34253432
},
{
"email": "test2@quanshi.com",
"mobile": "13912345679",
"name": "王小明2",
"position": "软件工程师",
"office": "苏州",
"organizationId": 34253431
}
]
}
五、返回参数
| 名称 | 类型 | 说明 |
|---|---|---|
| code | Integer | 结果码，0： 成功， 非0：失败 （具体描述见错误码表） |
| data | json | 返回数据,用户id |
| message | String | 错误描述 |
| requestId | String | 请求唯一ID。查询接口日志时需要，建议打印日志 |
六、返回体
{
"code": 0,
"data":{
"batchId":"2w515441cdf6b0955493ca479d50d72e"
},
"message": "success",
"requestId": "openapi-ums-165-17e9061a-adc5-4392-b160-0305fb65a0f5"
}
回调callback结构
| 名称 | 类型 | 说明 |
|---|---|---|
| batchId | String | 本次请求的批次号， 后续使用此参数查询批量创建结果 |
| status | int | 执行状态 1:已结束-全部成功,2:已结束-部分成功 |
| type | String | 回调类型 organization,user |
{
"batchId":"9c5e5441cdf6b0955493ca479d50d712",
"status":2,
"type":"user"
}
