1. 事件记录订阅

事件记录订阅接口

1.1. 事件记录数据订阅

基础信息

路径: /v1/api/sub/event/record/add

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
appKey string 否 用户appKey，如果不传入，就取当前请求携带的cappKey
pushUrls array 是 用户接收数据的url，产生的业务数据会推送到这个地址
  |─ string
eventTypes array 否 要订阅的事件类型，不传或者为空代表默认订阅全部事件类型
  |─ integer
eventLevels array 否 要订阅的事件等级（1、高；2、中；3、低），不传或者为空代表默认订阅全部事件等级
  |─ integer

Body示例:

{
  "appKey": "appkey1",
  "pushUrls": ["http://www.megivii.com/event/data/receive"],
  "eventTypes": [1002,1003],
  "eventLevels": [1,2,3]
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值

响应示例:

{
  "code": 0,
  "msg": "成功"
}

1.2. 解除事件记录订阅

基础信息

路径: /v1/api/sub/event/record/unbind

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
appKey string 否 用户appKey,如果没有传入，就取当前请求携带的cappKey，二者不能同时为空

Body示例:

{
  "appKey": "appkey01"
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值

响应示例:

{
  "code": 0,
  "msg": "成功"
}

1.3. 查询事件记录订阅

基础信息

路径: /v1/api/sub/event/record/query

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
appKey string 否 用户appKey,如果不传入，就取当前请求携带的cappKey，二者不能同时为空

Body示例:

{
  "appKey": "appkey1"
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值
  |─appKey string 否 用户appKey
  |─pushUrls array 是 用户接收数据的url
    |─ string
  |─eventTypes array 否 订阅的事件类型
    |─ integer
  |─eventLevels array 否 订阅的事件等级
    |─ integer

响应示例:

{
    "code": 0,
    "data": {
        "appKey": "appkey1",
        "eventLevels": [1,2,3],
        "eventTypes": [1002,1003,2002],
        "pushUrls": ["http://www.megivii.com/event/data/receive"]
    },
    "msg": "成功"
}

results matching ""

    No results matching ""