视频上云

添加视频上传配置

接口描述: 根据传入信息创建视频上传配置。

接口地址: https://yd.yunding360.com/openapi/videos/event_plans

请求方式: POST

请求示例：

{
  "cycleType": "WEEKLY",
  "executeStatus": true,
  "name": "测试配置名称",
  "recordingTime": [
    {
       "endTime": "09:10:00",
       "startTime": "09:00:00"
    }
  ],
  "storeId": "88e707a0-8f71-11ea-a373-0dbaaa1f5c86",
  "uploadTime": [
    {
      "endTime": "09:10:00",
      "startTime": "09:00:00"
    }
  ],
  "videoDuration": 600,
  "weeklyRule": [
    1,2
  ]
}

请求参数

参数名称	参数说明	in	是否必须	数据类型	schema
eventPlanCreate	eventPlanCreate	body	true	视频任务记录	视频任务记录

schema属性说明

购买记录数据(POS单数据)

参数名称	参数说明	请求类型	是否必须	数据类型	schema
name	任务名称,长度 20 以内，字符不限	body	true	string
storeId	门店 ID,填写单个门店 ID	body	true	string
recordingTime	视频时间	body	true	array	时间段
uploadTime	文件上传时间	body	true	array	时间段
cycleType	上传循环周期类型; CURRENT_DAY("仅当日"),WEEKLY("每周"),CUSTOM("自定义")	body	true	enum
weeklyRule	每周规则	body	false	array
customRule	自定义规则	body	false	array
videoDuration	视频文件时长(秒)	body	true	int
executeStatus	执行状态	body	false	bool

时间段

参数名称	参数说明	请求类型	是否必须	数据类型	schema
startTime	开始时间(HH:mm:ss)	body	true	string
endTime	结束时间(HH:mm:ss)	body	true	string

响应示例

{
    "id": "3c24f470-fbfb-11eb-a463-bfa503074e55",
    "createdTime": 1628834202936,
    "creator": null,
    "modifiedTime": 1628834202936,
    "modifier": null,
    "name": "配置名称",
    "nameMap": {},
    "eventPlanType": "VIDEO",
    "areaType": null,
    "groupIds": null,
    "storeIds": ["6abdb260-3fb8-11e9-9d1e-d395929c703a"],
    "executeStatus": true,
    "executeRule": {
        "recordingTime": [{
            "startTime": "09:09:00",
            "endTime": "09:11:00"
        }],
        "videoDuration": 600,
        "uploadTime": [{
            "startTime": "09:09:00",
            "endTime": "09:12:00"
        }],
        "cycleType": "CURRENT_DAY",
        "weeklyRule": null,
        "customRule": null
    },
    "cronExpression": null,
    "uuid": "3c24f470-fbfb-11eb-a463-bfa503074e55"
}

响应参数

参数名称	参数说明	类型	schema
eventPlan	计划配置	string	计划配置

计划配置

参数名称	参数说明	类型	schema
id	名称	string	计划配置
createdTime	创建时间	long
creator	创建人	string
modifiedTime	更新时间	long
modifier	更新人	string
name	名称	string	计划配置
eventPlanType	任务类型 VIDEO(视频上传)	string
areaType	任务类型 VIDEO(视频上传)	string
storeIds	门店id	array
executeStatus	执行状态	bool
executeRule	执行状态	bool	任务执行规则
cronExpression	cron表达式	string

任务执行规则

参数名称	参数说明	类型	schema
id	名称	string	计划配置
recordingTime	视频录制时间段	array	时间段
videoDuration	创建人	int
modifiedTime	视频文件时长	long
uploadTime	上传时间	array	时间段
cycleType	上传循环周期类型 CURRENT_DAY(仅当日),WEEKLY(每周),CUSTOM(自定义)	enum
weeklyRule	每周规则	array
customRule	自定义规则	array

时间段

参数名称	参数说明	类型	schema
startTime	开始时间	string
endTime	结束时间	string

修改配置状态

接口描述: 对视频任务状态进行切换。

接口地址: https://yd.yunding360.com/openapi/videos/event_plans/{planId}/switch/{status}

请求方式: POST

请求参数

参数名称	参数说明	in	是否必须	数据类型	schema
planId	配置id	path	true	string
status	状态	path	true	bool

响应示例

{
    "id": "3c24f470-fbfb-11eb-a463-bfa503074e55",
    "createdTime": 1628834202936,
    "creator": null,
    "modifiedTime": 1628834202936,
    "modifier": null,
    "name": "测试配置名称",
    "nameMap": {},
    "eventPlanType": "VIDEO",
    "areaType": null,
    "groupIds": null,
    "storeIds": ["6abdb260-3fb8-11e9-9d1e-d395929c703a"],
    "executeStatus": true,
    "executeRule": {
        "recordingTime": [{
            "startTime": "09:09:00",
            "endTime": "09:11:00"
        }],
        "videoDuration": 600,
        "uploadTime": [{
            "startTime": "09:09:00",
            "endTime": "09:12:00"
        }],
        "cycleType": "CURRENT_DAY",
        "weeklyRule": null,
        "customRule": null
    },
    "cronExpression": null,
    "uuid": "3c24f470-fbfb-11eb-a463-bfa503074e55"
}

响应参数

参数名称	参数说明	类型	schema
eventPlan	计划配置	string	计划配置

计划配置

参数名称	参数说明	类型	schema
id	名称	string	计划配置
createdTime	创建时间	long
creator	创建人	string
modifiedTime	更新时间	long
modifier	更新人	string
name	名称	string	计划配置
eventPlanType	任务类型 VIDEO(视频上传)	string
areaType	任务类型 VIDEO(视频上传)	string
storeIds	门店id	array
executeStatus	执行状态	bool
executeRule	执行状态	bool	任务执行规则
cronExpression	cron表达式	string

任务执行规则

参数名称	参数说明	类型	schema
id	名称	string	计划配置
recordingTime	视频录制时间段	array	时间段
videoDuration	创建人	int
modifiedTime	视频文件时长	long
uploadTime	上传时间	array	时间段
cycleType	上传循环周期类型 CURRENT_DAY(仅当日),WEEKLY(每周),CUSTOM(自定义)	enum
weeklyRule	每周规则	array
customRule	自定义规则	array

时间段

参数名称	参数说明	类型	schema
startTime	开始时间	string
endTime	结束时间	string

查询所有事件任务配置

接口描述: 分页查询配置

接口地址: https://yd.yunding360.com/openapi/videos/findAllVideoConfig

请求方式: POST

请求示例：

{
  "groupId": "88e707a0-8f71-11ea-a373-0dbaaa1f5c86",
  "storeId": "6abdb260-3fb8-11e9-9d1e-d395929c703a",
  "name": "测试配置名称",
  "executeStatus": true,
  "startTime": 1628784000000,
  "endTime": 1628870399999
}

请求参数

参数名称	参数说明	in	是否必须	数据类型
groupId	门店组id	body	false	string
storeId	门店id	body	false	string
name	名称	body	false	string
executeStatus	状态	body	false	bool
startTime	开始时间	body	false	long
endTime	结束时间	body	false	long
page	页码默认第0页	param	false	int
size	页大小默认值10	param	false	int

响应示例

{
  "content": [
    {
      "id": "3c24f470-fbfb-11eb-a463-bfa503074e55",
      "createdTime": 1628834202936,
      "creator": null,
      "modifiedTime": 1628834202936,
      "modifier": null,
      "name": "daaa",
      "nameMap": {

      },
      "eventPlanType": "VIDEO",
      "areaType": null,
      "groupIds": null,
      "storeIds": [
        "6abdb260-3fb8-11e9-9d1e-d395929c703a"
      ],
      "storeAndUpperGroups": [
        {
          "storeId": "6abdb260-3fb8-11e9-9d1e-d395929c703a",
          "storeName": "瑞为人脸门店00",
          "groupId": "88e707a0-8f71-11ea-a373-0dbaaa1f5c86",
          "groupName": "22"
        }
      ],
      "executeStatus": true,
      "executeRule": {
        "recordingTime": [
          {
            "startTime": "09:09:00",
            "endTime": "09:11:00"
          }
        ],
        "videoDuration": 600,
        "uploadTime": [
          {
            "startTime": "09:09:00",
            "endTime": "09:12:00"
          }
        ],
        "cycleType": "CURRENT_DAY",
        "weeklyRule": null,
        "customRule": null
      },
      "cronExpression": null,
      "uuid": "3c24f470-fbfb-11eb-a463-bfa503074e55"
    }
  ],
  "metadata": {
    "size": 15,
    "totalElements": 1,
    "totalPages": 1,
    "page": 0
  }
}

响应参数

参数名称	参数说明	类型	schema
eventPlan	计划配置	string	计划配置

计划配置

参数名称	参数说明	类型	schema
id	名称	string	计划配置
createdTime	创建时间	long
creator	创建人	string
modifiedTime	更新时间	long
modifier	更新人	string
name	名称	string	计划配置
eventPlanType	任务类型 VIDEO(视频上传)	string
areaType	任务类型 VIDEO(视频上传)	string
storeIds	门店id	array
executeStatus	执行状态	bool
executeRule	执行状态	bool	任务执行规则
cronExpression	cron表达式	string
storeAndUpperGroups	门店及分组信息	array	门店及分组信息

任务执行规则

参数名称	参数说明	类型	schema
id	名称	string	计划配置
recordingTime	视频录制时间段	array	时间段
videoDuration	创建人	int
modifiedTime	视频文件时长	long
uploadTime	上传时间	array	时间段
cycleType	上传循环周期类型 CURRENT_DAY(仅当日),WEEKLY(每周),CUSTOM(自定义)	enum
weeklyRule	每周规则	array
customRule	自定义规则	array

时间段

参数名称	参数说明	类型	schema
startTime	开始时间	string
endTime	结束时间	string

门店及分组信息

参数名称	参数说明	类型
storeId	门店id	string
storeName	门店名称	string
groupId	门店组id	string
groupName	门店组名称	string

删除事件任务配置

接口描述: 通过id删除配置

接口地址: https://yd.yunding360.com/openapi/videos/deleteConfig/{uuid}

请求方式: DELETE

请求参数

参数名称	参数说明	in	是否必须	数据类型	schema
uuid	配置id	path	true	string

响应示例:

true

响应参数:

响应状态:

状态码	说明	schema
200	OK

Keys	Action
`?`	Open this help
`n`	Next page
`p`	Previous page
`s`	Search