dingtalk.oapi.smartdevice.facegroup.device.list (查询人脸设备列表)

查询人脸设备列表,可选择查询已关联设备列表、或企业已有设备的列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
biz_id String 必须 hw_123456
  • 最大长度:23
  • 业务id
    size Number 必须 10
  • 最小值:1
  • 最大值:20
  • 分页大小
    mode String 必须 all 查询模式:all-企业所有设备;bound-本组已关联设备
    type String 必须 M2 需查询的设备类型
    cursor Number 必须 11 游标,第一次传 <=0的值,后续传本调用的返回值

    响应参数

    名称 类型 示例值 描述
    result PagedList 符合条件的当前页数据
    • items
    • DeviceDto []
    • 符合条件的设备
    • └ status
    • Boolean
    • true
    • 是否启用识别(查询已绑定记录时有效)
    • └ used
    • Boolean
    • false
    • 是否已被使用(含被本组关联)
    • └ online
    • Boolean
    • 设备
    • 在线是否在线
    • └ type
    • String
    • M2
    • 设备类型
    • └ name
    • String
    • 年会专用M2
    • 设备名称
    • └ device_id
    • Number
    • 56789
    • 设备id
    • └ cursor
    • Number
    • 111
    • 游标,下一次请求需要传入的下一次请求时需传入的游标值
    • └ has_more
    • Boolean
    • true
    • 是否还有下一页数据
    success Boolean true 调用结果
    errcode Number 0 错误代号
    errmsg String 成功 错误提示

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/smartdevice/facegroup/device/list");
    OapiSmartdeviceFacegroupDeviceListRequest req = new OapiSmartdeviceFacegroupDeviceListRequest();
    req.setBizId("hw_123456");
    req.setSize(10L);
    req.setMode("all");
    req.setType("M2");
    req.setCursor(11L);
    OapiSmartdeviceFacegroupDeviceListResponse rsp = client.execute(req, access_token);
    System.out.println(rsp.getBody());

    响应示例

    • JSON示例
    {
        "result":{
            "items":[
                {
                        "status":true,
                        "used":false,
                        "online":设备,
                        "type":"M2",
                        "name":"年会专用M2",
                        "device_id":56789
                }
            ],
            "cursor":111,
            "has_more":true
        },
        "success":true,
        "errcode":0,
        "errmsg":"成功"
    }

    异常示例

    • JSON示例
    {
    	"errcode":88,
    	"errmsg":"ding talk error"
    }

    错误码解释

    错误码 错误描述 解决方案

    API工具

    如何获得此API

    FAQ

    返回
    顶部