开发 地图小程序OPENAPI 开发指南 工作地图 地图成员管理

地图成员管理 最后更新时间: 2024年08月30日

1. 添加地图成员

请求地址

URL

https://restwia.amap.com/api/v1/wia/core/member/add

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

特别注意:暂无。

请求参数

参数名

含义

规则说明

参数类型

是否必填

缺省值

key

请求服务权限标识 

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

sting

openId

高德开放用户ID

用户在高德的身份ID

sting

workMapId

地图id

创建地图后返回的地图ID

sting

bizToken

工作地图身份token

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

sting

bizSign

业务签名

签名参数:workMapId (参考签名规则

sting

示例代码(以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/core/member/add";
    Map<String, Object> params = new HashMap<>();
    params.put("key","在高德开放平台申请的key");
    params.put("bizToken","在高德开放平台申请的bizToken");
    params.put("openId","当前操作用户的openId");
    params.put("workMapId", "工作地图id");
    String[] signArgs = new String[]{"工作地图id"};
    params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));
    String response = MyHttpUtils.postFormUrlencoded(url, params);
}

返回参数

返回字段

含义

参数类型

规则说明

data

数据体

object

无数据

code

返回结果编码

number

1 表示成功

message

返回状态说明

string

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

version

版本号

string

字符串类型

timestamp

时间戳

number

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

requestId

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

string

字符串格式,长度30

附表

0、异常

1、成功

2、失败

3、参数错误

120002、用户下地图数量已达上限

120003、地图不存在

120005、地图人数超过限制

120006、加入地图已提交申请

2. 移除地图成员

请求地址

URL

https://restwia.amap.com/api/v1/wia/core/member/delete

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

特别注意:暂无。

请求参数

参数名

含义

规则说明

是否必填

参数类型

缺省值

key

请求服务权限标识 

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

string

openId

高德开放用户ID

用户在高德的身份ID

string

workMapId

地图id

创建地图后返回的地图ID

string

bizToken

工作地图身份token

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

string

bizSign

业务签名

签名参数:workMapId (参考签名规则

string

示例代码(以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/core/member/delete";
        Map<String, Object> params = new HashMap<>();
        params.put("key","在高德开放平台申请的key");
        params.put("bizToken","在高德开放平台申请的bizToken");
        params.put("openId","当前操作用户的openId");
        params.put("workMapId", "要移除的工作地图id");
        String[] signArgs = new String[]{"要移除的工作地图id"};
        params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));
        String response = MyHttpUtils.postFormUrlencoded(url, params);
}

返回参数

返回字段

含义

参数类型

规则说明

data

数据体

object

无数据

code

返回结果编码

number

1 表示成功

message

返回状态说明

string

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

version

版本号

sring

字符串类型

timestamp

时间戳

number

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

requestId

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

sring

字符串格式,长度30

附表

0、异常

1、成功

2、失败

3、参数错误

120003、地图不存在

3.翻页查询某个地图下的成员列表

请求地址

URL

https://restwia.amap.com/api/v1/wia/core/member/list

请求方式

GET

请求参数

参数名

含义

规则说明

参数类型

是否必填

缺省值

key

请求服务权限标识 

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

string

openId

高德开放用户id

用户在高德的身份id

string

bizToken

工作地图身份token

string

workMapId

地图id

-

string

pageSize

每页返回的数量

100及以内的正整数

number

50

cursorId

偏移量

首次请求的时候可以为空,后续每一次请求按照上一次请求返回的cursorId 传

string

groupState

群组状体

1-有效状态

0-其他状态

不填默认查询所有人

number

bizSign

业务签名

签名参数:workMapId(参考签名规则

string

示例代码(以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/core/member/list";
    Map<String, Object> params = new HashMap<>();
    String openId = "当前操作用户的openId";
    String workMapId = "工作地图id";
    params.put("key","在高德开放平台申请的key");
    params.put("openId",openId);
    params.put("bizToken","在高德开放平台申请的bizToken");
    params.put("workMapId", workMapId);
    params.put("pageSize", 20);
    String[] signArgs = new String[]{workMapId };
    params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret",signArgs));

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

返回参数

返回字段

含义

参数类型

规则说明

data

{
		"dataList": [{
			"openId": "kjvznCj8HusCNALjKd0lMfMqwK4dzik7KNM3Wc",
			"nickName": "用户昵称",
			"icon": "http://img-cdn-test.amap.com/g/avatar/13.png?ver=1686661244&imgoss=1", /*用户头像地址*/
			"gmtCreate": 1686542542000, /*创建时间*/
			"gmtModified": 1689598711000,/*修改时间*/
			"role": 1  /*1为超管,2为管理员,3为成员*/
		}, {
			"openId": "LJBvKJ7EcasfasdYA757hJhbxFad0lMfMqwK4dzik7KNM3Wc",
			"empNickName": "用户2",
			"empIconImage": "http://img-cdn-test.amap.com/pp/avatar/134/cd/8f/64692185.jpg?ver=1656056768&imgoss=1",
			"gmtCreate": 1686908525000,
			"gmtModified": 1686908525000,
			"role": 3
		}],
		"nextCursor": "648c2e6cef4b0b1a0aaf1626",
		"hasMore": 0
	}

数据体

object

code

返回结果编码

number

1 表示成功

message

返回状态说明

string

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

version

版本号

string

字符串类型

timestamp

时间戳

number

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

requestId

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

string

字符串格式,长度30

附表

0、异常

1、成功

2、失败

3、参数错误

4.批量查询某个地图下的成员列表

请求地址

URL

https://restwia.amap.com/api/v1/wia/core/member/query

请求方式

POST

请求类型ContenType

application/json

请求参数

参数名

含义

规则说明

参数类型

是否必填

缺省值

key

请求服务权限标识 

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

string

openId

高德开放用户id

用户在高德的身份id

string

bizToken

工作地图身份token

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

string

workMapId

地图id

-

string

bizSign

业务签名

签名参数:workMapId(参考签名规则

string

请求body

参数名

含义

规则说明

参数类型

是否必填

缺省值

openIds

要请求的openId 列表

不能为空,一次最多20个

字符串组成的数组

示例代码(以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/core/member/query";
    Map<String, Object> params = new HashMap<>();
    String openId = "当前操作用户的openId";
    String workMapId = "工作地图id";
    params.put("key","在高德开放平台申请的key");
    params.put("openId",openId);
    params.put("bizToken","在高德开放平台申请的bizToken");
    params.put("workMapId", workMapId);
    String[] signArgs = new String[]{workMapId };
    params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret",signArgs));

    url = MyHttpUtils.attachParamsToUrl(url, params);
    String json = "{\"openIds\":[\"kjvznC8HuNALsgotrjKd0lMfMq4dzik7KN3Wc\",\"LJBvKJ7E-YA757hJhxFad0lMfMqw4dzik7NM3Wc\"]}";

    
    String response = MyHttpUtils.postApplicationJson(url, json);
    System.out.println(response);
}

返回参数

响应结果的格式为 JSON 形式,以下是参数说明

参数名

含义

参数类型

规则说明

data

object

dataList

array

openId

string

nickName

用户昵称

string

icon

头像

string

gmtCreate

创建时间

number

gmtModified

修改时间

number

role

成员身份

number

groupState

群组状体

number

0—解散或退群

1—有效

2—退出im但im计算未读数

100—未知

nextCursor

游标

string

hashMore

number

code

返回结果编码

number

1 表示成功

message

返回状态说明

string

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

version

版本号

string

timestamp

时间戳

number

requestId

请求id

string

返回示例

{
    "data": {
        "dataList": [
            {
                "openId": "SIiu5IvFoztHdSrcuNc_2ad0lMfMqwK4dzik7KNM3Wc",
                "nickName": "陆小果",
                "icon": "http://img-cdn-test.amap.com/pp/avatar/b2f/3a/e3/70300371.jpeg?ver=1698826935&imgoss=1",
                "groupState": 1,
                "gmtCreate": 1709105635000,
                "gmtModified": 1709105635000,
                "role": 3
            },
            {
                "openId": "-5sDuwCzUMnRAVhWbz4A1Kd0lMfMqwK4dzik7KNM3Wc",
                "nickName": "在摩托车旁的西湖",
                "icon": "http://img-cdn-test.amap.com/g/avatar/15.png?ver=1698391018&imgoss=1",
                "groupState": 1,
                "gmtCreate": 1714371019000,
                "gmtModified": 1714371019000,
                "role": 1
            }
        ]
    },
    "code": 1,
    "message": "Successful",
    "result": true,
    "version": "1.0",
    "timestamp": 1714464037796,
    "requestId": "1eb5d1dd17144640363601002d1e2b"
}

附表

0、异常

1、成功

2、失败

3、参数错误

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