创建员工

POST /v1/user

请求参数

参数	类型	必填	说明
email	字符串	是	邮箱, 必须是有效的邮件地址.
password	字符串	是	密码.
jobStatus	整型	否	在职状态。0：离职；1：在职.
agentType	整型	否	坐席类型。1：普通坐席；2：电话坐席.
agentRole	字符串	否	电话坐席角色。agent：普通电话坐席； leader：组长
realname	字符串	是	姓名, 长度32字符.
mobile	字符串	否	手机号, 需满足格式regular expression ^1[3-9]\d{9}$.
position	对象	是	岗位.
position.id	整型	是	岗位ID.
userGroupList	整型数组	否	所属员工组ID列表.
roleList	数组	是	角色列表.
roleList[].id	整型	是	角色ID.
userInfo	对象	否	员工拓展信息
userInfo.id	整型	否	拓展信息ID

响应数据

属性名	类型	说明
code	整型	响应编码.
message	字符串	响应消息.
visible	布尔型	是否可见, true / false .
data	对象	业务对象.
data.id	整型	员工ID.
data.email	字符串	邮箱.
data.jobStatus	整型	在职状态。0：离职；1：在职
data.agentType	整型	坐席类型。1：普通坐席；2：电话坐席.
data.agentRole	字符串	电话坐席角色。agent：普通电话坐席； leader：组长
data.position	对象	岗位.
data.position.id	整型	岗位ID.
data.userGroupList	整型数组	所属员工组ID列表.
data.realname	字符串	姓名.
data.mobile	字符串	手机号.
data.roleList	数组	角色数组.
data.roleList[].id	整型	角色ID.
data.authorizationSetList	数组	权限集数组.
data.authorizationSetList[].id	整型	权限集ID.

请求示例

$ curl 'https://servicego.udesk.cn/api/v1/user?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "email" : "1@test.cn",
  "password" : "sJrKTUpSx",
  "realname" : "测试员工1",
  "mobile" : "13300000001",
  "position" : {
    "id" : 2
  },
  "userGroupList": [533,544],
  "roleList" : [ {
    "id" : 3
  } ],
  "userInfo":{
    "id" : 2
  }
}'

响应示例

{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
    "id" : 942,
    "email" : "1@test.cn",
    "position" : {
      "id" : 2
    },
    "realname" : "测试员工1",
    "mobile" : "13300000001",
    "roleList" : [ {
      "id" : 3
    } ],
    "userGroupList": [533,544],
    "authorizationSetList" : [ ]
  }
}

更新员工

PUT /v1/user/{id:^[1-9]\d*$}

嵌入请求参数

参数	类型	必填	说明	限制
id	整型	是	ID.	必须大于1

请求参数

参数	类型	必填	说明
realname	字符串	是	姓名.
mobile	字符串	否	手机, 需满足格式regular expression ^1[3-9]\d{9}$.
jobStatus	整型	否	在职状态。0：离职；1：在职.
agentType	整型	否	坐席类型。1：普通坐席；2：电话坐席.
agentRole	字符串	否	电话坐席角色。agent：普通电话坐席； leader：组长
position	对象	是	岗位.
position.id	整型	是	岗位ID
status	整型	否	状态: 1启用; 2禁用; 3审核中.
userGroupList	整型数组	否	所属员工组ID列表.
roleList	数组	是	角色.
roleList[].id	整型	是	角色ID.
userInfo	对象	否	员工拓展信息
userInfo.id	整型	否	拓展信息ID

响应数据

属性名	类型	说明
code	整型	响应编码.
message	字符串	响应消息.
visible	布尔型	是否可见. true / false .

请求示例

$ curl 'https://servicego.udesk.cn/api/v1/user/944?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "realname" : "测试员工1",
  "mobile" : "13300000001",
  "position" : {
    "id" : 2
  },
  "status" : 1,
  "roleList" : [ {
    "id" : 2
  } ],
  "userGroupList": [533,544],
  "userInfo":{
    "id" : 2
  }
}'

响应示例

{
  "code" : 200,
  "message" : "OK",
  "visible" : false
}

查询员工

GET /v1/user/{id:^[1-9]\d*$}

嵌入请求参数

参数	类型	必填	说明	限制
id	整型	是	员工ID	必须大于1

响应数据

属性名	类型	说明
code	整型	响应编码.
message	字符串	响应消息.
visible	布尔型	是否可见. true / false .
data	对象	业务对象.
data.id	整型	员工ID.
data.email	字符串	邮箱.
data.position	对象	岗位.
data.position.id	整型	岗位ID.
data.userGroupList	整型数组	所属员工组ID列表.
data.realname	字符串	姓名.
data.mobile	字符串	手机号.
data.jobStatus	整型	在职状态。0：离职；1：在职
data.agentType	整型	坐席类型：1，普通坐席；2，电话坐席.
data.agentRole	字符串	坐席角色：agent,普通； leader，组长.
data.roleList	数组	角色.
data.roleList[].id	整型	角色ID.
data.authorizationSetList	数组	权限集.
data.authorizationSetList[].id	整型	权限集ID.
data.userInfo	对象	员工拓展详细信息.
data.userInfo.dataId	整型	dataID.
data.userInfo.objectId	整型	员工拓展信息记录ID.
data.userInfo.userInfoName	字符串	数据显示名称(即主字段值冗余).
data.userInfo.fieldDataList	数组	字段信息List.其中返回的字段，是根据 ”人员管理“ -> “员工管理“ -> “个人信息设置“ 中添加的字段来进行返回的。
data.userInfo.fieldDataList[].fieldApiName	字符串	字段API名称.
data.userInfo.fieldDataList[].fieldTypeApiName	字符串	字段API名称.
data.userInfo.fieldDataList[].fieldValue	字符串	字段值.
data.userInfo.fieldDataList[].foreignDataName	字符串	关联对象记录名称.
data.userInfo.fieldDataList[].userEmail	字符串	关联员工邮箱.
data.userInfo.fieldDataList[].optionNameList	数组	选项名称列表(选择类型字段).
data.userInfo.fieldDataList[].tagValueList	数组	标签字段详细信息(电话或邮箱).
data.userInfo.fieldDataList[].tagValueList[].tagName	字符串	标签名称.
data.userInfo.fieldDataList[].tagValueList[].tagValue	字符串	标签值.
data.userInfo.fieldDataList[].richText	对象	富文本字段详细信息(内容及附件).
data.userInfo.fieldDataList[].richText.content	字符串	富文本内容.
data.userInfo.fieldDataList[].richText.attachmentList	数组	附件列表.
data.userInfo.fieldDataList[].richText.attachmentList[].name	字符串	原始文件名.
data.userInfo.fieldDataList[].richText.attachmentList[].docAddress	字符串	外链.
data.userInfo.fieldDataList[].richText.attachmentList[].size	整型	大小.
data.userInfo.fieldDataList[].ownerResult	对象	所有人.
data.userInfo.fieldDataList[].ownerResult.ownerType	整型	所有人类型.
data.userInfo.fieldDataList[].ownerResult.ownerName	字符串	所有人名称.
data.userInfo.fieldDataList[].signDto	对象	签名信息.
data.userInfo.fieldDataList[].signDto.url	字符串	签名图片地址.
data.userInfo.fieldDataList[].signDto.time	字符串	签名时间.

请求示例

$ curl 'https://servicego.udesk.cn/api/v1/user/941?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -H 'Content-Type: application/json' -H 'Accept: application/json'

响应示例

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "data": {
        "id": 3,
        "email": "zhaofeng@Udesk.cn",
        "position": {
            "id": 2
        },
        "realname": "张三",
        "mobile": "15840134826",
        "jobNumber": "88066",
        "agentType": 1,
        "agentRole": "agent",
        "roleList": [
            {
                "id": 2
            }
        ],
        "userGroupList": [533,544],
        "authorizationSetList": [],
        "userInfo": {
            "dataId": 2,
            "objectId": 13,
            "userInfoName": "测试",
            "fieldDataList": [
                {
                    "fieldApiName": "sysusername",
                    "fieldTypeApiName": "field_type_single_line",
                    "fieldValue": "测试1"
                },
                {
                    "fieldApiName": "tudi",
                    "fieldTypeApiName": "field_type_single_line",
                    "fieldValue": "测试2"
                },
                {
                    "fieldApiName": "wuqi",
                    "fieldTypeApiName": "field_type_single_line",
                    "fieldValue": "测试3"
                },
                {
                    "fieldApiName": "lianxidianhua",
                    "fieldTypeApiName": "field_type_telephone",
                    "tagValueList": [
                        {
                            "tagName": "手机",
                            "tagValue": "15840347826"
                        },
                        {
                            "tagName": "手机",
                            "tagValue": "15844578040"
                        }
                    ]
                }
            ]
        }
    }
}

删除员工

DELETE /v1/user/{ids}

请求参数

参数	类型	必填	说明
ids	字符串	false	员工ID. 支持批量删，多个员工时可使用,拼接ID

响应数据

属性名	类型	说明
code	整型	响应编码.
message	字符串	响应消息.
visible	布尔型	是否可见, true / false .
data	对象	业务对象.
data.successList	数组	删除成功员工集合.
data.successTotal	整型	删除成功个数
data.failMap	对象	删除失败员工集合.
data.failTotal	整型	删除失败个数
data.total	整型	删除成功个数

请求示例

$ curl 'https://servicego.udesk.cn/api/v1/user/1,2,3?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X DELETE -H 'Content-Type: application/json' -H 'Accept: application/json'

响应示例

{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
    "successList" : [1],
    "successTotal" : 1,
    "failMap" : {
        "2" : "员工不存在",
        "3" : "员工不可删除"
    },
    "failTotal" : 2,
    "total" : 3
  }
}

查询员工列表

GET /v1/user

请求参数

参数	类型	必填	说明
pageNum	整型	是	页数, Min: 1.
pageSize	整型	是	页数大小, Min: 1, Max: 100.
positionId	整型	否	岗位ID, 如果传了此参数, 将仅查询指定岗位下的员工.

响应数据

标准分页对象分页

属性名	类型	说明
code	整型	响应编码.
message	字符串	响应消息.
visible	布尔型	是否可见, true / false .
paging	对象	分页对象.
paging.pageNum	整型	分页页码.
paging.pageSize	整型	分页页大小.
paging.total	整型	分页查询命中总数.
data	数组	业务对象.
data[].id	整型	员工ID.
data[].email	字符串	邮箱.
data[].position	对象	岗位.
data[].position.id	整型	岗位ID.
data[].realname	字符串	姓名.
data[].mobile	字符串	手机号.
data[].jobStatus	整型	在职状态。0：离职；1：在职
data[].agentType	整型	坐席类型：1，普通坐席；2，电话坐席.
data[].agentRole	字符串	坐席角色：agent,普通； leader，组长.
data[].roleList	数组	角色.
data[].roleList[].id	整型	角色ID.
data[].userGroupList	整型数组	所属员工组ID列表.
data[].authorizationSetList	数组	权限集.
data[].authorizationSetList[].id	整型	权限集ID.
data[].userInfo	对象	员工拓展详细信息.
data[].userInfo.dataId	整型	dataID.
data[].userInfo.objectId	整型	员工拓展信息记录ID.
data[].userInfo.userInfoName	字符串	数据显示名称(即主字段值冗余).
data[].userInfo.fieldDataList	数组	字段信息List.
data[].userInfo.fieldDataList[].fieldApiName	字符串	字段API名称.
data[].userInfo.fieldDataList[].fieldTypeApiName	字符串	字段API名称.
data[].userInfo.fieldDataList[].fieldValue	字符串	字段值.
data[].userInfo.fieldDataList[].foreignDataName	字符串	关联对象记录名称.
data[].userInfo.fieldDataList[].userEmail	字符串	关联员工邮箱.
data[].userInfo.fieldDataList[].optionNameList	数组	选项名称列表(选择类型字段).
data[].userInfo.fieldDataList[].tagValueList	数组	标签字段详细信息(电话或邮箱).
data[].userInfo.fieldDataList[].tagValueList[].tagName	字符串	标签名称.
data[].userInfo.fieldDataList[].tagValueList[].tagValue	字符串	标签值.
data[].userInfo.fieldDataList[].richText	对象	富文本字段详细信息(内容及附件).
data[].userInfo.fieldDataList[].richText.content	字符串	富文本内容.
data[].userInfo.fieldDataList[].richText.attachmentList	数组	附件列表.
data[].userInfo.fieldDataList[].richText.attachmentList[].name	字符串	原始文件名.
data[].userInfo.fieldDataList[].richText.attachmentList[].docAddress	字符串	外链.
data[].userInfo.fieldDataList[].richText.attachmentList[].size	整型	大小.
data[].userInfo.fieldDataList[].ownerResult	对象	所有人.
data[].userInfo.fieldDataList[].ownerResult.ownerType	整型	所有人类型.
data[].userInfo.fieldDataList[].ownerResult.ownerName	字符串	所有人名称.
data[].userInfo.fieldDataList[].signDto	对象	签名信息.
data[].userInfo.fieldDataList[].signDto.url	字符串	签名图片地址.
data[].userInfo.fieldDataList[].signDto.time	字符串	签名时间.

请求示例

$ curl 'https://servicego.udesk.cn/api/v1/user?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&pageSize=10&pageNum=1' -i -H 'Content-Type: application/json' -H 'Accept: application/json'

响应示例

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 2,
        "total": 2
    },
    "data": [
        {
            "id": 4,
            "email": "wangxianzhi@udesk.cn",
            "position": {
                "id": 2
            },
            "realname": "测试01",
            "mobile": "15834762387",
            "jobNumber": "10000001",
            "agentType": 1,
            "agentRole": "agent",
            "roleList": [
                {
                    "id": 2
                }
            ],
            "userGroupList": [533,544],
            "authorizationSetList": [],
            "userInfo": {
                "dataId": 3,
                "objectId": 13,
                "userInfoName": "测试",
                "fieldDataList": [
                    {
                        "fieldApiName": "sysusername",
                        "fieldTypeApiName": "field_type_single_line",
                        "fieldValue": "测试"
                    },
                    {
                        "fieldApiName": "wuqi",
                        "fieldTypeApiName": "field_type_single_line",
                        "fieldValue": "无"
                    }
                ]
            }
        },
        {
            "id": 3,
            "email": "zhaofeng@Udesk.cn",
            "position": {
                "id": 2
            },
            "realname": "测试02",
            "mobile": "15845647826",
            "jobNumber": "88066",
            "roleList": [
                {
                    "id": 2
                }
            ],
            "authorizationSetList": [],
            "userInfo": {
                "dataId": 2,
                "objectId": 13,
                "userInfoName": "测试01",
                "fieldDataList": [
                    {
                        "fieldApiName": "sysusername",
                        "fieldTypeApiName": "field_type_single_line",
                        "fieldValue": "测试02"
                    },
                    {
                        "fieldApiName": "tudi",
                        "fieldTypeApiName": "field_type_single_line",
                        "fieldValue": "测试03"
                    },
                    {
                        "fieldApiName": "wuqi",
                        "fieldTypeApiName": "field_type_single_line",
                        "fieldValue": "测试04"
                    },
                    {
                        "fieldApiName": "lianxidianhua",
                        "fieldTypeApiName": "field_type_telephone",
                        "tagValueList": [
                            {
                                "tagName": "手机",
                                "tagValue": "15840147826"
                            },
                            {
                                "tagName": "手机",
                                "tagValue": "15840178040"
                            }
                        ]
                    }
                ]
            }
        }
    ]
}