人员信息同步
接受用户信息,同步到WeLink通讯录,支持批量更新用户信息,每次请求最多支持10个用户。
此接口为异步接口,返回的信息仅表明参数是否合法,是否同步成功请访问查询人员信息同步结果接口查询 。
请求格式说明
请求方式:POST (HTTPS)
请求地址:
https://open.welink.huaweicloud.com/api/contact/v1/users/bulk
认证方式: access_token,请参考获取access_token。
请求头部:
Accept-Charset:UTF-8
Content-Type:application/json
x-wlk-Authorization:access_token
请求参数:
{
"personInfo": [
{
"corpUserId": "111",
"userNameCn" : "张三",
"userNameEn": "zhangsan",
"sex": "F",
"mobileNumber": "+86-15115127336",
"phoneNumber": "+86-15115127336",
"corpDeptCode": "1000",
"userEmail": "zhangsan@huawei.com",
"landlineNumber": "",
"addressCode": "1000",
"corpSecretary": "",
"isOpenAccount": "1",
"address": "中国深圳",
"remark": "test",
"valid": "1"
"isHideMobileNumber": "1"
"orderInDepts": "10000"
}
]
}
请求参数说明:
参数 | 参数类型 | 必填 | 说明 |
---|---|---|---|
corpUserId | String | 是 | 该用户在客户系统的登录标示(客户内唯一) |
userNameCn | String | 是 | 人员中文名称 |
userNameEn | String | 是 | 人员英文名称 |
sex | String | 是 | 性别。仅:M/F, M: 男, F: 女 |
mobileNumble | String | 是 | 绑定手机号码 |
phoneNumber | String | 是 | 手机号码 |
corpDeptCode | String | 是 | 客户侧部门唯一编码,请先完成部门信息同步,否则传递该字段,系统无法识别该用户的部门 |
userEmail | String | 是 | 邮箱 |
landlineNumber | String | 否 | 座机 |
addressCode | String | 否 | 邮政编码 |
corpSecretary | String | 否 | 秘书。在导入用户时,如果秘书帐号还不存在,需要先维护秘书用户信息,再重新同步 |
isOpenAccount | String | 是 | “1”:表示开户,“0”:表示仅同步不开户 |
address | String | 否 | 办公位置信息 |
remark | String | 否 | 备注信息 |
valid | String | 是 | 默认为"1", "0"表示该用户已被移除即销户 |
isHideMobileNumber | String | 否 | 是否隐藏手机号码。1:公开(默认);2:隐藏 |
orderInDepts | String | 否 | 人员在所在部门内排序。取值范围:1~9999。按数值正序排列。默认为10000。 |
请求示例:
curl -X POST \
'https://open.welink.huaweicloud.com/api/contact/v1/users/bulk' \
-H 'Accept-Charset: UTF-8' \
-H 'Content-Type: application/json' \
-H 'x-wlk-Authorization: access_token' \
-d '{"请求参数 json格式"}'
响应格式说明
返回结果:
正常返回结果:
{
"code": "0",
"message": "成功",
"data": [
{
"corpUserId": "vvvvv",
"code": "47100",
"message": "waiting for deal"
},
{
"corpUserId": "vvvvdvdvd",
"code": "47003",
"message": "The mobile number used for login is empty. "
},
{
"corpUserId": "n",
"code": "47004",
"message": "isOpenAccount must be 1 or 0"
}
]
}
异常返回结果:
{
"code": "47101",
"message": "token格式错误",
"data": [
]
}
返回参数说明:
参数 | 说明 |
---|---|
code | 数据正常返回“0”,如果发生错误,会返回对应的错误码。 |
message | 返回信息,包括接口请求发生错误时的详细信息。 |
data | corpUserId:用户唯一标示; code:状态码; message:状态描述 |
错误码
错误码 | 说明 |
---|---|
0 | 成功 |
47003 | 参数为空(邮箱不能为空,部门信息不能为空等) |
47004 | 参数不对(邮箱格式有误,手机号码有误等) |
47100 | 待处理 |
47101 | Token格式错误 |
47102 | 无权限 |
47103 | Token过期 |
47104 | 处理中 |
47105 | 秘书帐号未创建 |
47106 | 上级部门未创建 |
47107 | 对应provider回写的状态1:未开户(仅保存成功) |
47108 | 对应provider回写的状态2:开户中 |
47109 | 对应provider回写的状态3:开户成功 |
47110 | 对应provider回写的状态4:开户失败(携带失败原因) |
47111 | 对应provider回写的状态-1:账户不存在 |
47112 | 处理中(无须再提交此数据) |
47113 | 待处理(无须再提交此数据) |