橙讯开放平台基线
首页服务端API客户端API附录橙讯官网
首页服务端API客户端API附录橙讯官网
  1. 获取通讯录
  • 开发前准备
  • 组织自建应用对接
    • 获取访问凭证
      • 获取访问凭证
    • 单点登录
      • 概述
      • 应用单点登录
      • 管理员单点登录
    • 消息推送
      • 概述
      • 消息推送
      • 消息撤回
    • 通讯录同步
      • 概述
      • 获取通讯录
        • 获取全量通讯录
        • 获取增量通讯录
      • 回调通知
        • 回调通知说明
    • 机器人
      • 概述
      • 创建群
      • 更新群
      • 查询群信息
      • 解散群
      • 设置群公告
      • 查询机器人创建的群列表
      • 发送群消息
      • 给指定用户发送消息
    • 待办
      • 概述
      • 创建待办
      • 更新待办
      • 删除待办
      • 更新待办执行人
    • 待阅
      • 概述
      • 创建待阅
      • 更新待阅
      • 删除待阅
      • 更新待阅执行人
    • 工作台卡片
      • 概述
      • 添加应用卡片模板
      • 获取应用的卡片模板列表
      • 更新应用卡片模板
      • 删除应用卡片模板
      • 设置卡片组织级数据
      • 批量设置卡片数据(卡片数据不同)
      • 批量设置卡片数据(卡片数据相同)
    • 错误码
      • 错误码
  • 组织服务对接
    • 组织服务对接准备
    • 对接流程
      • 概述
      • 换取企业永久授权码
      • 获取访问凭证
      • 获取全量通讯录
      • 获取增量通讯录变更
      • 更新通讯录
    • 错误码
      • 错误码
  • 历史版本（不推荐）
    • 组织自建应用对接
      • 通讯录同步
        • 概述
        • 获取通讯录
          • 获取全量通讯录
            GET
          • 获取增量通讯录
            GET
        • 回调通知
          • 回调通知说明
      • 消息推送
        • 概述
        • 消息推送
  1. 获取通讯录

获取增量通讯录

GET
/apps/v1/address-book/changes/{version}
接口描述：接入服务提供给对接的外部应用服务调用，获取指定组织的通讯录增量变更信息。
请求地址：https://service.cheng-xun.cn/api/apps/v1/address-book/changes/{version}?access_token={access_token}
请求方式：GET#
注意事项：
对接应用的服务器端在接收到数据时，需要先处理Add，再处理Update。
如果收到50702的错误码，说明差异太多，请做一次全量同步通讯录。#

请求参数

Authorization
Path 参数
version
string 
上一次同步的版本
必需
Query 参数
access_token
string 
必需
接口“获取访问凭证access_token”返回的结果
<= 256 字符
Header 参数
User-Agent
string 
可选
默认值:
CX

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://service.cheng-xun.cn/api/apps/v1/address-book/changes/?access_token' \
--header 'User-Agent: CX'

返回响应

🟢200成功
application/json
Body
version
integer 
版本信息
必需
当前通讯录版本号，后续用该版本号获取增量变量，对应增量更新中的version。
enterprise_id
integer 
组织ID
必需
enterprise
object 
组织信息
必需
如果组织基本信息变更会返回结果，否则为null
id
integer 
组织ID
必需
name
string 
组织名称
必需
version
integer 
当前通讯录版本号
必需
group_enterprise_id
integer 
集团id
必需
short_name
string 
组织名称简称
必需
enterprise_type
integer 
类型
必需
0:组织1:政府事业单位2:其他
logo_file_path
null 
组织图标
必需
added_sectors
array [object {12}] 
必需
id
integer 
组织部门id
可选
name
string 
部门名称
可选
parent_id
integer 
父节点id
可选
当parent_id为-1时，表明是顶层节点
group_enterprise_id
integer 
集团id
可选
enterprise_id
integer 
组织id
可选
enterprise_flag
integer 
类型
可选
0: 部门; 1: 组织;2: 集团企业
show_order
integer 
显示顺序
可选
show_path
string 
部门显示路径
可选
从根部门(不包括组织节点)开始，如“总部->人力资源”
name_first_letter
string 
部门首字母缩写
可选
name_full_pinyin
string 
部门首字母缩写
可选
tree_code
string 
部门树代码
可选
使用“|”串联父级部门id，最后的是当前部门id，如“1|12|”
remote_reference_id
null 
远程引用id
可选
updated_sectors
array [object {12}] 
必需
id
integer 
组织部门id
可选
name
string 
部门名称
可选
parent_id
integer 
父节点id
可选
group_enterprise_id
integer 
集团id
可选
enterprise_id
integer 
组织id
可选
enterprise_flag
integer 
类型
可选
0: 部门; 1: 组织;2: 集团企业
show_order
integer 
显示顺序
可选
show_path
string 
部门显示路径
可选
从根部门(不包括组织节点)开始，如“总部->人力资源”
name_first_letter
string 
部门首字母缩写
可选
name_full_pinyin
string 
部门首字母缩写
可选
tree_code
string 
部门树代码
可选
使用“|”串联父级部门id，最后的是当前部门id，如“1|12|”
remote_reference_id
null 
远程引用id
可选
deleted_sectors
array[integer]
删除部门ID列表
必需
added_staffs
array [object {21}] 
必需
id
integer 
用户的通讯录id
可选
account_id
string 
帐号id
可选
唯一标识用户
name
string 
名称
可选
sex
string 
性别
可选
性别：男，女，暂无
phone
null 
手机号码
可选
email
null 
邮箱
可选
group_enterprise_id
integer 
集团id
可选
enterprise_id
integer 
组织id
可选
name_first_letter
string 
姓名首字母缩写
可选
name_first_pinyin
string 
姓氏全拼
可选
name_full_pinyin
string 
姓名全拼
可选
job_number
string 
工作号码
可选
mobile_number
string 
电话号码
可选
other_mobile_number1
null 
其他手机1
可选
other_mobile_number2
null 
其他手机2
可选
office_address
null 
办公地址
可选
sector_staffs
array [object {2}] 
员工所属部门
可选
remote_reference_id
null 
远程引用id
可选
position
string 
职位
必需
position_option_id
string 
职位ID
必需
职位唯一标识
position_level
string 
职级
必需
updated_staffs
array [object {21}] 
必需
id
integer 
用户的通讯录id
可选
account_id
string 
帐号id
可选
唯一标识用户
name
string 
名称
可选
sex
string 
性别
可选
性别：男，女，暂无
phone
null 
手机号码
可选
email
null 
邮箱
可选
group_enterprise_id
integer 
集团id
可选
enterprise_id
integer 
组织id
可选
name_first_letter
string 
姓名首字母缩写
可选
name_first_pinyin
string 
姓氏全拼
可选
name_full_pinyin
string 
姓名全拼
可选
job_number
string 
工作号码
可选
mobile_number
string 
电话号码
可选
other_mobile_number1
null 
其他手机1
可选
other_mobile_number2
null 
其他手机2
可选
office_address
null 
办公地址
可选
sector_staffs
array [object {2}] 
员工所属部门
可选
remote_reference_id
null 
远程引用id
可选
position
string 
职位
必需
position_option_id
string 
职位ID
必需
职位唯一标识
position_level
string 
职级
必需
deleted_staffs
array[integer]
删除员工ID列表
必需
示例
{
    "version": 653833347104768,
    "enterprise_id": 652267137875968,
    "enterprise": {
        "id": 652267137875968,
        "name": "二七一十四",
        "version": 654022299480064,
        "group_enterprise_id": 652267137875968,
        "short_name": "十四",
        "enterprise_type": 0,
        "logo_file_path": null
    },
    "added_sectors": [
        {
            "id": 653994413223936,
            "name": "一七三",
            "parent_id": 652267137875968,
            "group_enterprise_id": 652267137875968,
            "enterprise_id": 652267137875968,
            "enterprise_flag": 0,
            "show_order": -3,
            "show_path": "一七三",
            "name_first_letter": "YQS",
            "name_full_pinyin": "YIQISAN",
            "tree_code": "652267137875968|653994413223936|",
            "remote_reference_id": null,
            "position": "总经理",
            "position_option_id": "913939257303360",
            "position_level": "14级"
        }
    ],
    "updated_sectors": [
        {
            "id": 653652329420800,
            "name": "一七一",
            "parent_id": 652267137875968,
            "group_enterprise_id": 652267137875968,
            "enterprise_id": 652267137875968,
            "enterprise_flag": 0,
            "show_order": -1,
            "show_path": "一七一",
            "name_first_letter": "YQY",
            "name_full_pinyin": "YIQIYI",
            "tree_code": "652267137875968|653652329420800|",
            "remote_reference_id": null,
            "position": "总经理",
            "position_option_id": "913939257303360",
            "position_level": "14级"
        }
    ],
    "deleted_sectors": [
        653994779326464
    ],
    "added_staffs": [
        {
            "id": 653994101303296,
            "account_id": "70238934839742",
            "name": "一一",
            "sex": "暂无",
            "phone": null,
            "email": null,
            "group_enterprise_id": 652267137875968,
            "enterprise_id": 652267137875968,
            "name_first_letter": "yy",
            "name_first_pinyin": "YI",
            "name_full_pinyin": "YIYI",
            "job_number": "1234",
            "mobile_number": "",
            "other_mobile_number1": null,
            "other_mobile_number2": null,
            "office_address": null,
            "sector_staffs": [
                {
                    "sector_id": 652267137875968,
                    "show_order": -4
                }
            ],
            "remote_reference_id": null
        }
    ],
    "updated_staffs": [
        {
            "id": 653994101303296,
            "account_id": "70238934839742",
            "name": "",
            "sex": "暂无",
            "phone": null,
            "email": null,
            "group_enterprise_id": 652267137875968,
            "enterprise_id": 652267137875968,
            "name_first_letter": "",
            "name_first_pinyin": "",
            "name_full_pinyin": "",
            "job_number": "1234",
            "mobile_number": "",
            "other_mobile_number1": null,
            "other_mobile_number2": null,
            "office_address": null,
            "sector_staffs": [
                {
                    "sector_id": 652267137875968,
                    "show_order": -4
                }
            ],
            "remote_reference_id": null
        }
    ],
    "deleted_staffs": [
        653994688073728
    ]
}
修改于 2025-04-01 02:36:03
上一页
获取全量通讯录
下一页
回调通知说明
Built with