同步外部联系人 - 组织人事

请求参数

Body 参数application/json

data

array [object {19}]

必需

username

string

姓名

必需

sex

string

性别

可选

location_name

string

办公地点

可选

position

string

岗位

可选

note

string

备注

可选

email

string

邮箱

可选

mobile

string

手机

可选

telephone

string

电话

可选

customer

number

关联客户

可选

仅支持客户id

contact

number

关联客户联系人

可选

关联客户联系人,仅支持id

employeeExternalType

string

来源

可选

备注：
wechat 微信
wechatsync 企业微信同步
wechat_wechatsync 微信（企业微信同步）
im_sync IM外部用户同步
otherTeams 其他组织加入
crm_customer CRM客户联系人
teams_invite 加入团队
card_add 卡片新增
corpgroup 上下游
srm_jqt 供应商

subcompany

string

企业

可选

关联外部互联-企业；支持数据规则

department

string

部门

可选

关联外部互联-部门，支持数据规则

account

string

账号

可选

仅人员新增有效；不允许修改。
1.该字段仅可以传递手机号码或者邮箱

loginMobile

string

登录手机

可选

loginEmail

string

登录邮箱

可选

loginid

string

登录名

可选

【后台管理中心-账号安全-安全设置】登录设置-账号支持方式：登录名开启才支持；可以修改

password

string

密码

可选

仅新增有效；不可以修改

sec_level

string

安全级别

可选

dataRule

object

数据规则

必需

字段校验规则；比如指定人员规则是名称，就按照名称规则检查唯一，如果查询到则更新；否则新增

employee

string

人员规则

必需

id: 按照人员id来检查;username：按照名称检查；job_num: 按照工号来检查；

department

string

部门规则

必需

id:按照部门id来检查；name:按照部门名称来检查；

subcompany

string

企业规则

必需

id:按照企业id来检查；name:按照企业名称来检查；

apiTaskId

string

任务号

可选

任务号，相同任务号防止并发

optId

string

操作者

必需

会更新到邀请人里面；

extKey

string

指定需要额外返回内容的key

可选

指定报文中某个列，需要在返回报文中返回；
当指定后，返回内容将提供：extKeyMap；是map对象，并返回指定的key和其内容；

例如指定 extkey=uuid，且报文提供了uuid=1234;则返回内容有
"extKeyMap": {
"uuid": "1234"
}

virtualId

number

维度id

可选

外部联系人维度id;

1.

外部互联-维度管理中看到
或者

2.

使用下面sql查询： select * from hrm_company_virtual hcv where tenant_key =租户key and data_type in ('extenal','lower_external','wechat_external','custom_external')

示例

{
    "data": [
        {
            "username": "开放-001",
            "subcompany":"",
            "department":"",
            "inviter": "xy1002s"
        }
    ],
    "dataRule": {
        "employee": "username",
        "subcompany": "name",
        "department": "name"
    },
    "apiTaskId": "task1",
    "optId": "834818870895968304",
    "extKey": "outkey",
    "virtualId": "932034476441755649"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/hrm/restful/syncExteralEmployee' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": [
        {
            "username": "开放-001",
            "subcompany":"",
            "department":"",
            "inviter": "xy1002s"
        }
    ],
    "dataRule": {
        "employee": "username",
        "subcompany": "name",
        "department": "name"
    },
    "apiTaskId": "task1",
    "optId": "834818870895968304",
    "extKey": "outkey",
    "virtualId": "932034476441755649"
}'

返回响应

🟢200成功

application/json

Body

code

integer

api状态

必需

200 成功

msg

string

描述

必需

status

boolean

状态

必需

false 失败；true 成功

data

array [object {5}]

必需

keyValue

string

数据唯一字段值

可选

operate

string

同步操作类型

可选

add 新增、update 修改

status

string

状态

可选

SUCCESS 成功；ERROR 失败

errcode

string

失败原因

可选

needRepush

boolean

可选

示例

{"message":{"errcode":"0","errmsg":"success"},"data":[{"keyValue":"开放-001","id":1087506541603569665,"operate":"UPDATE","status":"SUCCESS","errcode":"SUCCESS","needRepush":false}]}