1. 获取企业通讯录DEMO

下载 请戳这里

2. 获取access_token

企业内部开发者 请戳这里

3. 通讯录级别的access_token获取

用户对用户或部门的增加，编辑和删除操作

接口地址

https://www.fdccloud.com/api/tenant-open/get-addressbook-token

请求方式

POST

请求参数（json）

{
    "corpid": "my596c24f03fc0e",
    "corpsecret": "addressbook7XXXXXXXXXXXXXXX50f6de"
}

参数说明

参数 必须 说明
corpid 是 云助手企业CorpID。云助手后台->设置中心->企业设置->CorpID
corpsecret 是 通讯录秘钥。云助手后台->设置中心->通讯录设置->企业通讯录秘钥

返回值

{
    "data": {
        "access_token": "RjVzeTcxVE1XRU5VTUJ0azBQNEFUUzhGRW14Y1NuaXBxUVpPOGlQSzlkYiswYjNOaC9kMGdhUzNTSHF2MCs2MWsxZUpSMUwrSz",
        "expires_in": 7200
    },
    "errcode": 0,
    "errmsg": "ok",
    "isComplete": 1
}

参数说明

  1. errcode为0，则表示正常返回，为其他值则是异常
  2. access_token有效期为7200秒

4. 获取企业通讯录的组织架构

接口地址：

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

传参方式：

GET

返回结果

成功返回

{
    "data": [
        {
            "dept_guid": "xxx",
            "dept_name": "二级部门",
            "name_path": "顶级>>二级部门",
            "parent_guid": "xxx",
            "sort": "0"
        }
    ],
    "errcode": 0,
    "errmsg": "ok"
}

失败返回

{
    "data": "",
    "errcode": "错误代码",
    "errmsg": "错误信息"
}

5. 创建部门

接口地址:

https://www.fdccloud.com/api/tenant-open/create-dept?access_token=ACCESSTOKEN

此ACCESSTOKEN为通讯录级别的

传参方式：

POST

参数(json):

{
    "dept_guid": "5f4f52bf9b848",
    "dept_name": "总部",
    "dept_parent_guid": "",
    "sort": 1
}

参数说明

参数 必须 说明
dept_guid 否 字符串,不能超过50个字符，不填则会自动生成guid
dept_name 是 部门名称，1-50个字符
dept_parent_guid 是 父级部门guid,传空值，代表是顶级部门，顶级部门只能有一个，父级部门必须存在
sort 是 整型数字,同级部门的排序值，从小到大排序

返回结果

{
    "data": {
        "dept_guid": "5f4f52bf9b848"
    },
    "errcode": 0,
    "errmsg": "ok"
}

参数说明

1.errcode 返回码，为0则说明成功，非0代表失败

2.新建的部门id

6. 更新部门

接口地址:

https://www.fdccloud.com/api/tenant-open/update-dept?access_token=ACCESSTOKEN

此ACCESSTOKEN为通讯录级别的

传参方式：

POST

参数(json):

{
    "dept_guid": "5f4f52bf9b848",
    "dept_name": "总部",
    "dept_parent_guid": "",
    "sort": 1
}

参数说明

参数 必须 说明
dept_guid 必填 部门guid
dept_name 否 部门名称，1-50个字符
dept_parent_guid 否 部门名称，传空值，代表是顶级部门，顶级部门只能有一个
sort 否 整型数字,同级部门的排序值，从小到大排序

返回结果

{   
     "errcode":0,
     "errmsg":"ok",
     "data": ""
}

参数说明

1.errcode 返回码，为0则说明成功，非0代表失败

7. 删除部门

接口地址:

https://www.fdccloud.com/api/tenant-open/delete-dept?access_token=ACCESSTOKEN

此ACCESSTOKEN为通讯录级别的

传参方式：

POST

参数(json):

{
    "dept_guid": "5f4f52bf9b848"
}

参数说明

参数 必须 说明
dept_guid 必填 部门guid(注：不能删除根部门；不能删除含有子部门、成员的部门)

返回结果

{   
     "errcode":0,
     "errmsg":"ok",
     "data": ""
}

参数说明

1.errcode 返回码，为0则说明成功，非0代表失败

8. 获取部门下的用户信息

接口地址：

https://www.fdccloud.com/api/tenant-open/get-users-by-dept-id?access_token=ACCESSTOKEN

传参方式：

POST

参数:

{
    "dept_id": "部门id"
}

成功返回

{
    "data": [
        {
            "avatar": "如果有设置头像，则是头像链接，否则为空",
            "dept_id": [
                "171ac9eb-a983-45d2-9603-c925d2ffa961"
            ],
            "dept_name_list": [
                {
                    "dept_id": "171ac9eb-a983-45d2-9603-c925d2ffa961",
                    "dept_name": "产品体验"
                }
            ],
            "email": "用户邮箱",
            "is_disable": "0:正常1:禁用",
            "openid": "云助手用户openid",
            "roles": [
                {
                    "g_deletable": "0不可删除1可删除",
                    "g_des": "描述",
                    "g_editable": "0不可编辑1可编辑",
                    "g_id": "角色组ID",
                    "g_name": "角色组名",
                    "r_deletable": "0不可删除1可删除",
                    "r_des": "描述",
                    "r_editable": "0不可编辑1可编辑",
                    "r_id": "角色ID",
                    "r_name": "角色名称"
                }
            ],
            "tel": "用户电话",
            "user_code": "用户代码",
            "user_id": "用户id",
            "user_name": "用户名称",
            "wzs_user_id": "微助手用户id（唯一）"
        }
    ],
    "errcode": 0,
    "errmsg": "ok"
}

参数说明：

参数名称 说明
is_disable 用户状态：0-启用；1-禁用
roles 用户的角色信息
dept_id 用户直接上级部门的id列表
dept_name_list 用户直接上级部门的id和名称

失败返回

{
    "data": "",
    "errcode": "错误代码",
    "errmsg": "错误信息"
}

注意：

  1. 返回的用户是所属部门的用户，不包含子部门用户

9. 获取部门列表

接口地址:

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

传参方式:

POST

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

参数说明：

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

返回结果：

成功

{
    "errcode": 0,
    "errmsg": "ok",
    "is_complete":1
    "data": [
        {
            "dept_id": "02e9df78-6b35-4dfb-994b-06316b878221",
            "dept_name": "长沙明源工程部1",
            "parent_id": "ce302a6b-e0c7-4cc3-b376-291e8acbe535",
            "dept_code": "10000.10021.10006",
            "is_end_dept":0,
            "name_path":"总部>>长沙明源工程部1"
        }
    ]
}

失败

{
    "errcode": "-1003",
    "errmsg": "部门ID不能为空",
    "data": ""
}

参数说明：

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

10. 创建用户

接口地址:

https://www.fdccloud.com/api/tenant-open/create-user?access_token=ACCESSTOKEN

此ACCESSTOKEN为通讯录级别的

传参方式：

POST

参数(json):

{
    "dept_guid": "1",
    "email": "",
    "extattr": {
        "工号": "100"
    },
    "sex": "0",
    "tel": "",
    "user_code": "zhangsan",
    "user_name": "张三"
}

参数说明

参数 必须 说明
user_code 是 字符串,有字母或数字组成，不能超过50个字符，用户登录用的账号,企业内唯一
user_name 是 用户名称，不超过50个字符
dept_guid 是 用户所属部门guid
tel 否 手机号
email 否 邮箱
sex 否 性别 0-代表男 1-代表女
extattr 否 扩展字段，如果有对应字段就会写进去，没有则不会写入

返回结果

{   
     "errcode":0,
     "errmsg":"ok",
     "data": ""
}

参数说明

1.errcode 返回码，为0则说明成功，非0代表失败

11. 更新用户

接口地址:

https://www.fdccloud.com/api/tenant-open/update-user?access_token=ACCESSTOKEN

此ACCESSTOKEN为通讯录级别的

传参方式：

POST

参数(json):

{
    "dept_guid": "1",
    "email": "",
    "extattr": {
        "工号": "100"
    },
    "sex": "0",
    "tel": "",
    "user_code": "zhangsan",
    "user_name": "张三"
}

参数说明

参数 必须 说明
user_code 是 字符串,有字母或数字组成，不能超过50个字符，用户登录用的账号,企业内唯一
user_name 否 用户名称，不超过50个字符，如果填写，不能为空
dept_guid 否 用户所属部门guid，如果填写，则要填写正确
tel 否 手机号
email 否 邮箱
sex 否 性别 0-代表男 1-代表女
extattr 否 扩展字段，如果有对应字段就会写进去，没有则不会写入

返回结果

{   
     "errcode":0,
     "errmsg":"ok",
     "data": ""
}

参数说明

1.errcode 返回码，为0则说明成功，非0代表失败

12. 批量删除用户

接口地址:

https://www.fdccloud.com/api/tenant-open/delete-user?access_token=ACCESSTOKEN

此ACCESSTOKEN为通讯录级别的

传参方式：

POST

参数(json):

{
    "user_code_list": [
        "zhangsan",
        "lisi"
    ]
}

参数说明

参数 必须 说明
user_code_list 是 user_code

返回结果

{   
     "errcode":0,
     "errmsg":"ok",
     "data": ""
}

参数说明

  1. errcode 返回码，为0则说明成功，非0代表失败
  2. 如果某个用户删除失败，则返回失败的用户信息，正确的还是会删除掉，返回的errcode为错误code。

13. 获取用户详情

接口地址:

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

传参方式:

POST

{
    "user_code": "chulx,meiy02",
}

参数说明：

参数名称 必须 说明
user_code 是 用户user_code,多个用户用“,”分隔

返回结果：

成功

{
    "errcode": 0,
    "errmsg": "ok",
    "isComplete": 1,
    "data": [
        {
            "user_id": "124477",
            "user_code": "chulx",
            "user_name": "初良祥1",
            "user_tel": "+8615907185954",
            "openid": "mysoft5ca315b51b86e920156269",
            "is_disabled": "1"，
            "sex":"1",
            "avatar":"",
            "email":"",
            "dept":["0d5c0bcf-753f-4be3-add9-1d6e79547286","11b11db4-e907-4f1f-8835-b9daab6e1f23"],
            "dept_name_list": [
                {
                    "dept_id": "0d5c0bcf-753f-4be3-add9-1d6e79547286",
                    "dept_name": "产品体验"
                },
                {
                    "dept_id": "0d5c0bcf-753f-4be3-add9-1d6e79547285",
                    "dept_name": "测试部门"
                }
            ],
            "extattr": {
                "花名": "",
                "工号": "10000"
            },
            "dept_path_list": [
                [
                    {
                        "dept_id": "0d5c0bcf-753f-4be3-add9-1d6e79547286",
                        "dept_name": "深圳明源综管部",
                        "parent_dept_id": "cc5ce00a-44d7-4023-92ec-bafb85feb124"
                    },
                    {
                        "dept_id": "11b11db4-e907-4f1f-8835-b9daab6e1f23",
                        "dept_name": "总部",
                        "parent_dept_id": ""
                    },
                    {
                        "dept_id": "cc5ce00a-44d7-4023-92ec-bafb85feb124",
                        "dept_name": "深圳明源",
                        "parent_dept_id": "11b11db4-e907-4f1f-8835-b9daab6e1f23"
                    }
                ],
                [
                    {
                        "dept_id": "11b11db4-e907-4f1f-8835-b9daab6e1f23",
                        "dept_name": "总部",
                        "parent_dept_id": ""
                    },
                    {
                        "dept_id": "b929e10b-4b97-48ec-8b5c-9de34bcb2154",
                        "dept_name": "集团管理层",
                        "parent_dept_id": "11b11db4-e907-4f1f-8835-b9daab6e1f23"
                    }
                ]
            ]，
             "user_roles": [
                {
                    "role_group_id": "1",
                    "role_group_name": "自建组",
                    "role_id": "1",
                    "role_name": "开发",
                    "source": "erp"
                },
                {
                    "role_group_id": "mysoft5f1509df25e56",
                    "role_group_name": "系统级",
                    "role_id": "mysoft-599f95d2-cc86-11ea-bfcb-00155d0a7017",
                    "role_name": "CEO",
                    "source": "scrm"
                }
            ],
            "erp_user_guid":""

        },
        {
            "user_id": "125027",
            "user_code": "meiy02",
            "user_name": "梅义",
            "user_tel": "",
            "openid": "mysoft5ca315b58dc8f105472051",
            "is_disabled": "0",
            "sex":"0",
            "avatar":"",
            "email":"",
            "dept":["b929e10b-4b97-48ec-8b5c-9de34bcb2154"],
            "dept_name_list": [
                {
                    "dept_id": "b929e10b-4b97-48ec-8b5c-9de34bcb2154",
                    "dept_name": "产品体验"
                },
                {
                    "dept_id": "0d5c0bcf-753f-4be3-add9-1d6e79547285",
                    "dept_name": "测试部门"
                }
            ],
            "extattr": {
                "花名": "",
                "工号": "10001"
            },
             "dept_path_list": [
                [
                    {
                        "dept_id": "11b11db4-e907-4f1f-8835-b9daab6e1f23",
                        "dept_name": "总部",
                        "parent_dept_id": ""
                    },
                    {
                        "dept_id": "b929e10b-4b97-48ec-8b5c-9de34bcb2154",
                        "dept_name": "集团管理层",
                        "parent_dept_id": "11b11db4-e907-4f1f-8835-b9daab6e1f23"
                    }
                ]
            ]，
             "user_roles": [],
            "erp_user_guid":"1232"

        }
    ]
}

失败

    {  
          "errcode":"错误代码",
          "errmsg":"错误信息",
          "data":""
    }

参数说明：

参数名称 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 返回人员的信息集合
user_id 用户的唯一id
user_code 用户的账号
user_name 用户的名字
user_tel 用户的手机号
openid 用户的唯一标识
is_disabled 账号是否可用 1：不可用 0：可用
sex 性别 0-男 1-女
avatar 头像
email 邮箱
dept 用户所属部门
extattr 自定义字段集合
dept_path_list 用户所属部门的层级关系
dept_name_list 用户直接上级部门的id和名称
user_roles 用户所属角色
role_group_id 角色组id
role_group_name 角色组id
role_id 角色id
role_name 角色名称
source 角色来源 erp,scrm,erp
erp_user_guid erp的user_guid

14. 获取成员列表

接口地址:

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

传参方式:

POST

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

参数说明：

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

返回结果：

成功

{
    "errcode": 0,
    "errmsg": "ok",
    "is_complete":1
    "data": [
        {
            "wzs_user_id": "微助手用户id（唯一）",
            "user_id":"123",
            "openid": "云助手用户openid",
            "user_code": "用户代码",
            "user_name": "用户名称",
            "dept_id":["1","2"],
            "dept_name_list":[
                {
                    "dept_id": "cc5ce00a-44d7-4023-92ec-bafb85feb124",
                    "dept_name": "深圳明源"
                }
            ],
            "avatar":"如果有设置头像，则是头像链接，否则为空",
            "erp_code": [
                {
                    "erp_user_code": "zhangwei",
                    "erp_ver": ""
                },
                {
                    "erp_user_code": "zhangwei-test",
                    "erp_ver": "1"
                }
            ],
            "status":"0"
        }
    ]
}

失败

{
    "data": "",
    "errcode": "错误代码",
    "errmsg": "错误信息"
}

参数说明：

参数名称 说明
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
status 用户状态 0：启用 1：禁用
dept_id 用户直接上级部门的id列表
dept_name_list 用户直接上级部门的id和名称

15. 搜索通讯录

接口地址:

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

传参方式:

POST

{
    "keyword": "123",
    "type": 1,
    "is_need_page": 1,
    "page_index": 0,
    "page_size": 10,
    "show_disable_person": 0,
    "dept_range":"11,22"
}

参数说明：

参数名称 必须 说明
access_token 是 调用接口凭证
keyword 是 搜索的关键字，支持部门名称，用户姓名，用户code
type 是 type值为1-3，1：查找所有部门名称与之匹配的部门，2：查找所有用户姓名,用户code与之匹配的用户，3：查找1,2的合集
is_need_page 否 1：需要翻页，默认：不需要翻页
page_index 否 当前请求页的页码, 默认值 0 第一页
page_size 否 每页请求的数量, 默认值 200
show_disable_person 否 是否显示被禁用的用户 1：显示，0：不显示 。默认值为1，
dept_range 否 搜索的部门范围，如果不填则全企业搜索，填写则就搜索范围内（包含部门及子部门）的信息，多个部门用逗号分隔

返回结果：

成功

{
    "errcode": 0,
    "errmsg": "ok",
    "is_complete":1
    "data": {
        "user_list": [{
            "wzs_user_id": "微助手用户id（唯一）",
            "user_id": "123",
            "openid": "云助手用户openid",
            "user_code": "zhangs",
            "user_name": "张三",
            "dept_id": ["1", "2"],
            "dept_name_list": [
                {
                    "dept_id": "171ac9eb-a983-45d2-9603-c925d2ffa961",
                    "dept_name": "产品体验"
                }
            ],
            "avatar":"如果有设置头像，则是头像链接，否则为空",
            "erp_code": [
                {
                    "erp_user_code": "zhangs",
                    "erp_ver": ""
                },
                {
                    "erp_user_code": "zhangs-test",
                    "erp_ver": "1"
                }
            ],
            "status":"0"
        }],
        "dept_list": [{
            "dept_id": "02e9df78-6b35-4dfb-994b-06316b878221",
            "dept_name": "长沙明源工程部1",
            "parent_id": "ce302a6b-e0c7-4cc3-b376-291e8acbe535",
            "dept_code": "10000.10021.10006",
            "is_end_dept": 0
        }]
    }
}

失败

    {  
          "errcode":"错误代码",
          "errmsg":"错误信息",
          "data":""
    }

参数说明：

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

16. 获取用户相关部门id

接口地址:

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

传参方式:

POST

{
    "user_code": "123",
    "channel_id": "0",
}

参数说明：

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

返回结果：

成功

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

失败

{
    "data": "",
    "errcode": "错误代码",
    "errmsg": "错误信息"
}

参数说明：

参数名称 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 返回人员所属部门id及所有父级部门id

17. 同步通讯录

接口地址：

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

传参方式：

GET

返回结果

成功返回

{

    "errcode": 0,
    "errmsg": "ok"
}

失败返回

{
    "errcode": "错误代码",
    "errmsg": "错误信息"
}

results matching ""

    No results matching ""