智慧商铺

TIP

请先阅读接口总体规范，再阅读此文档

TIP

级联数据查询说明（假设本应用绑定A企业，A企业下有级联B企业，B企业下级级联有C企业）： 1、storeId为空，isUnderLine为ture时，将查询本企业数据和直接级联企业数据，不查询直接级联企业的下属级联企业，也就是说，本接口查询到的数据包括A企业和B企业数据，不含C企业数据； 2、storeId为空，isUnderLine为false时，将查询本企业本级数据，不含企业B的级联数据； 3、storeId非空，支持查询本级A企业ID、B企业ID，若传入C企业ID或B企业子节点ID，接口响应为空。（通过接口【获取组织机构或子节点下设备列表】，可获取到B企业的虚拟ID,storeId支持传虚拟ID）

客流数据

客流统计

接口功能

支持按多时间维度，查询各节点的客流统计数据。

请求地址

https://open.qly.cmviot.cn/v3/open/api/ai/passengerFlow/queryRangeVisitor

请求方式

POST，需要鉴权

请求参数

参数名称	参数类型	是否必需	参数含义	说明
storeId	String	N	节点id	为空时查询根节点
queryDailyCode	int	Y	查询时间类型	1：今日 7：近7天 30：近30天 90：近90天
isUnderLine	boolean	N	是否查询直接级联企业节点	false：否（为空默认按否处理） true：是

请求示例

json

{
    "storeId":"696407703236186112",
    "queryDailyCode":30
}

响应参数

参数名称	参数类型	参数含义	说明
resultCode	String	响应码	参考响应码定义
resultMsg	String	响应描述
data	List<StatsDetail>	响应数据

StatsDetail 对象模型

名称	类型	参数含义	说明
captureCount	int	抓拍次数
statsDate	int	统计时间	时间类型为今日，本字段格式为 yyyyMMddHH 非今日，本字段格式为 yyyyMMdd=20210425

响应示例

json

{
    "resultCode": "000000",
    "resultMsg": "成功",
    "data": [
        {
            "captureCount": 555,
            "statsDate": 20210425
        }
    ]
}

查询客流的年龄分布

接口功能

支持按多时间维度，查询各节点的访客年龄分布。

请求地址

https://open.qly.cmviot.cn/v3/open/api/ai/passengerFlow/vreGroupByAge

请求方式

POST，需要鉴权

请求参数

参数名称	参数类型	是否必需	参数含义	说明
storeIds	List<String>	N	节点id集合	为空时查询根节点
dateType	int	Y	查询时间段	1：今日 2：近7日 3：近30日 4：近90日
isUnderLine	boolean	N	是否查询直接级联企业节点	false：否（为空默认按否处理） true：是

请求示例

json

{
    "dateType": 4,
    "storeIds": [
        "717605566773088256"
    ]
}

响应参数

参数名称	参数类型	参数含义	说明
resultCode	String	响应码	参考响应码定义
resultMsg	String	响应描述
data	Object	响应数据

data 数据模型

名称	类型	参数含义
unidentified	int	未识别出年龄的总访客人数
zero2twenty	int	识别为0-20岁的总访客人数
twenty2thirty	int	识别为20-30岁的总访客人数
thirty2forty	int	识别为30-40岁的总访客人数
fortyAndUp	int	识别为40岁及以上的总访客人数
men	GroupByAgeDetail	细分男性年龄分布
women	GroupByAgeDetail	细分女性年龄分布

GroupByAgeDetail对象模型

名称	类型	参数含义
unidentified	int	未识别出年龄的访客人数，区分男女
zero2twenty	int	识别为0-20岁的访客人数，区分男女
twenty2thirty	int	识别为20-30岁的访客人数，区分男女
thirty2forty	int	识别为30-40岁的访客人数，区分男女
fortyAndUp	int	识别为40岁及以上的访客人数，区分男女

响应示例

json

{
    "resultCode": "000000",
    "resultMsg": "成功",
    "data": {
        "unidentified": 0,
        "zero2twenty": 0,
        "twenty2thirty": 4,
        "thirty2forty": 11,
        "fortyAndUp": 6,
        "men": {
            "unidentified": 0,
            "zero2twenty": 0,
            "twenty2thirty": 4,
            "thirty2forty": 6,
            "fortyAndUp": 2
        },
        "women": {
            "unidentified": 0,
            "zero2twenty": 0,
            "twenty2thirty": 0,
            "thirty2forty": 5,
            "fortyAndUp": 4
        }
    }
}

查询客流的性别分布

接口功能

获取智慧商铺客流分析性别分布数据。

请求地址

https://open.qly.cmviot.cn/v3/open/api/ai/passengerFlow/vreGroupBySex

请求方式

POST，需要鉴权

请求参数

参数名称	参数类型	是否必需	参数含义	说明
storeIds	List<String>	N	节点id集合	为空时查询根节点
dateType	int	Y	查询时间段	1：今日 2：近7日 3：近30日 4：近90日
isUnderLine	boolean	N	是否查询直接级联企业节点	false：否（为空默认按否处理） true：是

请求示例

json

{
    "dateType": 4,
    "storeIds": [
        "717605566773088256"
    ]
}

响应参数

参数名称	参数类型	参数含义	说明
resultCode	String	响应码	参考响应码定义
resultMsg	String	响应描述
data	Object	响应数据

data 数据模型

名称	类型	参数含义
unidentified	int	未识别出性别的访客人数
men	int	识别为男性的访客人数
women	int	识别为女性的访客人数

响应示例

json

{
    "resultCode": "000000",
    "resultMsg": "成功",
    "data": {
        "unidentified": 0,
        "men": 11,
        "women": 8
    }
}

访客管理

获取最近访客的到访列表

接口功能

获取指定时间段内的访客到访列表。

请求地址

https://open.qly.cmviot.cn/v3/open/api/ai/visitorStats/queryVisitorList

请求方式

POST，需要鉴权

请求参数

参数名称	参数类型	是否必需	参数含义	说明
storeId	String	N	节点id	为空时查询根节点
startTime	String	N	抓拍开始时间	格式：yyyy-MM-dd HH:mm:ss，不可晚于当前时间。为空，默认查所有
endTime	String	N	抓拍截止时间	格式：yyyy-MM-dd HH:mm:ss，不可早于开始时间。开始/结束均为空，默认查所有
sex	int	N	顾客性别	-1：未知，0：女，1：男
isUnderLine	boolean	N	是否查询直接级联企业节点	false：否（为空默认按否处理） true：是
page	int	N	页码	默认1
pageSize	int	N	每页大小	默认30

请求示例

json

{
    "storeId":"",
    "sex":1,
    "startTime":"2021-04-01 09:18:33",
    "endTime":"2021-04-19 10:12:51",
    "page": 1,
    "pageSize": 20
}

响应参数

参数名称	参数类型	参数含义	说明
resultCode	String	响应码	参考响应码定义
resultMsg	String	响应描述
total	int	记录数
page	int	当前页
pageSize	int	页大小
data	List<VisitorInfo>	响应数据

VisitorInfo 对象模型

名称	类型	参数含义	说明
age	int	年龄
captureCount	int	抓拍次数
capturePictureUrl	String	抓拍图片地址	有效期一天，请及时存储
cutPictureUrl	String	裁剪图片地址	有效期一天，请及时存储
deviceId	String	设备id
deviceName	String	设备名称
maskStatus	int	是否带口罩	-1：未识别 0：no 1：yes
pictureObjectId	String	图片id
pictureObjectUrl	String	访客底库照片，为该访客首次抓拍照片的图片地址	有效期一天，请及时存储
realName	String	姓名
recentCapture	String	最近抓拍时间
recordId	int	记录id
sex	int	性别	-1：未知，0：女，1：男
storeId	String	节点id
storeName	String	节点名称
visitorId	int	访客id
visitorNumber	String	访客编号

响应示例

json

{
  "resultCode": "000000",
  "resultMsg": "成功",
  "data": [
    {
      "visitorId": 95,
      "storeId": "722758970340929536",
      "storeName": "",
      "realName": "",
      "sex": -1,
      "age": -1,
      "pictureObjectId": "cut-picture/e532130f48ee475eaf6cdf9d0277f67c.jpg",
      "pictureObjectUrl": "https://scvp-ai-dev.oss-cn-beijing.aliyuncs.com/cut-picture/e532130f48ee475eaf6cdf9d0277f67c.jpg?Expires=1619666659&OSSAccessKeyId=LTAIRqmKaNxHmwJk&Signature=Q1ckvrIACTs7pUPWZFQOJbAUciY%3D",
      "recentCapture": "2021-04-27 18:10:53",
      "captureCount": 2,
      "deviceId": "20034080881328000001",
      "deviceName": "",
      "recordId": 36,
      "visitorNumber": "10128",
      "maskStatus": 1
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 30
}

查询访客详情

接口功能

获取指定访客的详细数据

请求地址

https://open.qly.cmviot.cn/v3/open/api/ai/visitorStats/queryVisitorInfo

请求方式

POST，需要鉴权

请求参数

参数名称	参数类型	是否必需	参数含义	说明
storeId	String	Y	节点id	使用访客列表结果集当中的storeId
visitorId	int	Y	访客id	使用访客列表接口中的visitorId，与storeId需匹配

请求示例

json

{
  "storeId": "719058304946032644",
  "visitorId": 3
}

响应参数

参数名称	参数类型	参数含义	说明
resultCode	String	响应码	参考响应码定义
resultMsg	String	响应描述
data	Object	响应数据

data 数据模型

名称	类型	参数含义	说明
age	int	年龄
captureCount	int	抓拍次数
deviceName	String	设备名称
firstCaptureTime	String	首次抓拍时间
maskStatus	int	状态	-1：未识别 0：no 1：yes
pictureObjectId	String	图片id
pictureObjectUrl	String	图片地址	有效期一天，请及时存储
realName	String	姓名
recordVoList	List<RecordDetail>	记录列表
sex	int	性别	-1：未知，0：女，1：男
storeId	String	节点id
visitorNumber	String	访客编号，五位不重复

RecordDetail对象模型

名称	类型	参数含义	说明
capturePictureObjId	String	抓拍图片id
capturePictureObjUrl	String	抓拍图片地址	有效期一天，请及时存储
captureTime	String	抓拍时间
cutPictureObjId	String	人脸截图objId
cutPictureUrl	String	人脸截图地址	有效期一天，请及时存储
deviceId	String	设备id
storeId	String	节点id
storeName	String	节点名称
visitorFaceId	String	访客人脸id

响应示例

json

{
  "resultCode": "000000",
  "resultMsg": "成功",
  "data": {
    "storeId": "722758970340929536",
    "realName": "",
    "maskStatus": 1,
    "sex": -1,
    "pictureObjectId": "cut-picture/5101b44bab2c458783f817b8b8f2c965.jpg",
    "pictureObjectUrl": "https://scvp-ai-dev.oss-cn-beijing.aliyuncs.com/cut-picture/5101b44bab2c458783f817b8b8f2c965.jpg?Expires=1619666969&OSSAccessKeyId=LTAIRqmKaNxHmwJk&Signature=aqLQR%2Bj3TFHbxcNYdBBQ9v84bgw%3D",
    "captureCount": 35,
    "firstCaptureTime": "2021-04-27 10:41:25",
    "deviceName": "",
    "visitorNumber": "10128",
    "recordVoList": [
      {
        "storeId": "722758970340929536",
        "storeName": "",
        "visitorFaceId": "539573a7-f8bb-4a0a-be88-e93c6342ecc0",
        "capturePictureObjId": "vre-capture/de3db30537ea4d4a96a913009991cb56.jpg",
        "cutPictureObjId": "cut-picture/3c2759746a5f4827897baa50a9c1e85e.jpg",
        "deviceId": "20034080881328000001",
        "createTime": "2021-04-28 21:45:39"
      }
    ]
  }
}

智慧商铺 ​

客流数据 ​

客流统计 ​

接口功能 ​

请求地址 ​

请求方式 ​

请求参数 ​

请求示例 ​

响应参数 ​

StatsDetail 对象模型 ​

响应示例 ​

查询客流的年龄分布 ​

接口功能 ​

请求地址 ​

请求方式 ​

请求参数 ​

请求示例 ​

响应参数 ​

data 数据模型 ​

GroupByAgeDetail对象模型 ​

响应示例 ​

查询客流的性别分布 ​

接口功能 ​

请求地址 ​

请求方式 ​

请求参数 ​

请求示例 ​

响应参数 ​

data 数据模型 ​

响应示例 ​

访客管理 ​

获取最近访客的到访列表 ​

接口功能 ​

请求地址 ​

请求方式 ​

请求参数 ​

请求示例 ​

响应参数 ​

VisitorInfo 对象模型 ​

响应示例 ​

查询访客详情 ​

接口功能 ​

请求地址 ​

请求方式 ​

请求参数 ​

请求示例 ​

响应参数 ​

data 数据模型 ​

RecordDetail对象模型 ​

响应示例 ​

智慧商铺

客流数据

客流统计

接口功能

请求地址

请求方式

请求参数

请求示例

响应参数

StatsDetail 对象模型

响应示例

查询客流的年龄分布

接口功能

请求地址

请求方式

请求参数

请求示例

响应参数

data 数据模型

GroupByAgeDetail对象模型

响应示例

查询客流的性别分布

接口功能

请求地址

请求方式

请求参数

请求示例

响应参数

data 数据模型

响应示例

访客管理

获取最近访客的到访列表

接口功能

请求地址

请求方式

请求参数

请求示例

响应参数

VisitorInfo 对象模型

响应示例

查询访客详情

接口功能

请求地址

请求方式

请求参数

请求示例

响应参数

data 数据模型

RecordDetail对象模型

响应示例