开发 地图小程序OPENAPI 开发指南 企业组织 企业部门

企业部门 最后更新时间: 2024年08月30日

产品介绍

该 API 是通过 HTTPS 协议访问远程服务的接口,提供修改组织信息、添加/移除组织成员、修改组织成员信息的能力。

使用限制

详细的服务调用量限制可点我查阅

业务身份和业务签名

bizToken和bizSign的详情可点我查阅 。

使用说明

如无特殊声明,接口的输入参数和输出数据编码全部统一为 UTF-8 编码方式。

1. 创建部门

请求地址

URL

https://restwia.amap.com/api/v1/wia/org/dept/create

请求方式

POST

签名参数

openId

特别注意:

  1. 一个部门下最多创建1000个直接子部门。
  2. 创建部门层级最多为20。
  3. 一个企业下部门名称不允许重复。

请求参数

参数名

含义

规则说明

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

openId

管理员高德开放用户ID

管理员用户在高德的身份ID

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

superDeptId

父部门ID

未填时表示根部门下创建一级部门

name

部门名称

不超过20个字符

desc

部门描述

部门描述,不超过100个字符

bizSign

业务签名

参考签名规则

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {

    String url = "https://restwia.amap.com/api/v1/wia/org/dept/create";
    Map<String, Object> params = new HashMap<>();
    String openId = "当前操作用户的openId";

    params.put("key", "在高德开放平台申请的key");
    params.put("openId", openId);
    params.put("bizToken", "在高德开放平台申请的bizToken");
    String[] signArgs = new String[]{openId};
    params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));

    params.put("name", "新创建的部门");

    String response = MyHttpUtils.postFormUrlencoded(url, params);
    System.out.println(response);
}

返回参数

返回字段

含义

规则说明

data

数据体

创建成功的部门ID

code

返回结果编码

1 表示成功

message

返回状态说明

成功时返回Successful,否则返回错误原因

version

版本号

字符串类型

timestamp

时间戳

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

字符串格式,长度30

状态码code

0:异常

1:成功

2:失败

3:参数错误

110001:成员不在组织内

110002:组织不存在

110102:部门级别达到最大值

110103:部门名称重复

110104:直接子部门个数已达最大值

110105:部门名称违规

110105:部门描述违规

2. 修改部门

请求地址

URL

https://restwia.amap.com/api/v1/wia/org/dept/modify

请求方式

POST

签名参数

openId

特别注意:暂无。

请求参数

参数名

含义

规则说明

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

openId

管理员高德开放用户ID

管理员用户在高德的身份ID

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

deptId

部门ID

被修改的父部门ID

name

部门名称

不超过20个字符,非null时表示修改

desc

部门描述

部门描述,不超过100个字符,非null时表示修改

bizSign

业务签名

参考签名规则

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {

    String url = "https://restwia.amap.com/api/v1/wia/org/dept/modify";
    Map<String, Object> params = new HashMap<>();
    String openId = "当前操作用户的openId";

    params.put("key", "在高德开放平台申请的key");
    params.put("openId", openId);
    params.put("bizToken", "在高德开放平台申请的bizToken");
    String[] signArgs = new String[]{openId};
    params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));

    params.put("deptId", "部门ID");
    params.put("name", "修改后的部门名称");

    String response = MyHttpUtils.postFormUrlencoded(url, params);
    System.out.println(response);
}

返回参数

返回字段

含义

规则说明

data

数据体

无数据

code

返回结果编码

1 表示成功

message

返回状态说明

成功时返回Successful,否则返回错误原因

version

版本号

字符串类型

timestamp

时间戳

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

字符串格式,长度30

状态码code

0:异常

1:成功

2:失败

3:参数错误

110001:成员不在组织内

110002:组织不存在

110101:部门无效

110103:部门名称重复

110105:部门名称违规

110105:部门描述违规

3. 删除部门

请求地址

URL

https://restwia.amap.com/api/v1/wia/org/dept/delete

请求方式

POST

签名参数

openId

特别注意:暂无。

请求参数

参数名

含义

规则说明

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

openId

管理员高德开放用户ID

管理员用户在高德的身份ID

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

deptId

部门ID

被修改的父部门ID

bizSign

业务签名

参考签名规则

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {

    String url = "https://restwia.amap.com/api/v1/wia/org/dept/delete";
    Map<String, Object> params = new HashMap<>();
    String openId = "当前操作用户的openId";

    params.put("key", "在高德开放平台申请的key");
    params.put("openId", openId);
    params.put("bizToken", "在高德开放平台申请的bizToken");
    String[] signArgs = new String[]{openId};
    params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));

    params.put("deptId", "部门ID");

    String response = MyHttpUtils.postFormUrlencoded(url, params);
    System.out.println(response);
}

返回参数

返回字段

含义

规则说明

data

数据体

无数据

code

返回结果编码

1 表示成功

message

返回状态说明

成功时返回Successful,否则返回错误原因

version

版本号

字符串类型

timestamp

时间戳

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

字符串格式,长度30

状态码code

0:异常

1:成功

2:失败

3:参数错误

110001:成员不在组织内

110002:组织不存在

110107:删除的部门下还有子部门

110108:删除的部门下还有员工

4. 多个成员移动到指定部门

请求地址

URL

https://restwia.amap.com/api/v1/wia/org/dept/batchUserToDept

请求方式

POST

签名参数

openId

特别注意:

  1. 移动成功后,会移除所有员工原加入的所有部门,除了目标部门。

请求参数

参数名

含义

规则说明

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

openId

管理员高德开放用户ID

管理员用户在高德的身份ID

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

deptId

部门ID

目标部门ID

empIds

员工ID列表

大小不能超过50。员工已在目标部门的话,则不处理,但不算有效的输入参数;如果所有的empIds都在目标部门,则报参数错误。

bizSign

业务签名

参考签名规则

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {

    String url = "https://restwia.amap.com/api/v1/wia/org/dept/batchUserToDept";
    Map<String, Object> params = new HashMap<>();
    String openId = "当前操作用户的openId";

    params.put("key", "在高德开放平台申请的key");
    params.put("openId", openId);
    params.put("bizToken", "在高德开放平台申请的bizToken");
    String[] signArgs = new String[]{openId};
    params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));

    params.put("deptId", "部门id");
    // 部门员工列表为字符串用逗号拼接   示例:"NF9FwCBG-fUb9x53SsAGNSSI1zuGRsYywq5NZ347r64,Fp7qQlsQ-B5AqsE5__jS0KAb8o2m2EJOpT0lYGp09zE"
    // empId不是openId 分页获取部门的子部门列表和员工列表接口获取empId
    params.put("empIds", "员工ID列表");

    String response = MyHttpUtils.postFormUrlencoded(url, params);
    System.out.println(response);
}

返回参数

返回字段

含义

规则说明

data

数据体

无数据

code

返回结果编码

1 表示成功

message

返回状态说明

成功时返回Successful,否则返回错误原因

version

版本号

字符串类型

timestamp

时间戳

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

字符串格式,长度30

状态码code

0:异常

1:成功

2:失败

3:参数错误

110001:成员不在组织内

110002:组织不存在

110101:部门无效

110109:员工个数达到上限

5. 设置员工部门

请求地址

URL

https://restwia.amap.com/api/v1/wia/org/dept/userFinalToDepts

请求方式

POST

签名参数

openId

特别注意:

  1. 用户最多加入10个部门。
  2. 该操作以用户输入的部门列表为最终结果,表示用户加入的部门列表。即用户之前加入的但本次未设置,则会从之前加入的部门退出。

请求参数

参数名

含义

规则说明

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

openId

管理员高德开放用户ID

管理员用户在高德的身份ID

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

empId

员工ID

deptIds

部门ID列表

用户最多加入10个部门。

bizSign

业务签名

参考签名规则

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {

    String url = "https://restwia.amap.com/api/v1/wia/org/dept/userFinalToDepts";

    Map<String, Object> params = new HashMap<>();
    String openId = "当前操作用户的openId";

    params.put("key", "在高德开放平台申请的key");
    params.put("openId", openId);
    params.put("bizToken", "在高德开放平台申请的bizToken");
    String[] signArgs = new String[]{openId};
    params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));

    // empId不是openId 分页获取部门的子部门列表和员工列表接口获取empId
    params.put("empId", "员工ID");
    // 部门ID列表为字符串用逗号拼接   示例:"xFhUorC-IBW_1LQ9TSA56nzMsaaFYlTDq7ou0fsYy6Q,xFhUorC-IBW_1LQ9TSA56vDV3TGj4DOErbaLjW1aXfg"
    params.put("deptIds", "部门ID列表");

    String response = MyHttpUtils.postFormUrlencoded(url, params);
    System.out.println(response);
}

返回参数

返回字段

含义

规则说明

data

数据体

无数据

code

返回结果编码

1 表示成功

message

返回状态说明

成功时返回Successful,否则返回错误原因

version

版本号

字符串类型

timestamp

时间戳

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

字符串格式,长度30

附表

0:异常

1:成功

2:失败

3:参数错误

110001:成员不在组织内

110002:组织不存在

110110:设置员工部门时,部门个数达到上限

6. 获取用户部门列表

请求地址

URL

https://restwia.amap.com/api/v1/wia/org/dept/getDeptsForUser

请求方式

POST

签名参数

openId

特别注意:暂无。

请求参数

参数名

含义

规则说明

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

openId

高德开放用户ID

用户在高德的身份ID

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

bizSign

业务签名

参考签名规则

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {

    String url = "https://restwia.amap.com/api/v1/wia/org/dept/getDeptsForUser";
    Map<String, Object> params = new HashMap<>();
    String openId = "当前操作用户的openId";

    params.put("key", "在高德开放平台申请的key");
    params.put("openId", openId);
    params.put("bizToken", "在高德开放平台申请的bizToken");
    String[] signArgs = new String[]{openId};
    params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));

    String response = MyHttpUtils.postFormUrlencoded(url, params);
    System.out.println(response);
}

返回参数

返回字段

含义

规则说明

data

数据体

List<DeptInfoDTO>,DeptInfoDTO的定义见文档末尾。

code

返回结果编码

1 表示成功

message

返回状态说明

成功时返回Successful,否则返回错误原因

version

版本号

字符串类型

timestamp

时间戳

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

字符串格式,长度30

状态码code

0:异常

1:成功

2:失败

3:参数错误

110001:成员不在组织内

110002:组织不存在

7. 获取指定部门信息

请求地址

URL

https://restwia.amap.com/api/v1/wia/org/dept/getDeptInfo

请求方式

POST

签名参数

openId

特别注意:暂无。

请求参数

参数名

含义

规则说明

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

openId

高德开放用户ID

用户在高德的身份ID

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

deptId

部门ID

bizSign

业务签名

参考签名规则

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {

    String url = "https://restwia.amap.com/api/v1/wia/org/dept/getDeptInfo";
    Map<String, Object> params = new HashMap<>();
    String openId = "当前操作用户的openId";

    params.put("key", "在高德开放平台申请的key");
    params.put("openId", openId);
    params.put("bizToken", "在高德开放平台申请的bizToken");
    String[] signArgs = new String[]{openId};
    params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));

    params.put("deptId", "部门ID");

    String response = MyHttpUtils.postFormUrlencoded(url, params);
    System.out.println(response);
}

返回参数

返回字段

含义

规则说明

data

数据体

DeptInfoDTO,DeptInfoDTO的定义见文档末尾。

code

返回结果编码

1 表示成功

message

返回状态说明

成功时返回Successful,否则返回错误原因

version

版本号

字符串类型

timestamp

时间戳

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

字符串格式,长度30

状态码code

0:异常

1:成功

2:失败

3:参数错误

110001:成员不在组织内

110002:组织不存在

8. 分页获取部门的子部门列表

请求地址

URL

https://restwia.amap.com/api/v1/wia/org/dept/pageGetDepts

请求方式

POST

签名参数

openId

特别注意:暂无。

请求参数

参数名

含义

规则说明

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

openId

高德开放用户ID

用户在高德的身份ID

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

deptId

部门ID

未传时,获取根部门下的数据

cursor

分页游标

第一次可为null,后面以上一次请求返回的结果为准

limit

分页大小

不能超过50

bizSign

业务签名

参考签名规则

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {

    String url = "https://restwia.amap.com/api/v1/wia/org/dept/pageGetDepts";
    Map<String, Object> params = new HashMap<>();
    String openId = "当前操作用户的openId";

    params.put("key", "在高德开放平台申请的key");
    params.put("openId", openId);
    params.put("bizToken", "在高德开放平台申请的bizToken");
    String[] signArgs = new String[]{openId};
    params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));

    params.put("deptId", "部门ID");
    // 这里传分页的大小 例如10
    params.put("limit", 10);

    String response = MyHttpUtils.postFormUrlencoded(url, params);
    System.out.println(response);
}

返回参数

返回字段

含义

规则说明

data

数据体

List<DeptPageResultDTO>,DeptPageResultDTO的定义见文档末尾。

code

返回结果编码

1 表示成功

message

返回状态说明

成功时返回Successful,否则返回错误原因

version

版本号

字符串类型

timestamp

时间戳

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

字符串格式,长度30

状态码code

0:异常

1:成功

2:失败

3:参数错误

110001:成员不在组织内

110002:组织不存在

9. 分页获取部门的子部门列表和员工列表

请求地址

URL

https://restwia.amap.com/api/v1/wia/org/dept/pageGetDeptsAndEmps

请求方式

POST

签名参数

openId

特别注意:暂无。

请求参数

参数名

含义

规则说明

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

openId

高德开放用户ID

用户在高德的身份ID

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

deptId

部门ID

未传时,获取根部门下的数据

cursor

分页游标

第一次可为null,后面以上一次请求返回的结果为准

limit

分页大小

不能超过50

bizSign

业务签名

参考签名规则

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {

    String url = "https://restwia.amap.com/api/v1/wia/org/dept/pageGetDeptsAndEmps";
    Map<String, Object> params = new HashMap<>();
    String openId = "当前操作用户的openId";

    params.put("key", "在高德开放平台申请的key");
    params.put("openId", openId);
    params.put("bizToken", "在高德开放平台申请的bizToken");
    String[] signArgs = new String[]{openId};
    params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));

    params.put("deptId", "部门ID");
    // 这里传分页的大小 例如10
    params.put("limit", 10);

    String response = MyHttpUtils.postFormUrlencoded(url, params);
    System.out.println(response);
}

返回参数

返回字段

含义

规则说明

data

数据体

List<DeptAndEmpPageResultDTO>,DeptAndEmpPageResultDTO的定义见文档末尾。

code

返回结果编码

1 表示成功

message

返回状态说明

成功时返回Successful,否则返回错误原因

version

版本号

字符串类型

timestamp

时间戳

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

字符串格式,长度30

状态码code

0:异常

1:成功

2:失败

3:参数错误

110001:成员不在组织内

110002:组织不存在

对象实体信息定义

DeptInfoDTO

返回字段

含义

规则说明

orgId

企业ID

deptId

部门ID

superDeptId

父部门ID

deptName

部门名称

不超过20个字符

deptDesc

部门描述

不超过100个字符

deptLevel

部门级别

1-20级。

deptEmpCount

部门下去重后的员工个数

包括所有子部门里的员工

directSubDeptCount

部门下的直接子部门个数

directDeptEmpCount

部门下直属员工个数

不包括所有子部门里的员工

deptLink

部门链

List<DeptLinkElementDTO>,DeptLinkElementDTO的对象定义见下方。

DeptLinkElementDTO

返回字段

含义

规则说明

deptId

部门ID

deptName

部门名称

不超过20个字符

deptLevel

部门级别

1-20级。

DeptPageResultDTO

返回字段

含义

规则说明

nextCuosor

下一次分页请求要传入的游标

hasMore

是否还有更多数据

deptList

部门列表

List<DeptInfoDTO>,DeptInfoDTO的定义见上文。

DeptAndEmpPageResultDTO

返回字段

含义

规则说明

nextCuosor

下一次分页请求要传入的游标

hasMore

是否还有更多数据

deptList

部门列表

List<DeptInfoDTO>,DeptInfoDTO的定义见上文。

empList

员工列表

List<EmpInfoDTO>,EmpInfoDTO的定义见下文。

EmpInfoDTO

返回字段

含义

规则说明

orgId

企业ID

empId

员工ID

openId

用户的身份ID

empNickName

员工昵称

empIconImage

员工头像

返回顶部 示例中心 常见问题 智能客服 公众号
二维码