更新通讯录

接口描述：接入服务提供给对接的外部应用服务调用，对通讯录得部门和用户信息统一更新接口。
请求地址：https://service.cheng-xun.cn/api/corp-service/v1/address-book/changes?access_token={access_token}
请求方式：POST

重要事项

对于组织类型的部门只能修改remote_reference_id,其他属性均不可修改。

在一个请求中，对同一数据（部门/用户）仅支持一种操作（新增、更新或删除），存在多个操作时失败。

add_xxx 新增操作

新增部门时同级部门名称不能重复，remote_reference_id字段全局唯一。

新增员工时mobile_number，job_number，remote_reference_id 字段全局唯一。

update_xxx 修改操作 remote_reference_id为必填， cx_id 为选填。在不同参数情况下有如下逻辑：

填写cx_id；优先使用 cx_id查找数据

找到数据，则更新该数据

a. 部门：更新部门数据。同级部门名称不能重复，remote_reference_id 字段全局唯一。同时需要注意根组织数据只支持修改remote_reference_id。

b. 员工：更新员工数据。job_number，remote_reference_id 字段全局唯一。员工更新不会更新mobile_number。

找不到数据，则报错提示

不填写cx_id，使用remote_reference_id查找数据，情况如下：

a.部门

找不到数据 ,行为同新增部门流程

找到数据，更新当前数据。同级部门名称不能重复，remote_reference_id 字段全局唯一。同时需要注意根组织数据只支持修改remote_reference_id。

b.员工

找不到数据，行为同新增员工

找到数据，更新当前员工数据。job_number，remote_reference_id 字段全局唯一。员工更新不会更新mobile_number。

del_xxx 为删除系列，使用remote_reference_id进行删除.

新增部门

更新部门

新增员工

更新员工

删除员工

删除部门

接口内数据执行顺序

某次提交如果失败，该次提交的所有数据全部失效。

因修改数量有限制，如超过修改限制，需要保证修改数据的完整性，并分次提交

数据同步初始化流程建议

通过接口获取橙讯通讯录全量数据

绑定橙讯企业数据：绑定cx_id与remote_reference_id

绑定橙讯部门数据（如果存在数据）：绑定cx_id与remote_reference_id

修改橙讯部门数据

新增橙讯部门数据

绑定橙讯员工数据（如果存在数据）：绑定cx_id与remote_reference_id

修改橙讯员工数据

新增橙讯员工数据

删除橙讯中废弃员工数据

删除橙讯中废弃部门数据

请求参数

Authorization

Query 参数

access_token

string

必需

接口“获取访问凭证”返回的结果

<= 256 字符

Header 参数

User-Agent

string

可选

默认值:

Body 参数application/json

added_sectors

array [object {7}]

可选

name

string

部门全称

必需

同级别部门名称不能相同

<= 50 字符

enterprise_flag

integer

部门类型

必需

0: 部门; 1: 企业;2: 集团企业

show_order

number

显示顺序

可选

显示顺序，越小越靠前，当前版本暂不支持。

remote_reference_id

string

企业应用的部门id

必需

该属性全局唯一。

<= 50 字符

remote_parent_id

string

企业应用的父部门id

可选

为空时表示组织根（一个组织内只有一个组织根），只有部门类型为企业的时候，该值才能为空。

<= 50 字符

contact_mobile

string

联系人手机号

可选

支持格式国内： "+" + "国际区号" + "手机号" 如： +8615510983920

<= 20 字符

address

string

部门地址

可选

<= 100 字符

updated_sectors

array [object {8}]

必需

cx_id

number

橙讯内部组织ID

必需

对应查询接口的id,该字段全局唯一，由系统生成，不能修改，新增时该字段无效。

name

string

部门全称

必需

同级别部门名称不能相同

<= 50 字符

enterprise_flag

integer

部门类型

必需

部门类型 0: 部门; 1: 企业;2: 集团企业

show_order

number

显示顺序

可选

显示顺序，越小越靠前，当前版本暂不支持。

remote_reference_id

string

企业应用的部门id

必需

该属性全局唯一。

<= 50 字符

remote_parent_id

string

企业应用的父部门id

可选

为空时表示组织根（一个组织内只有一个组织根），只有部门类型为企业的时候，该值才能为空。

<= 50 字符

contact_mobile

string

联系人手机号

可选

支持格式国内： "+" + "国际区号" + "手机号" 如： +8615510983920

<= 20 字符

address

string

部门地址

可选

<= 100 字符

deleted_sectors

array[string]

删除部门ID列表

必需

列表为企业应用的部门id即remote_reference_id

added_staffs

array [object {9}]

必需

name

string

姓名

必需

<= 40 字符

remote_reference_id

string

企业应用的员工ID

必需

该属性全局唯一。

<= 50 字符

sex

string

性别

可选

性别:“男”、“女”

title

string

职务

可选

<= 60 字符

string

电子邮件

可选

<= 64 字符

job_number

string

员工号

可选

该字段全局唯一

<= 40 字符

mobile_number

string

手机号

可选

该字段全局唯一，手机号格式为： "+" + "国际区号" + "手机号" ，比如国内： +8615510983920（+可省略）员工手机号不支持修改。

<= 20 字符

id_number

string

身份证号

可选

<= 80 字符

sector_staffs

array [object {2}]

员工所属部门

可选

updated_staffs

array [object {10}]

必需

cx_id

number

橙讯内部员工ID,

必需

对应查询接口的id，该字段全局唯一，由系统生成，不能修改，新增时该字段无效。

name

string

姓名

必需

<= 40 字符

remote_reference_id

string

企业应用的员工ID

必需

该属性全局唯一。

<= 50 字符

title

string

职务

可选

<= 60 字符

sex

string

性别

可选

性别:“男”、“女”

string

电子邮件

可选

<= 64 字符

job_number

string

员工号

可选

该字段全局唯一

<= 40 字符

mobile_number

string

手机号

可选

该字段全局唯一，手机号格式为： "+" + "国际区号" + "手机号" ，比如国内： +8615510983920（+可省略）员工手机号不支持修改。

<= 20 字符

id_number

string

身份证号

可选

<= 80 字符

sector_staffs

array [object {2}]

员工所属部门

必需

deleted_staffs

array[string]

删除员工列表

必需

删除员工列表,列表为企业应用的员工id即remote_reference_id

enterprise_id

integer

组织（企业ID）

必需

示例

{
    "added_sectors": [
        {
            "name": "人力资源",
            "enterprise_flag": 0,
            "show_order": -3,
            "remote_reference_id": "746436362702848",
            "remote_parent_id": "745659800039424"
        }
    ],
    "updated_sectors": [
        {
            "cx_id": 746064081303552,
            "name": "研发部",
            "enterprise_flag": 0,
            "show_order": 0,
            "remote_reference_id": "746018874435584",
            "remote_parent_id": "745659800039424"
        }
    ],
    "deleted_sectors": [
        "746019329460224"
    ],
    "added_staffs": [
        {
            "name": "李四",
            "remote_reference_id": "746436487520256",
            "sex": "男",
            "email": "00019@mail.com",
            "job_number": "00019",
            "mobile_number": "+8613820100019",
            "sector_staffs": [
                {
                    "remote_sector_id": "746436362702848",
                    "show_order": -1
                }
            ]
        }
    ],
    "updated_staffs": [
        {
            "cx_id": 746064081803264,
            "name": "李桂香",
            "remote_reference_id": "746018874423296",
            "sex": "女",
            "email": null,
            "job_number": "10000",
            "mobile_number": "+8612820110000",
            "sector_staffs": [
                {
                    "remote_sector_id": "746019308838912",
                    "show_order": -41
                }
            ]
        },
        {
            "cx_id": 746064081803265,
            "name": "秦玉英",
            "remote_reference_id": "746018874437633",
            "sex": "暂无",
            "email": null,
            "job_number": "10001",
            "mobile_number": "+8612820110001",
            "sector_staffs": [
                {
                    "remote_sector_id": "746019290994688",
                    "show_order": -3
                }
            ]
        }
    ],
    "deleted_staffs": [
        "746018874466313",
        "746018874466311"
    ],
    "enterprise_id": 652267137875968
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://service.cheng-xun.cn/api/corp-service/v1/address-book/changes?access_token=' \
--header 'User-Agent: CX' \
--header 'Content-Type: application/json' \
--data-raw '{
    "added_sectors": [
        {
            "name": "人力资源",
            "enterprise_flag": 0,
            "show_order": -3,
            "remote_reference_id": "746436362702848",
            "remote_parent_id": "745659800039424"
        }
    ],
    "updated_sectors": [
        {
            "cx_id": 746064081303552,
            "name": "研发部",
            "enterprise_flag": 0,
            "show_order": 0,
            "remote_reference_id": "746018874435584",
            "remote_parent_id": "745659800039424"
        }
    ],
    "deleted_sectors": [
        "746019329460224"
    ],
    "added_staffs": [
        {
            "name": "李四",
            "remote_reference_id": "746436487520256",
            "sex": "男",
            "email": "00019@mail.com",
            "job_number": "00019",
            "mobile_number": "+8613820100019",
            "sector_staffs": [
                {
                    "remote_sector_id": "746436362702848",
                    "show_order": -1
                }
            ]
        }
    ],
    "updated_staffs": [
        {
            "cx_id": 746064081803264,
            "name": "李桂香",
            "remote_reference_id": "746018874423296",
            "sex": "女",
            "email": null,
            "job_number": "10000",
            "mobile_number": "+8612820110000",
            "sector_staffs": [
                {
                    "remote_sector_id": "746019308838912",
                    "show_order": -41
                }
            ]
        },
        {
            "cx_id": 746064081803265,
            "name": "秦玉英",
            "remote_reference_id": "746018874437633",
            "sex": "暂无",
            "email": null,
            "job_number": "10001",
            "mobile_number": "+8612820110001",
            "sector_staffs": [
                {
                    "remote_sector_id": "746019290994688",
                    "show_order": -3
                }
            ]
        }
    ],
    "deleted_staffs": [
        "746018874466313",
        "746018874466311"
    ],
    "enterprise_id": 652267137875968
}'

接口描述：接入服务提供给对接的外部应用服务调用，对通讯录得部门和用户信息统一更新接口。请求地址：https://service.cheng-xun.cn/api/corp-service/v1/address-book/changes?access_token={access_token}请求方式：POST#

请求参数

示例代码

返回响应

接口描述：接入服务提供给对接的外部应用服务调用，对通讯录得部门和用户信息统一更新接口。
请求地址：https://service.cheng-xun.cn/api/corp-service/v1/address-book/changes?access_token={access_token}
请求方式：POST