组织架构导入接口

接口地址 `/api/integrate/dept/batchAdd`

请求方式 POST

consumes ["application/json"]

produces ["application/json"]

接口描述 企业级接口，hearer必须携带X-Token

应用权限 组织架构->组织架构

请求参数

请求头参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	自建应用访问token	header	true	string

公共参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
publicParams	导入配置	body	true	object	组织架构导入配置
data	导入数据，每次最大500条	body	true	array	组织架构

组织架构导入配置

参数名称	参数说明	请求类型	是否必须	数据类型	schema
optType	导入方式(add: 新增, update: 更新, delete: 删除)，部门下存在员工渠道时无法删除	body	true	String
deleteSubDepartmentFlag	删除操作，是否删除子部门(true: 是, false: 否)，为否时存在子部门无法删除，默认为否	body	true	String

组织架构

部门匹配优先级 外部渠道类型：thirdDeptId > deptId，企业微信类型：wxDeptId > thirdDeptId > deptId，匹配标识必传一种
父部门匹配优先级 外部渠道类型：thirdParentId > parentId，企业微信类型：wxParentId > thirdParentId > parentId

参数名称	参数说明	请求类型	是否必须	数据类型
deptId	部门ID	body	false	Long
parentId	父部门ID	body	false	Long
deptType	部门类型，类型互斥，只能存在一种类型的组织架构(qywx: 企业微信, outchannel: 外部渠道)	body	true	String
deptName	部门名称	body	true	String
thirdDeptId	第三方部门ID，类型为外部渠道时必填	body	false	String
thirdParentId	第三方父部门ID，类型为外部渠道时选填	body	false	String
corpid	授权方企业微信ID，类型为企业微信时必填	body	false	String
wxDeptId	企业微信部门ID，类型为企业微信时必填	body	false	Long
wxParentId	企业微信父部门ID，类型为企业微信时选填	body	false	Long
deptStatus	部门状态(1: 有效, 2: 无效)	body	false	Integer
serialNum	排序	body	true	Integer
createUser	创建人	body	false	String
createTime	创建时间, 格式: yyyy-MM-dd HH:mm:ss	body	false	String
updateUser	修改人	body	false	String
updateTime	更新时间, 格式: yyyy-MM-dd HH:mm:ss	body	false	String

请求示例

{
    "publicParams":{
        "optType":"add"
    },
    "data":[{
        "deptType":"outchannel",
        "deptName":"测试部门1",
        "thirdDeptId":"D001",
        "deptStatus":"1",
        "serialNum":"0"
    },{
        "deptType":"outchannel",
        "deptName":"测试部门2",
        "thirdDeptId":"D002",
        "deptStatus":"1",
        "serialNum":"0"
    }]
}

响应参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
code	状态码	body	true	string
errorCode	异常码	body	true	string
msg	描述	body	true	string
data	响应数据	body	true	object	组织架构导入结果

组织架构导入结果

参数名称	参数说明	请求类型	是否必须	数据类型	schema
status	任务状态(-1: 失败, 0: 进行中, 1: 成功, 2: 部分导入成功)	body	true	int
errorData	导入失败数据	body	true	array	组织架构

响应状态

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应示例

{
    "code": "200",
    "errorCode": "SUCCESS",
    "msg": "ok",
    "data": {
        "status": 2,
        "errorData": [
            {
                "deptId": null,
                "parentId": null,
                "deptType": "outchannel",
                "deptName": "测试部门1",
                "thirdDeptId": "D001",
                "thirdParentId": "",
                "deptStatus": 1,
                "serialNum": 0,
                "deleteFlag": null,
                "createUser": null,
                "createTime": null,
                "updateUser": null,
                "updateTime": null
            }
        ],
        "errorMsg": [
            "部门已存在"
        ]
    }
}

员工导入接口

使用场景：

企业将自有系统的员工或企业微信的员工导入兔展平台

接口地址 /api/integrate/channel/employee/batchAdd

请求方式 POST

consumes ["application/json"]

produces ["application/json"]

接口描述 企业级接口，hearer必须携带X-Token

应用权限 渠道->员工渠道

请求参数

请求头参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	自建应用访问token	header	true	string

公共参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
publicParams	导入配置	body	true	object	员工渠道导入配置
data	导入数据，每次最大500条	body	true	array	员工渠道

员工渠道导入配置

参数名称	参数说明	请求类型	是否必须	数据类型	schema
optType	导入方式(add: 新增, update: 更新, delete: 删除)	body	true	String

员工渠道

渠道匹配优先级 wxUserid > thirdUserId > channelId，匹配标识必传一种
部门匹配优先级 wxDeptId > thirdDeptId > deptId，匹配标识必传一种

参数名称	参数说明	请求类型	是否必须	数据类型
channelId	员工渠道ID, 雪花算法生成	body	false	Long
thirdUserId	第三方用户ID	body	true	String
userType	渠道用户类型(1:公众号用户, 2:企业微信用户)	body	true	int
appId	微信公众号应用ID，appId与openid填写后免激活	body	false	String
openid	微信公众号openid，appId与openid填写后免激活	body	false	String
wxUserid	企业微信用户ID，结合企业微信部门免激活，渠道用户类型为企业微信用户时必填	body	false	String
unionid	微信unionid	body	false	String
channelName	员工渠道名称	body	true	String
phone	手机号码	body	true	String
job	职位	body	false	String
deptId	部门ID	body	false	Long
thirdDeptId	第三方部门ID	body	false	String
wxDeptId	企业微信部门ID	body	false	Long
deptManagerFlag	是否为部门管理员，父部门管理员自动拥有子部门管理权限(true: 是, false: 否)	body	false	Boolean
roleKeys	角色类型(ADMIN: 企业超管, GENERAL_EMPLOYE: 普通员工)	body	true	String[]
updateTime	更新时间, 格式: yyyy-MM-dd HH:mm:ss	body	true	String
deputyDeptIds	副部门id 第三方应用副部门id 逗号分隔，全量覆盖	body	false	String
serialNum	排序	body	false	Integer
roleId	角色类型 CUSTOM_ROLE: 自定义角色当角色类型为自定义角色需要传roleId 目前只支持一个	body	false	Long

请求示例

{
    "publicParams":{
        "optType":"add"
    },
    "data":[{
        "thirdUserId":"U001",
        "channelName":"测试渠道1",
        "phone":"15000000000",
        "job":"经理",
        "thirdDeptId":"D001",
        "roleKeys":["ADMIN","GENERAL_EMPLOYE"],
        "updateTime":"2020-10-23 12:00:00"
    },{
        "thirdUserId":"U002",
        "channelName":"测试渠道2",
        "phone":"15000000001",
        "job":"经理",
        "thirdDeptId":"D001",
        "deptManagerFlag":true,
        "roleKeys":["GENERAL_EMPLOYE"],
        "updateTime":"2020-10-23 12:00:00"
    }]
}

响应参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
code	状态码	body	true	string
errorCode	异常码	body	true	string
msg	描述	body	true	string
data	响应数据	body	true	object	员工渠道导入结果

员工渠道导入结果

参数名称	参数说明	请求类型	是否必须	数据类型	schema
status	任务状态(-1: 失败, 0: 进行中, 1: 成功, 2: 部分导入成功)	body	true	int
errorData	导入失败数据	body	true	array	员工渠道

响应状态

状态码	说明	schema
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应示例

{
    "code": "200",
    "errorCode": "SUCCESS",
    "msg": "ok",
    "data": {
        "status": 1,
        "errorData": null,
        "errorMsg": null
    }
}

组织架构导入接口

接口地址 /api/integrate/dept/batchAdd

请求参数

请求头参数

公共参数

组织架构导入配置

组织架构

请求示例

响应参数

组织架构导入结果

响应状态

响应示例

员工导入接口

使用场景：

请求参数

请求头参数

公共参数

员工渠道导入配置

员工渠道

请求示例

响应参数

员工渠道导入结果

响应状态

响应示例

接口地址 `/api/integrate/dept/batchAdd`