订阅配置管理 最后更新时间: 2024年07月04日

 产品介绍

通过订阅配置中的回调地址，进行数据回调，目前调用方式仅支持http调用。

管理订阅：您还可以通过接口添加、修改或查询订阅，管理回调地址和需要监听消息内容。

 注意：

货车监管等一个企业管理多个小程序场景需要走人工配置！！！请联系对接人员添加

适用场景

• 目前支持共享位置回调，任务处理回调

使用限制

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

使用说明

接收请求返回的数据（JSON或XML格式），参考返回参数文档解析数据。

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

1、消息订阅、回调地址配置新增

请求地址：

url 请求参数

body请求参数

示例代码（以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 requestUrl = "https://restwia.amap.com/api/v1/wia/subscription/create"
        Map<String, Object> params1 = new HashMap<>();
        param1.put("key", "在高德开放平台申请的key");
        param1.put("openId", "当前操作用户的openId");
        param1.put("bizToken", "在高德开放平台申请的bizToken");
        //计算bizSign
        String[] signArgs = new String[]{"openid","bizToken"};//获取业务参数，用于签名计算
        params1.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));//业务签名

        Map<String, Object> params2 = new HashMap<>();
        params2.put("orgId",env.getOrgId());
        params2.put("eventTypeList",eventTypeList);
           //事件类型集合
        String eventTypeList = "user.location_share, task.create, task.refuse, task.subtask_status_change";
        params2.put("subscriptionUrl","123.com");//订阅地址
        params2.put("withOriginalData",true);//是否发送原文
        params2.put("timeoutInMillisecond",1);//超时时间
        params2.put("cryptKey","bcdedit");
        requestUrl = MyHttpUtils.attachParamsToUrl(requestUrl,params1);
        String response = MyHttpUtils.postApplicationJson(requestUrl,JSONObject.toJSONString(params2));

}

返回参数

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

返回示例

{
    "data": null,
    "code": 1,
    "message": "Successful",
    "result": true,
    "version": "1.0",
    "timestamp": 1701142286019,
    "requestId": "1eb5d12017011422856761177d14ca"
}

2、消息订阅、回调地址配置查询

请求地址：

url 请求参数

body请求参数

示例代码（以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 requestUrl = "https://restwia.amap.com/api/v1/wia/subscription/get"

        //公共参数
        Map<String, Object> params = new HashMap<>();
        param.put("key", "在高德开放平台申请的key");
        param.put("openId", "当前操作用户的openId");
        param.put("bizToken", "在高德开放平台申请的bizToken");
        //计算bizSign
        String[] signArgs = new String[]{"openId","bizToken"};//获取业务参数，用于签名计算
        params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));//业务签名
        //body
        Map<String, Object> params1 = new HashMap<>();
        params1.put("orgId",env.getOrgId());
        requestUrl = MyHttpUtils.attachParamsToUrl(requestUrl,params);
        String response = 
                    MyHttpUtils.postApplicationJson(requestUrl,JSONObject.toJSONString(params1));
}

返回参数

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

返回示例：

{
    "data": {
        "orgId": "1234",
        "eventTypeList": "user.location_share, task.create, task.refuse, task.subtask_status_change",
        "subscriptionUrl": "https://www.abc.com/",
        "timeoutInMilliSecond": 1,
        "cryptKey": "11122211"
    },
    "code": 1,
    "message": "Successful",
    "result": true,
    "version": "1.0",
    "timestamp": 1701141860798,
    "requestId": "1eb5d12017011418605751084d14ca"
}

3、消息订阅、回调地址配置修改

请求地址：

url 请求参数

body请求参数

注：eventTypeList，subscriptionUrl，timeoutInMilliSecond，cryptKey，其中至少一个参数非空

示例代码（以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 requestUrl = "https://restwia.amap.com/api/v1/wia/subscription/update"
        Map<String, Object> params1 = new HashMap<>();
        param1.put("key", "在高德开放平台申请的key");
        param1.put("openId", "当前操作用户的openId");
        param1.put("bizToken", "在高德开放平台申请的bizToken");
        //计算bizSign
        String[] signArgs = new String[]{"openid","bizToken"};//获取业务参数，用于签名计算
        params1.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));//业务签名

        Map<String, Object> params2 = new HashMap<>();
        params2.put("orgId",env.getOrgId());
        params2.put("eventTypeList",eventTypeList);
           //事件类型集合
        String eventTypeList = "user.location_share, task.create, task.refuse, task.subtask_status_change";
        params2.put("subscriptionUrl","123.com");//订阅地址
        params2.put("withOriginalData",true);//是否发送原文
        params2.put("timeoutInMillisecond",1);//超时时间
        params2.put("cryptKey","bcdedit");
        requestUrl = MyHttpUtils.attachParamsToUrl(requestUrl,params1);
        String response = 
              MyHttpUtils.postApplicationJson(requestUrl,JSONObject.toJSONString(params2));
}

返回参数

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

返回示例

{
    "data": null,
    "code": 1,
    "message": "Successful",
    "result": true,
    "version": "1.0",
    "timestamp": 1701142286019,
    "requestId": "1eb5d12017011422856761177d14ca"
}

附：事件类型入参说明