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

获取全量通讯录

GET
/corp-service/v1/address-book
接口描述:接入服务提供给对接的外部应用服务调用,获取指定组织的完整架构信息。
请求地址: https://service.cheng-xun.cn/api/corp-service/v1/address-book?access_token={access_token}
请求方式: GET#

请求参数

Authorization
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/corp-service/v1/address-book?access_token' \
--header 'User-Agent: CX'

返回响应

🟢200成功
application/json
Body
err_code
integer 
必需
err_msg
string 
必需
id
integer 
组织id
必需
和获取访问凭证请求中的corp_id一致
name
string 
组织名称
必需
short_name
string 
组织名称简写
必需
version
integer 
当前通讯录版本号
必需
后续用该版本号获取增量变量,对应增量更新中的version。当同步端获取组织的全量数据以后,需要设置本地组织版本为该值,便于进行下次增量同步。
group_enterprise_id
integer 
集团id
必需
enterprise_type
integer 
类型
必需
0:组织1:政府事业单位2:其他
logo_file_path
null 
组织图标
必需
sectors
array [object {13}] 
组织部门
必需
id
integer 
组织部门id
可选
name
string 
部门名称
可选
short_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
null 
显示顺序
可选
show_path
string 
部门显示路径
可选
从根部门(不包括组织节点)开始,如“总部->人力资源”
name_first_letter
string 
部门首字母缩写
可选
name_full_pinyin
string 
部门首字母缩写
可选
tree_code
string 
部门树代码
可选
使用“|”串联父级部门id,最后的是当前部门id,如“1|12|”
remote_reference_id
null 
远程引用id
可选
staffs
array [object {18}] 
员工列表
必需
id
integer 
用户的通讯录id
可选
name
string 
名称
可选
sex
string 
性别
可选
性别:男,女,暂无
phone
null 
手机号码
可选
email
null 
邮箱
可选
account_id
string 
帐号id
可选
唯一标识用户
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
string 
其他手机1
可选
other_mobile_number2
string 
其他手机2
可选
office_address
null 
办公地址
可选
sector_staffs
array [object {2}] 
员工所属部门
可选
remote_reference_id
null 
远程引用id
可选
示例
{
    "err_code": 0,
    "err_msg": "Success.",
    "id": 652267137875968,
    "name": "二七一十四",
    "short_name": "十四",
    "version": 653994817130496,
    "group_enterprise_id": 652267137875968,
    "enterprise_type": 0,
    "logo_file_path": null,
    "sectors": [
        {
            "id": 652267137875968,
            "name": "二七一十四",
            "short_name": "十四",
            "parent_id": -1,
            "group_enterprise_id": 652267137875968,
            "enterprise_id": 652267137875968,
            "enterprise_flag": 1,
            "show_order": null,
            "show_path": "二七一十四",
            "name_first_letter": "sqesy",
            "name_full_pinyin": "sanqiershiyi",
            "tree_code": "652267137875968|",
            "remote_reference_id": null
        }
    ],
    "staffs": [
        {
            "id": 652267191267328,
            "name": "王丽",
            "sex": "女",
            "phone": null,
            "email": null,
            "account_id": "70238934839742",
            "group_enterprise_id": 652267137875968,
            "enterprise_id": 652267137875968,
            "name_first_letter": "wl",
            "name_first_pinyin": "WANG",
            "name_full_pinyin": "WANGLI",
            "job_number": "2212",
            "mobile_number": "",
            "other_mobile_number1": null,
            "other_mobile_number2": null,
            "office_address": null,
            "sector_staffs": [
                {
                    "sector_id": 652267137875968,
                    "show_order": -1
                }
            ],
            "remote_reference_id": null
        }
    ]
}
修改于 2025-04-01 02:36:03
上一页
获取访问凭证
下一页
获取增量通讯录变更
Built with