- 开发前准备
- 组织自建应用对接
- 组织服务对接
- 历史版本(不推荐)
获取全量通讯录
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
必需
<= 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
name
string
组织名称
short_name
string
组织名称简写
version
integer
当前通讯录版本号
group_enterprise_id
integer
集团id
enterprise_type
integer
类型
logo_file_path
null
组织图标
sectors
array [object {13}]
组织部门
id
integer
组织部门id
name
string
部门名称
short_name
string
部门名称简写
parent_id
integer
父节点id
group_enterprise_id
integer
集团id
enterprise_id
integer
组织id
enterprise_flag
integer
类型
show_order
null
显示 顺序
show_path
string
部门显示路径
name_first_letter
string
部门首字母缩写
name_full_pinyin
string
部门首字母缩写
tree_code
string
部门树代码
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