更新日期：     浏览次数：

1. 轻应用获取通讯录信息

云之家轻应用如何获取企业在云之家上的组织人员信息，可参考如下接口列表：

接口名称 URL 备注
企业所有组织人员 /gateway/opendata-control/data/getallpersons
个人信息 /gateway/opendata-control/data/getperson
获取当前部门基本信息或部门负责人 /gateway/opendata-control/data/getorg
获取当前部门的所有上级部门列表 /gateway/opendata-control/data/getancestororgs
获取当前部门所有下级部门列表 /gateway/opendata-control/data/getsuborgs
获取所有部门列表 /gateway/opendata-control/data/getallorgs
获取企业基本信息 /gateway/opendata-control/data/getcompany
获取当前部门成员或部门负责人信息 /gateway/opendata-control/data/getorgpersons
获取当前部门下一层级的所有部门基本信息列表 /gateway/opendata-control/data/getsublevelorgs
获取用户的默认上级或默认汇报上级或指定上级 /gateway/opendata-control/data/getparentperson
通过工作圈eid获取管理员oid /gateway/opendata-control/data/getAdminOidsByEid
根据企业eid查询全部合作伙伴信息 /gateway/opendata-control/partner/getPartners
根据手机号码和工作圈名称查询工作圈信息 /gateway/opendata-control/partner/searchNetwork
添加合作伙伴 /gateway/opendata-control/partner/createPartners
删除合作伙伴联系人 /gateway/opendata-control/partner/delPartContacts
按角色id获取人员信息 /gateway/opendata-control/data/getpersonByRoleIds
查询部门信息 /gateway/opendata-control/data/getorginfos
根据orgIds 获取人员信息 /gateway/opendata-control/data/org/getUserInfoRelyOrgIds

1.1. 授权说明

轻应用获取组织与人员信息接口都需要通过云之家OAuth2.0授权协议进行授权,授权级别为app级，授权方式为在接口请求URL后面添加accessToken参数，例如https://www.yunzhijia.com/gateway/opendata-control/data/...?accessToken=xxxxxx

1.2. 网络传输协议规范

1.2.1. 网络传输协议

HTTPS

1.2.2. 请求地址

https://www.yunzhijia.com

1.2.3. 请求方法

POST

1.2.4. 内容类型

Content-Type: application/x-www-form-urlencoded

1.3. 数据结构说明

  • 基本人员信息，数据结构OPerson
参数名 数据类型 说明
openId String 人员的openid
name String 姓名
photoUrl String 头像URL
phone String 手机号码（未开放）
email String 邮箱（未开放）
department String 部门
orgId String 用户所在部门ID
jobTitle String 职位
gender String 性别, 0: 不确定; 1: 男; 2: 女
isAdmin String 是否管理员， 1: 是； 0:不是，拥有工作圈的最高权限（与创建者一致）
status String 是否在职， 1：在职；0: 离职
jobNo String 工号
  • 基本工作圈信息，数据结构OCompany
参数名 数据类型 说明
name String 工作圈名称
eid String 工作圈企业ID
userCount String 工作圈用户数
  • 基本组织信息，数据结构OOrg
参数名 数据类型 说明
name String 部门名称
orgId String 部门ID
parentId String 上级部门ID
inChargers [OPerson] 负责人

1.4. API

1.4.1. 企业所有组织人员

URL:/gateway/opendata-control/data/getallpersons?accessToken=xxxxxxxxx

输入:

参数名 数据类型 是否必传 说明
eid string 必传 需要拉去数据的企业
time String 必传 查询时间，查询这个时刻之后所有变更的数据，第一次拉取时，传递"2008-08-02 01:40:38"。格式为24小时制，如Java中的"yyyy-MM-dd HH:mm:ss"
begin Integer 可选 默认0
count Integer 可选 默认1000，每次拉取限制1000条以内（包括1000条），如果返回条数不足count条，表示分页拉取已结束

输出:

{
  success: Boolean,
  error: String,
  errorCode: Integer,
  data: {
              time: String //与传入参数格式一致，表示本次拉取数据的截止时刻
              persons: [
    OPerson
    ]
  }
}

说明:

  • 同一个openId多次出现的问题：这是一个增量事件接口，它拉取的不单是整个企业的人员情况，只包括time时刻点到当前时刻的变更的人员情况，因此，出现openId重复的情况，应当用后续数据更新已经存在的openId人员信息。

1.4.2. 个人信息

URL:/gateway/opendata-control/data/getperson?accessToken=xxxxxxxxx

输入:

参数名 数据类型 是否必传 说明
openId String 是 人员ID
eid String 是 企业ID

输出:

{
    success: Boolean,
    error: String,
    errorCode: Integer,
    data: [
               OPerson
    ]
}

1.4.3. 获取当前部门基本信息或部门负责人

URL:/gateway/opendata-control/data/getorg?accessToken=xxxxxxxxx

输入:

参数名 数据类型 是否必传 说明
orgId String 是 部门ID
eid String 是 企业ID

输出:

{
    success: Boolean,
    error: String,
    errorCode: Integer,
    data:OOrg
}

1.4.4. 获取当前部门的所有上级部门列表

URL:/gateway/opendata-control/data/getancestororgs?accessToken=xxxxxxxxx

输入:

参数名 数据类型 是否必传 说明
orgId String 是 部门ID
eid String 是 企业ID

输出:

{
  success: Boolean,
  error: String,
  errorCode: Integer,
  data: [
          OOrg1, //上一级组织
          OOrg2, //上二级组织
          OOrg3, //上三级组织
          ...
  ]
}

1.4.5. 获取当前部门所有下级部门列表

URL:/gateway/opendata-control/data/getsuborgs?accessToken=xxxxxxxxx

输入:

参数名 数据类型 是否必传 说明
orgId String 是 部门ID
eid String 是 企业ID

输出:

{
    success: Boolean,
    error: String,
    errorCode: Integer,
    data: [OOrg
    ]
}

1.4.6. 获取所有部门列表

URL:/gateway/opendata-control/data/getallorgs?accessToken=xxxxxxxxx

输入:

参数名 数据类型 是否必传 说明
eid String 是 企业ID
begin Integer 否 分页起始位置，从0开始
count Integer 否 分页记录条数，这个值不要大于1000

输出:

{
    success: Boolean,
    error: String,
    errorCode: Integer,
    data: [
        OOrg
    ]
}

1.4.7. 获取企业基本信息

URL:/gateway/opendata-control/data/getcompany?accessToken=xxxxxxxxx

输入:

参数名 数据类型 是否必传 说明
eid String 是 企业ID

输出:

{
    success: Boolean,
    error: String,
    errorCode: Integer,
    data: {
        OCompany
    }
}

1.4.8. 获取当前部门成员或部门负责人信息

URL:/gateway/opendata-control/data/getorgpersons?accessToken=xxxxxxxxx

输入:

参数名 数据类型 是否必传 说明
eid String 是 企业ID
orgId String 是 部门ID
begin Integer 否 默认0
count Integer 否 默认1000，每次拉取限制1000条以内（包括1000条）

输出:

{
    success: Boolean,
    error: String,
    errorCode: Integer,
    data: {
        "inChargers": [OPerson
        ], //部门负责人
        "members": [OPerson
        ] //成员
    }
}

说明:

  1. inChargers只有在begin为0时返回，分页参数控制members的返回条数
  2. 部门负责人允许其它部门的人担任

1.4.9. 获取当前部门下一层级的所有部门基本信息列表

URL:/gateway/opendata-control/data/getsublevelorgs?accessToken=xxxxxxxxx

输入:

参数名 数据类型 是否必传 说明
eid String 是 企业ID
orgId String 是 部门ID

输出:

{
    success: Boolean,
    error: String,
    errorCode: Integer,
    data: [ OOrg
    ]
}

1.4.10. 获取用户的默认上级或默认汇报上级或指定上级

URL:/gateway/opendata-control/data/getparentperson?accessToken=xxxxxxxxx

输入:

参数名 数据类型 是否必传 说明
eid String 是 企业ID
openId String 是 人员ID

输出:

{
    success: Boolean,
    error: String,
    errorCode: Integer,
    data:｛
    "defaultParentPersons":[OPerson], //默认上级
    "defaultParentSecPersons":[OPerson], //默认汇报上级
    "selectParentPersons":[OPerson], //指定上级
    ｝
}

1.4.11. 通过工作圈eid获取管理员oid

URL:/gateway/opendata-control/data/getAdminOidsByEid?accessToken=xxxxxxxxx

输入:

参数名 数据类型 是否必传 说明
eid String 是 企业ID

输出:

{
    success: Boolean,
    error: String,
    errorCode: Integer,
    data:｛
            "oids"："12345645645,234324324", //多个oid以,分隔
           ｝
}

1.4.12. 根据企业eid查询全部合作伙伴信息

URL:/gateway/opendata-control/partner/getPartners?accessToken=xxxxxxxxx

输入:

参数名 数据类型 是否必传 说明
eid string 是 企业ID
time String 否 时间戳（精确到毫秒）;传空或者不传表示全部查询
begin Integer 否 默认0
count Integer 否 默认1000，查询使用分页机制，每次查询总数不能超过1000条；，如果输出条数不足count条，表示分页拉取已结束

输出:

{
    success: Boolean,
    error: String,
    errorCode: Integer,
    data: {
        partners: [
            { //合作伙伴列表
        partnerId:String //合作伙伴id
        code：String //合作伙伴编号
        name:String, //合作伙伴企业名称
        hasCertified:int //0,未认证；1，已认证
        eid:String //合作伙伴对应的云之家团队eid
        companyName:String //合作伙伴名称
        contacts: [
                    {
                name:String //联系人名称
                phone:String, //联系人手机号码
                openid:String, //联系人云之家对应openid
                contactId:String, //联系人id
                    }.....
                ]
            },....
        ]
    }
}

1.4.13. 根据手机号码和工作圈名称查询工作圈信息

URL:/gateway/opendata-control/partner/searchNetwork?accessToken=xxxxxxxxx

输入:

参数名 数据类型 是否必传 说明
eid String 是 企业ID
phone String 是 手机号
name String 是 团队名称

输出:

{
    success: Boolean,
    error: String,
    errorCode: Integer,
    data: {
        newtorks: [
            { //工作圈列表
            eid：String //工作圈eid
            networkId：String //工作圈networkId
            name:String, //工作圈名称
            },....
        ]
    }
}

1.4.14. 添加合作伙伴

URL:/gateway/opendata-control/partner/createPartners?accessToken=xxxxxxxxx

输入:

参数名 数据类型 是否必传 说明
eid String 是 企业ID
myOid String 是 本人oid
partnerEid String 是 合作伙伴eid
partnerPhone String 是 合作伙伴手机号

输出:

{
    success: Boolean,
    error: String,
    errorCode: Integer,
    data: {}
}

1.4.15. 删除合作伙伴联系人

URL:/gateway/opendata-control/partner/delPartContacts?accessToken=xxxxxxxxx

输入:

参数名 数据类型 是否必传 说明
eid String 是 企业ID
partnerEid String 是 合作伙伴eid
contactId String 是 联系人id

输出:

{

success: Boolean,
error: String,
errorCode: Integer,
data: {}
}

1.4.16. 按角色id获取人员信息

URL:/gateway/opendata-control/data/getpersonByRoleIds?accessToken=xxxxxxxxx

输入:

参数名 数据类型 是否必传 说明
eid String 是 企业ID
roleIds String 是 多个角色ID之间用下划线 _ 连接
begin Integer 否 分页开始 默认0
count Integer 否 每页数量 默认1000

输出:

{
    "success": Boolean,
    "error":String,
    "errorCode": Integer,
    "data": [
        {
            "eid": String,
            "members": [
                {
                    "photoUrl":String, +openid
                    "name": String,
                },
                {
                    "photoUrl": String,
                    "name": String,
                }
            ]
        }
    ]
}

1.4.17. 查询部门信息

URL:/gateway/opendata-control/data/getorginfos?accessToken=xxxxxxxxx

输入:

参数名 数据类型 是否必传 说明
eid String 是 企业ID
orgIds String 是 部门ID 必填 多个部门ID之间用下划线 _ 连接
begin Integer 否 分页开始 默认0
count Integer 否 每页数量 默认1000
hasChild Boolean 是 是否查询子部门信息

输出:

{
    "success": true,
    "error": null,
    "errorCode": 100,
    "data": [
        {
            "subOrgs": [
                {
                    "name": String,
                    "orgId": String,
                    "parentId": String,
                }
            ],
            "org": {
                "name": String,
                "orgId": String,
                "parentId": String,
            },
            "members": [
                {
                    "uid": String,
                    "openId": String,
                    "name": String,
                    "photoUrl": String,
                },
            ]
        }
    ]
}

1.4.18. 根据orgIds获取人员信息

URL:/gateway/opendata-control/data/org/getUserInfoRelyOrgIds?accessToken=xxxxxxxxx

输入:

参数名 数据类型 是否必传 说明
eid String 是 企业ID
orgIds String 是 部门ID 必填 多个部门ID之间用逗号隔开
begin Integer 否 分页开始 默认0
count Integer 否 每页数量 最大限制500
isIncludeSub Boolean 是 是否包含下级部门人员信息 
{
    "success": true,
    "error": null,
    "errorCode": 100,
    "data": [
              {
                "photoUrl": "http://static.yunzhijia.com/space/c/photo/load?id=5cd1dsad4af098c8e",
                "gender": "1",
                "phone": "1326*******4",
                "openId": "5a883cfasdasde690057",
                "jobTitle": "",
                "jobNo": "",
                "name": "张三",
                "isAdmin": 1,
                "department": "云之家测试1421",
                "email": "esasdg@kingdee.com",
                "orgId": "5c3c289ae4b00805b8db1aaa",
                "status": 1
              }
            ]
}

1.5. FAQ

1.5.1. 为什么接口返回错误“企业未授权”？

请检查生成accessTokenT的appId（轻应用）是否和eid（团队）保持一致的。

results matching ""

    No results matching ""