产品介绍
通过订阅配置中的回调地址，进行数据回调，目前调用方式仅支持http调用。
管理订阅：您还可以通过接口添加、修改或查询订阅，管理回调地址和需要监听消息内容。
注意：
货车监管等一个企业管理多个小程序场景需要走人工配置！！！请联系对接人员添加
适用场景
使用限制
详细的服务调用量限制可点我查阅。
使用说明
接收请求返回的数据（JSON或XML格式），参考返回参数文档解析数据。
如无特殊声明，接口的输入参数和输出数据编码全部统一为 UTF-8 编码方式。
1、消息订阅、回调地址配置新增
请求地址：
url 请求参数
参数名 | 含义 | 规则 | 参数类型 | 是否必填 |
key | 高德Key | 用户在高德地图官网申请Web服务API类型Key | String | 必填 |
bizToken | 工作地图身份token | 用户申请的工作地图身份token，一个企业一个token | String | 必填 |
openId | 当前操作人 | 高德用户的开放id | String | 必填 |
sig | 数字签名 | 请参考数字签名获取和使用方法 | String | 选填 |
bizSign | 业务签名 | 签名参数openId，bizToken（参考签名规则） | String | 必填 |
body请求参数
参数名 | 含义 | 规则 | 参数类型 | 是否必填 |
orgId | 企业组织id |
| String | 必填 |
eventTypeList | 事件类型集合 | 类型之间用 ‘,’英文分隔 示例： “user.location_share,task.subtask_status_change”，详细见文档尾部 | String | 必填 |
subscriptionUrl | 回调地址 | 回调地址规定： 返回body 中必须包含 code ， code = 1 为处理正确 | String | 必填 |
timeoutInMilliSecond | 超时时间 | 超时时间不能超过 1500 ms | Number | 必填 |
cryptKey | 密钥 | 加解密工具 用于加密机密工具的key | String | 必填 |
返回参数
响应结果的格式为 JSON 形式，以下是参数说明
参数名 | 含义 | 参数类型 | 规则说明 |
data | 返回结果数据 | Object | 新增接口data返回为null |
code | 返回结果状态值 | Number |
|
message | 返回状态说明 | String | 成功时返回Successful，否则返回错误原因 |
result | 结果 | Boolean | true或false |
version | 版本信息 | String |
|
timestamp | 时间戳 | Number |
|
requestId | 请求id | String |
|
返回示例
{
"data": null,
"code": 1,
"message": "Successful",
"result": true,
"version": "1.0",
"timestamp": 1701142286019,
"requestId": "1eb5d12017011422856761177d14ca"
}
2、消息订阅、回调地址配置查询
请求地址：
url 请求参数
参数名 | 含义 | 规则 | 参数类型 | 是否必填 |
key | 高德Key | 用户在高德地图官网申请Web服务API类型Key | String | 必填 |
bizToken | 工作地图身份token | 用户申请的工作地图身份token，一个企业一个token | String | 必填 |
openId | 当前操作人 | 高德用户的开放id | String | 必填 |
sig | 数字签名 | 请参考数字签名获取和使用方法 | String | 选填 |
bizSign | 业务签名 | 签名参数openId，bizToken（参考签名规则） | String | 必填 |
body请求参数
参数名 | 含义 | 规则 | 参数类型 | 是否必填 |
orgId | 企业组织id |
| String | 必填 |
返回参数
响应结果的格式为 JSON 形式，以下是参数说明
参数名 | 含义 | 参数类型 | 规则说明 |
data | 返回结果数据 | Object |
|
| orgId | 企业组织id | String |
|
| eventTypeList | 事件类型集合 | String |
|
| subscriptionUrl | 回调地址 | String |
|
| timeoutInMilliSecond | 超时时间 | Number |
|
| cryptKey | 密钥 | String |
|
code | 返回结果状态值 | Number |
|
message | 返回状态说明 | String | 成功时返回Successful，否则返回错误原因 |
result | 结果 | Boolean | true或false |
version | 版本信息 | String |
|
timestamp | 时间戳 | Number |
|
requestId | 请求id | String |
|
返回示例：
{
"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 请求参数
参数名 | 含义 | 规则 | 参数类型 | 是否必填 |
key | 高德Key | 用户在高德地图官网申请Web服务API类型Key | String | 必填 |
bizToken | 工作地图身份token | 用户申请的工作地图身份token，一个企业一个token | String | 必填 |
openId | 当前操作人 | 高德用户的开放id | String | 必填 |
sig | 数字签名 | 请参考数字签名获取和使用方法 | String | 选填 |
bizSign | 业务签名 | 签名参数openId，bizToken（参考签名规则） | String | 必填 |
body请求参数
参数名 | 含义 | 规则 | 参数类型 | 是否必填 |
orgId | 企业组织id |
| String | 必填 |
eventTypeList | 事件类型集合 | 类型之间用 ‘，’分隔 示例： “type1,type2”，详细见文档尾部 | String | 选填 |
subscriptionUrl | 回调地址 |
| String | 选填 |
timeoutInMilliSecond | 超时时间 | 大于0 | Number | 选填 |
cryptKey | 密钥 |
| String | 选填 |
注：eventTypeList，subscriptionUrl，timeoutInMilliSecond，cryptKey，其中至少一个参数非空
返回参数
响应结果的格式为 JSON 形式，以下是参数说明
参数名 | 含义 | 参数类型 | 规则说明 |
data | 返回结果数据 | Object | 修改接口data返回为null |
code | 返回结果状态值 | Number |
|
message | 返回状态说明 | String | 成功时返回Successful，否则返回错误原因 |
result | 结果 | Boolean | true或false |
version | 版本信息 | String |
|
timestamp | 时间戳 | Number |
|
requestId | 请求id | String |
|
返回示例
{
"data": null,
"code": 1,
"message": "Successful",
"result": true,
"version": "1.0",
"timestamp": 1701142286019,
"requestId": "1eb5d12017011422856761177d14ca"
}
附：事件类型入参说明
序号 | 事件类型 | 含义 |
1 | user.location_share | 用户位置共享 |
2 | task.create | 任务创建（父任务） |
3 | task.refuse | 父任务拒绝 |
4 | task.start | 父任务开始 |
5 | task.subtask_status_change | 子任务状态变更 |
