获得场景视频 接口文档

  • 直播打卡
    • 查询某次打卡详情(全量)

LiveInteraction

直播互动接口项目。 目前实现功能有: 打卡

直播打卡

查询某次打卡详情(全量)

基本信息

Path: /api/punch/whole/detail

Method: GET

接口描述:

该接口用于admin 或 API 查询某次打卡互动的详细信息。仅返回已完成打卡的信息。
错误信息说明:

代码(code) 消息(message) 说明
10000000 invalid params 参数错误
10000004 invalid thqs THQS验证失败。
10000009 json parse error Json 解析异常
20070000 mongodb error mongodb 数据库异常
20070004 punch not exists 打卡互动不存在。
20070008 punch not stop 打卡互动未结束。

请求参数

Query

参数名称 是否必须 示例 备注
accountId 是 账户 ID
liveId 是 直播 ID
punchId 是 打卡 ID

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须接口处理结果。
errorobject非必须失败时的错误信息,success=false时必须。
├─ codeinteger必须错误代码。
├─ messagestring必须错误描述。
dataobject非必须成功时返回的数据,success=true时必须。
├─ punchobject必须打卡信息。
├─ idstring必须打卡ID。
├─ publisherIdstring必须发起者 ID。
├─ publisherNamestring必须发起者名称。
├─ createTimestring必须打卡开始时间,格式yyyy-MM-dd HH:mm:ss。
├─ totalinteger必须应打卡人数。
├─ punchedinteger必须实际打卡人数。
├─ durationinteger必须打卡持续时间,单位:秒。 无过期时间时,返回完成时间和开始时间的差。 若有过期时间,返回完成时间和开始时间的差和过期时间和开始时间的差之间较小的值。
├─ punchViewersobject []必须参与打卡学员列表,按分页返回。

item 类型: object

├─ idstring必须学员 ID。
├─ namestring必须 学员名称。
├─ createTimestring必须参与打卡时间,格式yyyy-MM-dd HH:mm:ss。
├─ isPunchedboolean必须是否打卡。
├─ punchTimestring非必须打卡时间,格式yyyy-MM-dd HH:mm:ss。isPunched=true 时必须。

Build by Bokecc.