提交人员考勤任务

最近更新时间:2019-08-19 14:03:47

1. 接口描述

接口请求域名: tci.tencentcloudapi.com 。

提交人员考勤任务,支持包括点播和直播资源;支持通过DescribeAttendanceResult查询结果,也支持通过NoticeUrl设置考勤回调结果,回调结果结构如下:

回调事件结构
参数名称 类型 描述
jobid Integer 任务ID
person_info array of PersonInfo 识别到的人员列表
子结构PersonInfo
参数名称 类型 描述
traceid String 可用于区分同一路视频流下的不同陌生人
personid String 识别到的人员ID,如果是陌生人则返回空串
libid String 识别到的人员所在的库ID,如果是陌生人则返回空串
timestamp uint64 识别到人脸的绝对时间戳,单位ms
image_url string 识别到人脸的事件抓图的下载地址,不长期保存,需要请及时下载

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SubmitCheckAttendanceTask
Version String 公共参数,本接口取值:2019-03-18
Region String 公共参数,本接口不需要传递此参数。
FileContent String 输入数据
FileType String 视频流类型,vod_url表示点播URL,live_url表示直播URL,默认vod_url
LibraryIds.N Array of String 人员库 ID列表
AttendanceThreshold Float 确定出勤阈值;默认为0.92
EnableStranger Boolean 是否开启陌生人模式,陌生人模式是指在任务中发现的非注册人脸库中的人脸也返回相关统计信息,默认不开启
EndTime Integer 考勤结束时间(到视频的第几秒结束考勤),单位秒;默认为900
对于直播场景,使用绝对时间戳,单位秒,默认当前时间往后12小时
NoticeUrl String 通知回调地址,要求方法为post,application/json格式
StartTime Integer 考勤开始时间(从视频的第几秒开始考勤),单位秒;默认为0
对于直播场景,使用绝对时间戳,单位秒,默认当前时间
Threshold Float 识别阈值;默认为0.8

3. 输出参数

参数名称 类型 描述
JobId Integer 任务标识符
NotRegisteredSet Array of String 没有注册的人的ID列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 发起考勤

发起考勤

输入示例

https://tci.tencentcloudapi.com/?Action=SubmitCheckAttendanceTask
&FileType=vod_url
&FileContent=http://xxx.mp4
&StartTime=0
&EndTime=0
&LibraryIds.0=library_id
&PersonIdSet.0=person_id0
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "21331e8d-4a22-41e3-81c5-50a173962db3",
    "JobId": 549,
    "NotRegisteredSet": null
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误
InvalidParameter 参数错误
InvalidParameter.FaceNotExisted 人脸不存在
InvalidParameter.FileContentEmpty 输入内容为空
InvalidParameter.InvalidResourceName 名称应为60个字符内的汉字、字母、数字或者下划线组成
InvalidParameter.JobNotValid 任务查询失败,请检查任务标识符后重试
InvalidParameter.NotAttendanceJob 非人员考勤任务
InvalidParameter.PersonNotRegistered 人员未注册
InvalidParameter.ResourceNameDuplicate 资源名称需要保持唯一
ResourceNotFound 资源不存在