目的地-实时通知服务
简要描述
目的地-实时消息服务通过订阅车辆的方式，实时计算货物到达情况
说明
本服务包含 6 个接口：自定义区域注册接口，多边形区域注册接口，车辆订阅接口，车 辆驶入事件接口，删除车辆订阅接口，删除自定义区域注册接口。
规则
1.有多边形（多边形区域注册接口）和圆形（自定义区域注册接口）
2.根据实际接口要求，传入指定的坐标系，小数点后 7 位，经度与纬度以英文逗号隔开。
3.多边形围栏，第一个坐标点与最后一个坐标点必须一样。目前仅支持 1200 个字符，即 57 个坐标点围成
4.订阅类型为指定车辆。企业仅允许指定车辆。政府才能使用全国车辆。
5.事件类型：指监控进区域还是出区域。这里默认进区域。
6.围栏生命周期：注册后 1 分钟生效；直至围栏删除。
7.围栏删除的情况：①、直接删除围栏。但若该围栏有被车辆订阅且订阅车辆经过围栏时，该围栏会被重新 启用。 ②、删除订阅车辆。若该围栏下没有其他绑定的订阅车辆，围栏也会被删除；反之围栏 不会被删除。 ③、用户账号到期，围栏会自动删除。
8.提醒：注册车辆和围栏后，使用完成请及时删除，长期不删除，车辆进出围栏会一 直推送消息，扣费较多（按推送扣费）
Header
请求前都需要设置Token
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| Token | 是 | string | 应用令牌 |
自定义区域注册接口
请求地址
/v4/api/fence/operateFenceAreaReg请求方式
POST
请求参数
| 参数名 | 必选 | 类型 | 层级 | 说明 | 示例 |
|---|---|---|---|---|---|
| areaname | 是 | string | 1 | 自定义区域名称（名称不能超 25个字符，不能包含特殊字符，比如下划线） | 北仑港 |
| lonlat | 是 | string | 1 | 自定义区域坐标(GCJ02 高德坐标系，小数点后小于等于 7 位)，格式：经度,纬度二者以英文逗号分隔 | 121.84431,29.89889 |
| radius | 是 | string | 1 | 半径（米），大于 0 | 30000 |
| type | 是 | string | 1 | 订阅类型：1：指定车辆 | 1 |
| actiontype | 是 | string | 1 | 事件类型 1：进区域通知 | 1 |
json
{
"areaname":"北仑港2",
"lonlat":"121.84431,29.89889",
"radius":"10",
"type":"1",
"actiontype":"1"
}返回参数
| 参数名 | 类型 | 层级 | 说明 |
|---|---|---|---|
| code | int | 1 | 状态码 |
| msg | string | 1 | 请求结果 |
| total | int | 1 | 返回总条数 |
| requestId | string | 1 | 请求编号 |
| data | object | 1 | 返回数据 |
data
| 输出参数名称 | 输出参数字段 | 示例数据 | 备注 |
|---|---|---|---|
| 自定义区域ID | areaid | 8821***29396 | 当注册成功时返回自定义区域ID，失败时为空 |
| 状态 | state | 1 | 1：注册成功，2：注册失败 |
| 返回示例 |
json
{
"code": 200,
"data": {
"areaid": "48821***29396",
"state": "1"
},
"msg": "业务处理成功",
"total": null,
"requestId": "c14c55c1-81280"
}多边形区域注册接口
请求地址
/v4/api/fence/operateFenceAreaPolygonReg请求方式
POST
请求参数
| 参数名 | 必选 | 类型 | 层级 | 说明 | 示例 |
|---|---|---|---|---|---|
| areaname | 是 | string | 1 | 自定义区域名称（名称不能超 25个字符，不能包含特殊字符，比如下划线，名称不能重复） | 北仑港 |
| lonlats | 是 | string | 1 | GCJ02 高德坐标系，自定义区域坐标(小数点后小于等于 7 位)，格式：经度,纬度二者以英文逗号分隔,多个坐标用|分割。 | 113.796387,41.19519|118.410645,41.228249| 117.773438,40.245992|116.015625,40.212441|114.938965,39.520992|113.796387,41.19519 |
| type | 是 | string | 1 | 订阅类型：1：指定车辆 | 1 |
| actiontype | 是 | string | 1 | 事件类型 1：进区域通知 | 1 |
| coorType | 是 | string | 1 | 坐标类型 1.谷歌、2.百度、3.高德 | 3 |
json
{
"areaname":"北仑港2",
"lonlats":"121.84431,29.89889|118.410645,41.228249|117.773438,40.245992|121.84431,29.89889",
"actiontype":"1",
"type":"1",
"coorType":"3"
}返回参数
| 参数名 | 类型 | 层级 | 说明 |
|---|---|---|---|
| code | int | 1 | 状态码 |
| msg | string | 1 | 请求结果 |
| total | int | 1 | 返回总条数 |
| requestId | string | 1 | 请求编号 |
| data | object | 1 | 返回数据 |
| data |
| 输出参数名称 | 输出参数字段 | 示例数据 | 备注 |
|---|---|---|---|
| 自定义区域ID | areaid | 686315 | 当注册成功时返回自定义区域ID，失败时为空 |
| 状态 | state | 1 | 1：注册成功，2：注册失败，3：重复注册 |
| 返回示例 |
json
{
"code": 200,
"data": {
"areaid": "686315******1233",
"state": "1"
},
"msg": "业务处理成功",
"total": null,
"requestId": "d0319f94-81786"
}车辆订阅接口
请求地址
/v4/api/fence/operateFenceSubscribe请求方式
POST
请求参数
| 参数名 | 必选 | 类型 | 层级 | 说明 | 示例 |
|---|---|---|---|---|---|
| vnos | 是（最大支持 50 个） | string | 1 | 车牌号_车牌颜色，英文逗号分隔车牌颜色：1 蓝色，2 黄色 | 京A12345_1 |
| areaid | 是 | string | 1 | 自定义区域 ID | 85225156456 |
json
{
"vnos":"鲁RT5**_2",
"areaid":"6863**552747412993"
}返回参数
| 参数名 | 类型 | 层级 | 说明 |
|---|---|---|---|
| code | int | 1 | 状态码 |
| msg | string | 1 | 请求结果 |
| total | int | 1 | 返回总条数 |
| requestId | string | 1 | 请求编号 |
| data | object | 1 | 返回数据 |
data
| 输出参数名称 | 输出参数字段 | 示例数据 | 备注 |
|---|---|---|---|
| 结果 | result | 2 | 1：成功，2：自定义区域 ID 不存在 |
json
{
"code": 200,
"data": {
"result": "2"
},
"msg": "业务处理成功",
"total": null,
"requestId": "1292fecf-285567"
}车辆驶入事件通知
你们需要提供一个 POST 请求接口，Content-Type为application/json，接收以下所有参数。入参列表如下：
参数
| 参数名 | 类型 | 层级 | 说明 |
|---|---|---|---|
| vno | string | 1 | 车牌号 |
| plateColor | string | 1 | 车牌颜色 1 蓝色，2 黄色 |
| areaId | string | 1 | 区域 ID |
| areaName | string | 1 | 区域名称 |
| type | string | 1 | 事件类型 1：进区域 |
| utc | string | 2 | 时间：UTC 格式精确到毫秒 |
| lon | string | 2 | 车辆位置-经度 |
| lat | string | 2 | 车辆位置-纬度 |
车辆取消订阅接口
请求地址
/v4/api/fence/operateFenceUnsubscribe请求方式
POST
请求参数
| 参数名 | 必选 | 类型 | 层级 | 说明 | 示例 |
|---|---|---|---|---|---|
| vnos | 是 | string | 1 | 车牌号_车牌颜色，英文逗号分隔，一次请求最多 100 个车牌号 车牌颜色：1 蓝色，2 黄色 | 京 A12345_1,京 B12345_2 |
| areaid | 是 | string | 1 | 自定义区域 ID | 48649262BA33928BE050A8C0366804C9 |
json
{
"vnos" : "鲁R**9_2",
"areaid": "4882**45451529396"
}返回参数
| 参数名 | 类型 | 层级 | 说明 |
|---|---|---|---|
| code | int | 1 | 状态码 |
| msg | string | 1 | 请求结果 |
| total | int | 1 | 返回总条数 |
| requestId | string | 1 | 请求编号 |
| data | object | 1 | 返回数据 |
data
| 输出参数名称 | 输出参数字段 | 示例数据 | 备注 |
|---|---|---|---|
| 结果 | result | 2 | 1：成功，2：自定义区域 ID 不存在 |
json
{
"code": 200,
"data": {
"result": "2"
},
"msg": "业务处理成功",
"total": null,
"requestId": "1292fecf-285567"
}删除自定义区域注册接口
请求地址
/v4/api/fence/operateFenceAreaUnReg请求方式
POST
请求参数
| 参数名 | 必选 | 类型 | 层级 | 说明 | 示例 |
|---|---|---|---|---|---|
| areaid | 是 | string | 1 | 自定义区域 ID | 48649262BA33928BE050A8C0366804C9 |
json
{
"areaid":"48821367454***529396"
}返回参数
| 参数名 | 类型 | 层级 | 说明 |
|---|---|---|---|
| code | int | 1 | 状态码 |
| msg | string | 1 | 请求结果 |
| total | int | 1 | 返回总条数 |
| requestId | string | 1 | 请求编号 |
| data | object | 1 | 返回数据 |
data
| 输出参数名称 | 输出参数字段 | 示例数据 | 备注 |
|---|---|---|---|
| 结果 | result | 2 | 1：成功，2：自定义区域 ID 不存在，3：已删除 |
json
{
"code": 200,
"data": {
"result": "2"
},
"msg": "业务处理成功",
"total": null,
"requestId": "1292fecf-285567"
}