跳到主要内容

企业组织机构管理

获取企业Id

请求方式:GET
请求地址https://open.qingtui.com/team/domain/id/get?access_token=ACCESS_TOKEN&number=NUMBER

参数说明:

参数必须说明
access_token接口调用凭证
number企业号,可在管理后台中企业管理模块中查看

正确返回结果示例:

{
"domainId": "domainid111"
}

出错返回结果示例:

{
"errcode": "40402",
"errmsg": "invalid token"
}

参数说明:

参数说明
domainId企业Id号
errcode错误代号
errmsg错误信息

备注:

  1. 企业认证后,企业内部轻应用/订阅号可使用此接口

创建组织机构

请求方式: POST
Content-Type:application/x-www-form-urlencoded
请求地址https://open.qingtui.com/team/org/create?access_token=ACCESS_TOKEN

请求示例:

parent_id:parent002
name:产品部

参数说明:

参数必须说明
access_token接口调用凭证
parent_id创建的组织机构的父机构id,顶级为root
name组织机构名字

正确返回结果示例:

{
"org_id": "org_id00001"
}

出错返回结果示例:

{
"errcode": "40402",
"errmsg": "invalid token"
}

参数说明:

参数说明
org_id创建成功后的组织机构id
errcode错误代号
errmsg错误信息

备注:

  1. 需要轻应用有变更成员信息的权限

删除组织机构

请求方式: POST
Content-Type:application/x-www-form-urlencoded
请求地址https://open.qingtui.com/team/org/delete?access_token=ACCESS_TOKEN

请求示例:

org_id:org_id001

参数说明:

参数必须说明
access_token接口调用凭证
org_id创建的组织机构的父机构id,顶级为root

返回结果示例:

{
"errcode": "0",
"errmsg": "success"
}

参数说明:

参数说明
errcode提示代码,成功为0
errmsg提示信息,如果成功是success,失败则显示失败原因

备注:

  1. 需要轻应用有变更成员信息的权限
  2. 如果待删除的组织机构下含有子组织机构或成员,则删除失败

修改组织机构

**请求方式:**POST
Content-Type:application/x-www-form-urlencoded
请求地址https://open.qingtui.com/team/org/update?access_token=ACCESS_TOKEN

请求示例:

org_id:org_id001
name:运营部
sequence:100
autoSequence:false

参数说明:

参数必须说明
access_token接口调用凭证
org_id待修改的组织机构id
name修改后的组织机构名字
sequence顺序值,范围是0~ 2147483647
autoSequencetrue或者false,是否自动排序,默认为false不开启,如果开启此值,原组织中若已有待插入的sequence值,则会将原有值进行变更,以避免sequence出现重复

返回结果示例:

{
"errcode": "0",
"errmsg": "success"
}

参数说明:

参数说明
errcode提示代码,成功为0
errmsg提示信息,如果成功是success,失败则显示失败原因

备注:

  1. 需要轻应用有变更成员信息的权限
  2. 修改后的名字需要和当前名字不一致
  3. 为了支持批量事务更新组织机构顺序,sequence值允许相同,请确保插入的值在组织机构中唯一,否则在轻推客户端组织机构排序可能会出现不可预期的排序

分页获取组织机构列表

**请求方式:**GET
请求地址https://open.qingtui.com/team/org/paged?access_token=ACCESS_TOKEN&org_id=ORG_ID&page_size=PAGE_SIZE&request_page=REQUEST_PAGE

参数说明:

参数必须说明
access_token接口调用凭证
org_id组织机构id,顶级为root。获取此id的子组织机构信息;如果不填,则拉取整个组织机构
page_size请求的页码数据量,最大100
request_page请求的页码,从1开始

正确返回结果示例:

{
"total_count": 5,
"has_more": true,
"result_list": [
{
"id": "87395878",
"name": "产品部",
"parent_id": "9d04d10",
"sequence": 2,
"grade": 2
},
{
"id": "9d04d1011",
"name": "运营部",
"parent_id": "root",
"sequence": 0,
"grade": 1
}
]
}

出错返回结果示例:

{
"errcode": "40402",
"errmsg": "invalid token"
}

参数说明:

参数说明
result_list组织机构列表
total_count总数量
has_more是否还有更多数据未读
id组织机构id
name组织机构名称
parent_id父组织机构id
sequence组织机构显示顺序
grade组织机构等级名称
errcode错误代号
errmsg错误信息

备注:

  1. 需要轻应用有读取成员信息的权限

获取组织机构详情

**请求方式:**GET
请求地址https://open.qingtui.com/team/org/detail?access_token=ACCESS_TOKEN&org_id=ORG_ID

参数说明:

参数必须说明
access_token接口调用凭证
org_id组织机构id,root在此处不可用

正确返回结果示例:

{
"id": "87395878",
"name": "开发部",
"parent_id": "9d04d10",
"sequence": 2,
"grade": 2
}

出错返回结果示例:

{
"errcode": "46306",
"errmsg": "org is not exists"
}

参数说明:

参数说明
id组织机构id
name组织机构名称
parent_id父组织机构id
sequence组织机构显示顺序
grade组织机构等级名称
errcode错误代号
errmsg错误信息

备注:

  1. 需要轻应用有读取成员信息的权限

组织机构变更同步

请求方式: GET
请求地址https://open.qingtui.com/team/org/sync?access_token=ACCESS_TOKEN&sync_time=SYNC_TIME

参数说明:

参数必须说明
access_token接口调用凭证
sync_time要同步的Unix时间戳,毫秒格式,从此时间(含)后的变更都会返回

正确返回结果示例:

{
"list": [
{
"id": "1ea67",
"name": "产品部",
"parent_id": "root",
"sequence": 0,
"grade": 1,
"update_time": 1496753901100,
"status": 1
},
{
"id": "95a9",
"name": "运营部",
"parent_id": "root",
"sequence": 1,
"grade": 1,
"update_time": 1496753902145,
"status": 1
},
{
"id": "ac6b87ac1ad",
"name": "开发部",
"parent_id": "1ea67",
"sequence": 0,
"grade": 2,
"update_time": 1496753903567,
"status": 0
}
]
}

出错返回结果示例:

{
"errcode": "40402",
"errmsg": "invalid token"
}

参数说明:

参数说明
id组织机构id
name组织机构名称
parent_id父组织机构id
sequence组织机构显示顺序
grade组织机构等级名称
update_time更新时间戳(毫秒格式)
status是否存在,0 组织机构已不存在,被删除;1 组织机构还存在,仅更新
errcode错误代号
errmsg错误信息

备注:

  1. 需要轻应用有读取成员信息的权限