[关闭]
@myyzs 2019-01-02T02:31:18.000000Z 字数 3180 阅读 32

通讯录管理

1.获取部门列表

接口地址:

https://www.fdccloud.com/api/tenant-open/get-department-list?access_token=ACCESS_TOKEN

传参方式:

POST

  1. {
  2.     "dept_id": "02e9df78-6b35-4dfb-994b-06316b878221",
  3.     "type": 1,
  4.     "is_need_page": 1,
  5.     "page_index": 0,
  6.     "page_size": 10
  7. }

参数说明：

参数名称 必须 说明
access_token 是 调用接口凭证
dept_id 否 部门id。 如果不填，再根据type获取对应的数据
type 是 type值为1-4，1-获取企业的全部部门(支持分页)，2-获取企业的顶级部门及顶级部门的直接子级部门，3-传入部门id，返回该部门，4-传入部门id，返回该部门下的直接子级部门
is_need_page 否 不传或者为0-不需要翻页，1-需要翻页（仅当type=1时支持翻页）
page_index 否 当前请求页的页码, 默认值 0 第一页
page_size 否 每页请求的数量, 默认值 200

返回结果：

成功

  1. {
  2.     "errcode": 0,
  3.     "errmsg": "ok",
  4.     "is_complete":1
  5.     "data": [
  6.         {
  7.             "dept_id": "02e9df78-6b35-4dfb-994b-06316b878221",
  8.             "dept_name": "长沙明源工程部1",
  9.             "parent_id": "ce302a6b-e0c7-4cc3-b376-291e8acbe535",
  10.             "dept_code": "10000.10021.10006",
  11.             "is_end_dept":0
  12.         }
  13.     ]
  14. }

失败

  1. {
  2.     "errcode": "-1003",
  3.     "errmsg": "部门ID不能为空",
  4.     "data": ""
  5. }

参数说明：

参数名称 说明
errcode 返回码
errmsg 对返回码的文本描述内容
is_complete 数据拉取是否完成，0：未完成 1 已完成，所有数据拉取完毕
data 部门列表
dept_id 部门id
dept_name 部门名称
parent_id 父级部门id
dept_code 部门层级code
is_end_dept 是否末级部门

2.获取成员列表

接口地址:

https://www.fdccloud.com/api/tenant-open/get-user-list?access_token=ACCESS_TOKEN

传参方式:

POST

  1. {
  2.     "dept_id": "02e9df78-6b35-4dfb-994b-06316b878221",
  3.     "type": 1,
  4.     "is_need_page": 1,
  5.     "page_index": 0,
  6.     "page_size": 10
  7. }

参数说明：

参数名称 必须 说明
access_token 是 调用接口凭证
dept_id 是 部门id
type 是 type值为1-2，1-返回该部门下的直接人员，2-返回该部门及其所有层级的子级部门的人员
is_need_page 否 不传或者为0，表示不需要翻页，1-需要翻页
page_index 否 当前请求页的页码, 默认值 0 第一页
page_size 否 每页请求的数量, 默认值 200

返回结果：

成功

  1. {
  2.     "errcode": 0,
  3.     "errmsg": "ok",
  4.     "is_complete":1
  5.     "data": [
  6.         {
  7.             "wzs_user_id": "微助手用户id（唯一）",
  8.             "user_id":"123",
  9.             "openid": "云助手用户openid",
  10.             "user_code": "用户代码",
  11.             "user_name": "用户名称",
  12.             "dept_id":[1,2],
  13.             "erp_code": [
  14.                 {
  15.                     "erp_user_code": "zhangwei",
  16.                     "erp_ver": ""
  17.                 },
  18.                 {
  19.                     "erp_user_code": "zhangwei-test",
  20.                     "erp_ver": "1"
  21.                 }
  22.             ]
  23.         }
  24.     ]
  25. }

失败

  1.     {  
  2.           "errcode":"错误代码",
  3.           "errmsg":"错误信息",
  4.           "data":""
  5.     }

参数说明：

参数名称 说明
errcode 返回码
errmsg 对返回码的文本描述内容
is_complete 数据拉取是否完成，0：未完成 1 已完成，所有数据拉取完毕
data 用户列表
wzs_user_id 微助手用户id（唯一）
user_id 用户id
openid 云助手用户openid
user_code 用户代码
erp_user_code erp代码
user_name 用户名称
dept_id 部门id

3.搜索通讯录

接口地址:

https://www.fdccloud.com/api/tenant-open/search-contact?access_token=ACCESS_TOKEN

传参方式:

POST

  1. {
  2.     "keyword": "123",
  3.     "type": 1,
  4.     "is_need_page": 1,
  5.     "page_index": 0,
  6.     "page_size": 10
  7. }

参数说明：

参数名称 必须 说明
access_token 是 调用接口凭证
key 是 搜索的关键字
type 是 type值为1-3，1-查找所有部门名称与之匹配的部门，2-查找所有员工姓名与之匹配的员工，3-查找所有部门名称OR员工姓名与之匹配的部门和员工
is_need_page 否 不传或者为0，表示不需要翻页，1-需要翻页
page_index 否 当前请求页的页码, 默认值 0 第一页
page_size 否 每页请求的数量, 默认值 200

返回结果：

成功

  1. {
  2.     "errcode": 0,
  3.     "errmsg": "ok",
  4.     "is_complete":1
  5.     "data": {
  6.         "user_list": [{
  7.             "wzs_user_id": "微助手用户id（唯一）",
  8.             "user_id": "123",
  9.             "openid": "云助手用户openid",
  10.             "user_code": "用户代码",
  11.             "user_name": "用户名称",
  12.             "dept_id": [1, 2],
  13.             "erp_code": [
  14.                 {
  15.                     "erp_user_code": "zhangwei",
  16.                     "erp_ver": ""
  17.                 },
  18.                 {
  19.                     "erp_user_code": "zhangwei-test",
  20.                     "erp_ver": "1"
  21.                 }
  22.             ]
  23.         }],
  24.         "dept_list": [{
  25.             "dept_id": "02e9df78-6b35-4dfb-994b-06316b878221",
  26.             "dept_name": "长沙明源工程部1",
  27.             "parent_id": "ce302a6b-e0c7-4cc3-b376-291e8acbe535",
  28.             "dept_code": "10000.10021.10006",
  29.             "is_end_dept": 0
  30.         }]
  31.     }
  32. }

失败

  1.     {  
  2.           "errcode":"错误代码",
  3.           "errmsg":"错误信息",
  4.           "data":""
  5.     }

4.获取用户相关部门id

接口地址:

https://www.fdccloud.com/api/tenant-open/get-department-id-by-user-code?access_token=ACCESS_TOKEN

传参方式:

POST

  1. {
  2.     "user_code": "123",
  3.     "channel_id": "0",
  4. }

参数说明：

参数名称 必须 说明
user_code 是 用户user_code
channel_id 否 如果不传该字段，则默认为企业通讯录

返回结果：

成功

  1. {
  2.     "errcode": 0,
  3.     "errmsg": "ok",
  4.     "data": ["02e9df78-6b35-4dfb-994b-06316b878221", "ce302a6b-e0c7-4cc3-b376-291e8acbe535"]
  5. }

失败

  1.     {  
  2.           "errcode":"错误代码",
  3.           "errmsg":"错误信息",
  4.           "data":""
  5.     }

参数说明：

参数名称 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 返回人员所属部门id及所有父级部门id
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注