帮你快速理解、总结文档立即下载

数据结构

最近更新时间:2026-07-21 02:14:41

我的收藏

ADPConfig

ADP 平台配置

被如下接口引用:CreateTWeTalkAgent, ModifyTWeTalkAgent。

名称 类型 必选 描述
AppKey String

ADP 平台 AppKey


示例值:B*derZLPzMcqpOcOEwOawaDMIelgZcCatUVuaZBYlITUXZmCUdioRcZDmWfkxLnGqdqarqhqcrvayRyACPmtDrpMDdNYazEfYamOxLPWUaHG

AISearchInfo

AI视频搜索结果结构体。

被如下接口引用:DescribeAISearchTaskAsync。

名称 类型 描述
Summary String 基于搜索结果的总结
示例值:What happened on April 1st
Targets Array of TargetInfo 视频结果集
VideoURL String 视频回放URL
示例值:https://domain.com/video.m3u8

ActivateDeviceInfo

设备激活详情信息

被如下接口引用:DescribeActivateDevice。

名称 类型 描述
InstanceId String 实例ID
示例值:1
InstanceType Integer 实例类型
示例值:0
DeviceActivationDetails DeviceActivationDetail 设备激活信息
RegisteredDeviceType RegisteredDeviceTypeInfo 已注册设备类型信息
RegisteredDeviceNetType RegisteredDeviceNetTypeInfo 已注册设备通信类型信息

AppDeviceInfo

云api直接绑定设备出参

被如下接口引用:DirectBindDeviceInFamily。

名称 类型 描述
DeviceId String 产品ID/设备名
示例值:fsdf
ProductId String 产品ID
示例值:sdf
DeviceName String 设备名
示例值:sdf
AliasName String 设备别名
示例值:sdfsdf
IconUrl String icon地址
示例值:sdfsdf
FamilyId String 家庭ID
示例值:sdffsd
RoomId String 房间ID
示例值:sdfds
DeviceType Integer 设备类型
示例值:0
CreateTime Integer 创建时间
示例值:23423423
UpdateTime Integer 更新时间
示例值:234234234

AuthMiniProgramAppInfo

授权小程序信息

被如下接口引用:GetAuthMiniProgramAppList。

名称 类型 必选 描述
MiniProgramAppId String 小程序APPID
示例值:12sws
CreateTime Integer 创建时间
示例值:19856567
MiniProgramName String 小程序名称
示例值:app
LicenseNum Integer 激活码数
示例值:1
IotAppId String 应用ID
示例值:app123
IotAppName String 应用名称
示例值:Test名

BatchProductionInfo

获取返回列表的详情。

被如下接口引用:GetBatchProductionsList。

名称 类型 描述
BatchProductionId String 量产ID
示例值:batch-34451234
ProductId String 产品ID
示例值:4R6GT7J
BurnMethod Integer 烧录方式
示例值:1
CreateTime Integer 创建时间
示例值:17203300
ProductName String 产品名称
示例值:产品名

BindDeviceInfo

BindDeviceInfo

被如下接口引用:DescribeGatewayBindDevices, DescribeUnbindedDevices。

名称 类型 描述
ProductId String 产品ID。
示例值:R5FV67H
DeviceName String 设备名称。
示例值:dev

BindProductInfo

绑定、未绑定产品详细信息

被如下接口引用:DescribeBindedProducts, DescribeGatewaySubProducts。

名称 类型 描述
ProductId String 产品ID。
示例值:productud
ProductName String 产品名称。
示例值:productname
ProjectId String 产品所属项目ID。
示例值:projectid
DataProtocol Integer 物模型类型。
示例值:1
CategoryId Integer 产品分组模板ID
示例值:1
ProductType Integer 产品类型
示例值:1
NetType String 连接类型
示例值:else
DevStatus String 状态
示例值:dev
ProductOwnerName String 产品拥有者名称
示例值:1

CamTag

标签数据结构

被如下接口引用:DescribeTopicRule。

名称 类型 必选 描述
TagKey String 标签键
示例值:tag_key
TagValue String 标签值
示例值:tag_value

CloudStorageAIServiceTask

云存 AI 服务任务信息

被如下接口引用:DescribeCloudStorageAIServiceTask, DescribeCloudStorageAIServiceTasks, DescribeCloudStorageEventsWithAITasks, InvokeCloudStorageAIServiceTask, InvokeExternalSourceAIServiceTask。

名称 类型 描述
TaskId String 云存 AI 服务任务 ID
示例值:fb066d7a-baac-4706-acda-058f56f82759
ProductId String 产品 ID
示例值:TQBDY6RPI9
DeviceName String 设备名称
示例值:cs_112114601_2
ChannelId Integer 通道 ID
示例值:0
ServiceType String 云存 AI 服务类型。可能取值:

- RealtimeObjectDetect:目标检测
- Highlight:视频浓缩
- VideoToText:视频语义理解
示例值:Highlight
StartTime Integer 对应云存视频的起始时间(秒级 UNIX 时间戳)
示例值:1710487888
StartTimeMs Integer 对应云存视频的起始时间(毫秒级 UNIX 时间戳)
示例值:1710487888270
EndTime Integer 对应云存视频的结束时间(秒级 UNIX 时间戳)
示例值:1710487898
EndTimeMs Integer 对应云存视频的结束时间(毫秒级 UNIX 时间戳)
示例值:1710487898990
Status Integer 任务状态(1:失败;2:成功但结果为空;3:成功且结果非空;4:执行中)
示例值:3
Result String 任务结果
示例值:{"param1":"value1"}
Files Array of String 任务输出文件列表
示例值:["output.mp4"]
FilesInfo Array of CloudStorageAIServiceTaskFileInfo 任务输出文件信息列表
CreateTime Integer 创建时间
示例值:1711338476
UpdateTime Integer 最后更新时间
示例值:1711338476
CustomId String 自定义任务 ID
示例值:event-123

CloudStorageAIServiceTaskFileInfo

云存 AI 任务输出文件信息

被如下接口引用:DescribeCloudStorageAIServiceTask, DescribeCloudStorageAIServiceTasks, DescribeCloudStorageEventsWithAITasks, DescribeTWeSeeRecognitionTask, DescribeTWeSeeTask, InvokeCloudStorageAIServiceTask, InvokeExternalSourceAIServiceTask, ListTWeSeeTasks。

名称 类型 描述
FileName String 文件名称(含扩展名)
示例值:video.mp4
FileSize Integer 文件大小(单位:bytes)
示例值:1228800
DownloadURL String 文件下载 URL
示例值:https://example.com/video.mp4
MimeType String 文件的 MIME Type
示例值:video/mp4
VideoMetaInfo CloudStorageAIServiceTaskVideoMetaInfo 视频文件元数据(仅当文件为视频类型时包含该字段)
Labels Array of CloudStorageAIServiceTaskFileLabel 文件标签

CloudStorageAIServiceTaskFileLabel

云存 AI 任务输出文件标签

被如下接口引用:DescribeCloudStorageAIServiceTask, DescribeCloudStorageAIServiceTasks, DescribeCloudStorageEventsWithAITasks, DescribeTWeSeeRecognitionTask, DescribeTWeSeeTask, InvokeCloudStorageAIServiceTask, InvokeExternalSourceAIServiceTask, ListTWeSeeTasks。

名称 类型 描述
Key String key1
示例值:文件标签键
Value String value1
示例值:文件标签值

CloudStorageAIServiceTaskVideoMetaInfo

云存 AI 任务输出视频文件元数据

被如下接口引用:DescribeCloudStorageAIServiceTask, DescribeCloudStorageAIServiceTasks, DescribeCloudStorageEventsWithAITasks, DescribeTWeSeeRecognitionTask, DescribeTWeSeeTask, InvokeCloudStorageAIServiceTask, InvokeExternalSourceAIServiceTask, ListTWeSeeTasks。

名称 类型 描述
ThumbnailFileName String 视频对应的缩略图的文件名称(含扩展名)
示例值:thumbnail.jpg
DurationMilliSeconds Integer 视频时长(单位:毫秒)
示例值:30000

CloudStorageEvent

云存事件

被如下接口引用:DescribeCloudStorageEvents。

名称 类型 必选 描述
StartTime Integer 事件起始时间(Unix 时间戳,秒级
示例值:1560355200
EndTime Integer 事件结束时间(Unix 时间戳,秒级
示例值:1601196327
Thumbnail String 事件缩略图
示例值:/100008401725/AQTV2839QJ/sp01_328202375/events/123.jpg
EventId String 事件ID
示例值:low_power
UploadStatus String 事件录像上传状态,Finished: 全部上传成功 Partial: 部分上传成功 Failed: 上传失败
示例值:Finished
Data String 事件自定义数据
示例值:name

CloudStorageEventWithAITasks

云存事件及其关联的云存 AI 任务

被如下接口引用:DescribeCloudStorageEventsWithAITasks。

名称 类型 描述
StartTime Integer 事件起始时间(Unix 时间戳,秒级
示例值:1560355200
EndTime Integer 事件结束时间(Unix 时间戳,秒级
示例值:1601196327
Thumbnail String 事件缩略图
示例值:/100008401725/AQTV2839QJ/sp01_328202375/events/123.jpg
EventId String 事件ID
示例值:low_power
UploadStatus String 事件录像上传状态,Finished: 全部上传成功 Partial: 部分上传成功 Failed: 上传失败
示例值:Finished
Data String 事件自定义数据
示例值:name
AITasks Array of CloudStorageAIServiceTask 事件关联的云存 AI 任务列表

CloudStoragePackageInfo

云存套餐包信息

被如下接口引用:DescribeFreeCloudStorageNum。

名称 类型 描述
PackageId String 套餐包id
示例值:lye1w3d
PackageName String 套餐包名字
示例值:低功耗3天会看周套餐
Num Integer 套餐包数量
示例值:10
UsedNum Integer 已使用数量
示例值:5

CloudStorageTimeData

云存时间轴接口返回数据

被如下接口引用:DescribeCloudStorageTime。

名称 类型 必选 描述
TimeList Array of CloudStorageTimeInfo 云存时间轴信息列表
VideoURL String 播放地址
示例值:https

CloudStorageTimeInfo

云存时间轴信息

被如下接口引用:DescribeCloudStorageTime。

名称 类型 必选 描述
StartTime Integer 开始时间
示例值:1642661618
EndTime Integer 结束时间
示例值:1743475078

CloudStorageUserInfo

云存用户信息

被如下接口引用:DescribeCloudStorageUsers。

名称 类型 描述
UserId String 用户ID
示例值:user

CountDataInfo

云存上报统计信息

被如下接口引用:DescribeCsReportCountDataInfo。

名称 类型 描述
VideoExceptionNum Integer 视频上报异常次数
示例值:1
VideoSuccessNum Integer 视频上报成功次数
示例值:99
VideoSuccessRate String 视频上报成功率

示例值:99.00%
EventExceptionNum Integer 事件上报异常次数
示例值:1
EventSuccessNum Integer 事件上报成功次数
示例值:99
EventSuccessRate String 事件上报成功率
示例值:99.00%

CreateVisionRecognitionTaskInput

批量创建的 TWeSee 语义理解任务

被如下接口引用:BatchCreateTWeSeeRecognitionTask, BatchInvokeTWeSeeRecognitionTask。

名称 类型 必选 描述
ProductId String 产品ID
示例值:TRTC3ZCK4P
DeviceName String 设备名称
示例值:dev002
InputURL String 输入视频 / 图片的 URL
示例值:https://example.qq.com/video.mp4
InputBase64 String 视频 / 图片文件的 Base64 编码字符串
示例值:文件base64
ChannelId Integer 通道 ID
示例值:0
CustomId String 自定义事件 ID
示例值:event-1
EnableSearch Boolean 是否保存该事件使其可被搜索
示例值:true
StartTimeMs Integer 事件起始时间事件起始时间(毫秒级 UNIX 时间戳,若不传则默认为接口调用时间)
示例值:1761535261343
EndTimeMs Integer 事件结束时间事件起始时间(毫秒级 UNIX 时间戳,若不传则默认为接口调用时间)
示例值:1761535267343
Config String 算法配置
示例值:{"config_key": "config_value"}
IsCustomDevice Boolean 是否自定义设备,为 true 时不检查设备存在性,默认为 false
示例值:true
InputType String 输入类型。可选值:

- video:视频(默认值)
- image:图片
示例值:video
SummaryQOS String 摘要服务质量。可选值:

- minutely:分钟级(默认值)
- immediate:立即
示例值:minutely
SummaryConfig VisionSummaryConfig 摘要输出配置
ServiceType String 算法类型,可能取值:
- Summary:视频/图片摘要
- ObjectDetect:目标检测
示例值:Summary
ObjectDetectConfig VisionObjectDetectConfig 目标检测配置

CreateVisionRecognitionTaskOutput

批量创建 TWeSee 语义理解任务的响应

被如下接口引用:BatchCreateTWeSeeRecognitionTask。

名称 类型 描述
Created Boolean 创建任务成功
示例值:true
TaskId String 任务 ID
示例值:019a0fb5-f039-740f-9e5f-1b01fce8a7da
ErrorCode String 错误码
示例值:InvalidParameter
ErrorMessage String 错误消息
示例值:参数错误:InputBase64

DeviceActivationDetail

设备激活详情信息

被如下接口引用:DescribeActivateDevice。

名称 类型 描述
TotalDeviceNum Integer 可注册设备数
示例值:1
UsedDeviceNum Integer 已注册设备数
示例值:1
TotalNormalLicense Integer 设备授权数
示例值:1
UsedNormalLicense Integer 已使用设备授权数
示例值:1
TotalBluetoothLicense Integer 蓝牙授权数
示例值:1
UsedBluetoothLicense Integer 已使用蓝牙授权数
示例值:1
TotalFreeLicense Integer 可免费注册设备数
示例值:1
UsedFreeLicense Integer 已使用注册设备数
示例值:1

DeviceActiveResult

设备激活结果数据

被如下接口引用:ActivateTWeCallLicense。

名称 类型 描述
Sn String SN信息
示例值:product_device
ErrCode Integer 设备激活状态,0:激活成功;50011:系统错误;50012:产品不存在;50013:设备不存在;50014:产品无权限;50015:不是音视频产品;50016:SN格式错误;50017:激活码类型错误;50018:激活次数限频;50019:激活码不足;50020:SN已暂停;
示例值:0
ErrMessage String 错误信息
示例值:激活成功
ExpireTime Integer 过期时间
示例值:1945563456

DeviceData

DeviceData

被如下接口引用:CreateDevice。

名称 类型 描述
DeviceCert String 设备证书,用于 TLS 建立链接时校验客户端身份。采用非对称加密时返回该参数。
示例值:argagtgae
DeviceName String 设备名称。
示例值:dev
DevicePrivateKey String 设备私钥,用于 TLS 建立链接时校验客户端身份,腾讯云后台不保存,请妥善保管。采用非对称加密时返回该参数。
示例值:eafgs*fafrgag
DevicePsk String 对称加密密钥,base64编码。采用对称加密时返回该参数。
示例值:fafgargjkahrg

DeviceDataHistoryItem

设备历史数据结构

被如下接口引用:DescribeDeviceDataHistory。

名称 类型 描述
Time String 时间点,毫秒时间戳
示例值:1743420795
Value String 字段取值
示例值:v1

DeviceFirmwareInfo

设备固件信息

被如下接口引用:DescribeDeviceFirmwares。

名称 类型 描述
FwType String 固件类型
示例值:mcu
Version String 固件版本
示例值:1.0
UpdateTime Integer 最后更新时间
示例值:1653893719

DeviceInfo

设备详细信息

被如下接口引用:DescribeDevice, GetDeviceList。

名称 类型 描述
DeviceName String 设备名
示例值:1
Status Integer 0: 离线, 1: 在线, 2: 获取失败, 3 未激活
示例值:2
DevicePsk String 设备密钥,密钥加密的设备返回
示例值:2
FirstOnlineTime Integer 首次上线时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
LoginTime Integer 最后一次上线时间
示例值:2
CreateTime Integer 设备创建时间
示例值:2
Version String 设备固件版本
示例值:2
DeviceCert String 设备证书
示例值:2
LogLevel Integer 日志级别
示例值:2
DevAddr String LoRaWAN 设备地址
示例值:2
AppKey String LoRaWAN 应用密钥
示例值:2
DevEUI String LoRaWAN 设备唯一标识
示例值:2
AppSKey String LoRaWAN 应用会话密钥
示例值:2
NwkSKey String LoRaWAN 网络会话密钥
示例值:2
CreateUserId Integer 创建人Id
示例值:1
CreatorNickName String 创建人昵称
示例值:1
EnableState Integer 启用/禁用状态
示例值:1
ProductId String 产品ID
示例值:TOIDHQ3AOQ
ProductName String 产品名称
示例值:智能音箱
DeviceType String 设备类型(设备、子设备、网关)
示例值:设备
IsLora Boolean 是否是 lora 设备
示例值:1

DevicePositionItem

设备位置详情

被如下接口引用:DescribeDevicePositionList。

名称 类型 描述
DeviceName String 设备名称
示例值:dev
CreateTime Integer 位置信息时间
示例值:1702300100
Longitude Float 设备经度信息
示例值:20.30
Latitude Float 设备纬度信息
示例值:60.30

DeviceSignatureInfo

设备签名

被如下接口引用:GenSingleDeviceSignatureOfPublic。

名称 类型 描述
DeviceName String 设备名
示例值:dev
DeviceSignature String 设备签名
示例值:eagrv==

DeviceUpdateStatus

设备固件更新状态

被如下接口引用:DescribeFirmwareTaskDevices。

名称 类型 描述
DeviceName String 设备名
示例值:dev001
LastProcessTime Integer 最后处理时间
示例值:3247329874932
Status Integer 状态
示例值:2
ErrMsg String 错误消息
示例值:timeout
Retcode Integer 返回码
示例值:-20
DstVersion String 目标更新版本
示例值:1.0
Percent Integer 下载中状态时的下载进度
注意:此字段可能返回 null,表示取不到有效值。
示例值:20
OriVersion String 原版本号
注意:此字段可能返回 null,表示取不到有效值。
示例值:2.0
TaskId Integer 任务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:234324
FwType String 固件类型
示例值:mcu
RetryNum Integer 重试次数
示例值:5

DeviceUser

设备的用户

被如下接口引用:GetFamilyDeviceUserList。

名称 类型 描述
UserId String 用户ID
示例值:userId
Role Integer 用户角色 1所有者,0:其他分享者
示例值:0
FamilyId String 家庭ID,所有者带该参数
示例值:f_1234567
FamilyName String 家庭名称,所有者带该参数
示例值:家庭名称

DevicesItem

ProductId -> DeviceName

被如下接口引用:DeleteDevices, UpdateDevicesEnableState。

名称 类型 必选 描述
ProductId String 产品id
示例值:JZYTG1M2EN
DeviceName String 设备名称
示例值:dev01

DiarySHLConfig

Diary Simple Highlight 配置

被如下接口引用:ModifyCloudStorageAIService。

名称 类型 必选 描述
StartOffset Integer 每个视频偏移时长,单位秒
示例值:2
PlaySpeed Integer 视频浓缩倍数,支持1,2,4之间
示例值:1
MiniExtract Integer 单个视频最小提取时长,单位秒
示例值:2
OutDuration Integer 每天最终输出视频时长,单位秒
注:免费版固定10s
示例值:10

EventHistoryItem

设备事件的搜索结果项

被如下接口引用:ListEventHistory。

名称 类型 描述
TimeStamp Integer 事件的时间戳
示例值:1743418800
ProductId String 事件的产品ID
示例值:R4F56HB
DeviceName String 事件的设备名称
示例值:dev
EventId String 事件的标识符ID
示例值:eventId
Type String 事件的类型
示例值:alert
Data String 事件的数据
示例值:{"data":{"alert":4}}

FamilySubDevice

子设备详情

被如下接口引用:DescribeGatewaySubDeviceList, GetGatewaySubDeviceList。

名称 类型 描述
ProductId String 产品Id
示例值:productId
DeviceName String 设备名称
示例值:devicename
DeviceId String 设备ID
示例值:deviceId
AliasName String 设备别名
示例值:aliasName
FamilyId String 设备绑定的家庭ID
示例值:familyId
RoomId String 设备所在的房间ID,默认"0"
示例值:roomId
IconUrl String 图标
示例值:url
IconUrlGrid String grid图标
示例值:url
CreateTime Integer 设备绑定时间戳
示例值:1627459546
UpdateTime Integer 设备更新时间戳
示例值:1627459546

FenceAlarmPoint

围栏告警位置点

被如下接口引用:DescribeFenceEventList, DescribeSpaceFenceEventList。

名称 类型 描述
AlarmTime Integer 围栏告警时间
示例值:1743418800
Longitude Float 围栏告警位置的经度
示例值:34.566754
Latitude Float 围栏告警位置的纬度
示例值:123.785634

FenceBindDeviceItem

围栏绑定的设备信息

被如下接口引用:CreateFenceBind, DeleteFenceBind, DescribeFenceBindList, ModifyFenceBind。

名称 类型 必选 描述
DeviceName String 设备名称
示例值:dev
AlertCondition String 告警条件(In,进围栏报警;Out,出围栏报警;InOrOut,进围栏或者出围栏均报警)
示例值:dev>1
FenceEnable Boolean 是否使能围栏(true,使能;false,禁用)
示例值:false
Method String 告警处理方法
示例值:report

FenceBindProductItem

围栏绑定的产品信息

被如下接口引用:CreateFenceBind, DeleteFenceBind, DescribeFenceBindList, ModifyFenceBind。

名称 类型 必选 描述
Devices Array of FenceBindDeviceItem 围栏绑定的设备信息
ProductId String 围栏绑定的产品Id
示例值:E45CV67

FenceEventItem

围栏事件详情

被如下接口引用:DescribeFenceEventList, DescribeSpaceFenceEventList。

名称 类型 描述
ProductId String 围栏事件的产品Id
示例值:E4C56VC
DeviceName String 围栏事件的设备名称
示例值:dev
FenceId Integer 围栏Id
示例值:fence-347
AlertType String 围栏事件的告警类型(In,进围栏报警;Out,出围栏报警;InOrOut,进围栏或者出围栏均报警)
示例值:alert
Data FenceAlarmPoint 围栏事件的设备位置信息

Filter

描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等

  • 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。

  • 若同一个Filter存在多个Values,同一Filter下Values间的关系为逻辑或(OR)关系。

被如下接口引用:GetDeviceList, SearchStudioProduct。

名称 类型 必选 描述
Name String 需要过滤的字段
示例值:tag:tag-key
Values Array of String 字段的过滤的一个或多个值
示例值:tag-value

FirmwareInfo

设备固件详细信息

被如下接口引用:ListFirmwares。

名称 类型 描述
Version String 固件版本
示例值:1.0.0
Md5sum String 固件MD5值
示例值:bd9dc3549a0d75bb242d9d4f5842f221
CreateTime Integer 固件创建时间
示例值:1619322032
ProductName String 产品名称
示例值:productName
Name String 固件名称
示例值:firmwareName
Description String 固件描述
示例值:firmwareDesc
ProductId String 产品ID
示例值:productId
FwType String 固件升级模块
示例值:mcu
CreateUserId Integer 创建者子 uin
示例值:9999966666
CreatorNickName String 创建者昵称
示例值:喵喵
UserDefined String 固件用户自定义配置信息
示例值:{"key1":"value1", "key2":"支持中文"}

FirmwareTaskInfo

固件升级任务信息

被如下接口引用:DescribeFirmwareTasks。

名称 类型 描述
TaskId Integer 任务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:324234
Status Integer 任务状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
Type Integer 任务类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CreateTime Integer 任务创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2342345435
CreatorNickName String 创建者
注意:此字段可能返回 null,表示取不到有效值。
示例值:zzz
CreateUserId Integer 创建者ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:32423524323
CronTime Integer 任务启动时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:234345344234
FwType String 固件类型
示例值:mcu

IdleResponseInfo

空闲检测配置信息。

被如下接口引用:CreateTWeTalkAIBot, CreateTWeTalkProductConfigV2, DescribeTWeTalkProductConfigV2, GetTWeTalkProductConfigListV2, ModifyTWeTalkAIBot, ModifyTWeTalkProductConfigV2。

名称 类型 必选 描述
RetryCount Integer 重试次数(1-3)
示例值:1
Message String 响应信息
示例值:你好,你还在吗?

InstanceDetail

实例信息
公共实例过期时间 0001-01-01T00:00:00Z,公共实例是永久有效

被如下接口引用:DescribeInstance。

名称 类型 描述
InstanceId String 实例ID
示例值:ins-112ws5fgeg
InstanceType Integer 实例类型(0 公共实例 1 标准企业实例 2新企业实例3新公共实例)
示例值:1
Region String 地域字母缩写
示例值:ap-guangzhou
ZoneId String 区域全拼
示例值:ap-guangzhou-1
TotalDeviceNum Integer 支持设备总数
示例值:1
UsedDeviceNum Integer 已注册设备数
示例值:1
ProjectNum Integer 项目数
示例值:1
ProductNum Integer 产品数
示例值:1
CreateTime Timestamp ISO8601 创建时间
示例值:1234243
UpdateTime Timestamp ISO8601 更新时间
示例值:234132432
ExpireTime Timestamp ISO8601 过期时间,公共实例过期时间 0001-01-01T00:00:00Z,公共实例是永久有效
示例值:23142134123
TotalDevice Integer 总设备数
示例值:1
ActivateDevice Integer 激活设备数
示例值:1
Description String 备注
示例值:备注
Status Integer 实例状态
示例值:1
UpDownTPS Integer 消息上下行配置TPS
示例值:1
UpDownCurrentTPS Integer 当前消息上下行TPS
示例值:1
ForwardTPS Integer 消息转发配置TPS
示例值:1
ForwardCurrentTPS Integer 消息转发当前TPS
示例值:1
CellNum Integer 实例单元数
示例值:1
BillingTag String 实例Tag,企业实例必传
示例值:sv_rav_iot_explorer_instance_starter
EverydayFreeMessageCount Integer 每日消息数
示例值:300000
MaxDeviceOnlineCount Integer 最大在线设备数
示例值:1500

InvokeVisionRecognitionTaskOutput

批量同步执行 TWeSee 语义理解任务的响应

被如下接口引用:BatchInvokeTWeSeeRecognitionTask。

名称 类型 描述
Completed Boolean 任务是否已完成
示例值:true
TaskId String 任务 ID
示例值:019a0bdb-1471-77c7-ad24-3962edda28cc
ErrorCode String 错误码
示例值:InvalidParameter
ErrorMessage String 错误消息
示例值:参数错误:InputURL
Result VisionRecognitionResult 任务结果

IotApplication

应用信息

被如下接口引用:ModifyApplication。

名称 类型 描述
IotAppID String 应用 ID
示例值:XX
AppName String 应用名称
示例值:小程序应用名
Description String 应用说明
示例值:这是一个测试应用
DevMode Integer 开发模式
示例值:0
IOSAppKey String iOS 平台 AppKey
示例值:45yrtg
IOSAppSecret String iOS 平台 AppSecret
示例值:45156faghthr
AndroidAppKey String Android 平台 AppKey
示例值:545gsrh
AndroidAppSecret String Android 平台 AppSecret
示例值:irut905
Products String 绑定的产品列表,数据为:ProdcutID 数组 JSON 序列化后的字符串
示例值:["productId"]
CreateTime String 创建时间
示例值:2021-07-14T14:24:13+08:00
ProjectId String 项目ID
示例值:prj-t6le10pr
PushSecretID String 信鸽推送APP ID
示例值:45gdbvg8
PushSecretKey String 信鸽推送SECRET KEY
示例值:32t7767ug
PushEnvironment String iOS平台推送环境
示例值:drg
MiniProgramAppKey String 小程序平台 AppKey
示例值:34r
MiniProgramAppSecret String 小程序平台 AppSecret
示例值:345t44
TPNSiOSAccessID String TPNS服务iOS应用AccessID,TPNS全称为腾讯移动推送(Tencent Push Notification Service),详见:https://cloud.tencent.com/document/product/548
示例值:g345tg4
TPNSiOSSecretKey String TPNS服务iOS应用SecretKey
示例值:34t5645g
TPNSiOSPushEnvironment String TPNS服务iOS应用推送环境
示例值:45tgv
TPNSAndroidAccessID String TPNS服务Android应用AccessID
示例值:g45ty
TPNSAndroidSecretKey String TPNS服务Android应用SecretKey
示例值:45tg
TPNSiOSRegion String TPNS服务iOS应用所属地域,详细说明参见 ModifyApplication 同名入参。
示例值:4t5g
TPNSAndroidRegion String TPNS服务Android应用所属地域,详细说明参见 ModifyApplication 同名入参。
示例值:34r
SelfSmsAppId String 自主短信配置APPID
示例值:1400222796
SelfSmsAppKey String 自主短信配置APPKey
示例值:eacc64dcb0c225b47d885fd6fef608f7
SelfSmsSign String 自主短信配置签名
示例值:腾讯云智能物联
SelfSmsTemplateId Integer 自主短信配置模板ID
示例值:360226
WechatNotifyStatus Integer 第三方小程序强提醒开关 0:关闭;1:开启
示例值:0
InterconnectionProducts String 互联互通产品ID列表
示例值:["productId"]

LicenseServiceNumInfo

增值服务数量统计

被如下接口引用:DescribeActivateLicenseService。

名称 类型 描述
LicenseType String 服务类型
示例值:Video
TotalNum Integer 授权总数
示例值:1
UsedNum Integer 已使用授权数
示例值:1
TWeCallLicense Array of TWeCallLicenseInfo TWeCall激活码

LoRaFrequencyEntry

LoRa自定义频点信息

被如下接口引用:CreateLoRaFrequency, DescribeLoRaFrequency, ModifyLoRaFrequency。

名称 类型 描述
FreqId String 频点唯一ID
示例值:freqId
FreqName String 频点名称
示例值:频点1
Description String 频点描述
示例值:这是频点信息
ChannelsDataUp Array of Integer 数据上行信道
示例值:9
ChannelsDataRX1 Array of Integer 数据下行信道RX1
示例值:1
ChannelsDataRX2 Array of Integer 数据下行信道RX2
示例值:2
ChannelsJoinUp Array of Integer 入网上行信道
示例值:34
ChannelsJoinRX1 Array of Integer 入网下行RX1信道
示例值:65
ChannelsJoinRX2 Array of Integer 入网下行RX2信道
示例值:45
CreateTime Integer 创建时间
示例值:1923000000

LoRaGatewayItem

LoRa 网关信息

被如下接口引用:CreateLoRaGateway, GetLoRaGatewayList, ModifyLoRaGateway。

名称 类型 必选 描述
GatewayId String LoRa 网关Id
示例值:NS74VEP2HY
IsPublic Boolean 是否是公开网关
示例值:false
Description String 网关描述
示例值:这是网关
Name String 网关名称
示例值:leo
Position String 网关位置信息
示例值:客厅
PositionDetails String 网关位置详情
示例值:客厅设备
Location LoRaGatewayLocation LoRa 网关位置坐标
UpdatedAt String 最后更新时间
示例值:19520315
CreatedAt String 创建时间
示例值:19520315
LastSeenAt String 最后上报时间
示例值:19520315
FrequencyId String 频点ID
示例值:freqId

LoRaGatewayLocation

网关坐标

被如下接口引用:CreateLoRaGateway, GetLoRaGatewayList, ModifyLoRaGateway。

名称 类型 必选 描述
Latitude Float 纬度
示例值:0.0
Longitude Float 精度
示例值:0.0
Accuracy Float 准确度
示例值:0.0
Altitude Float 海拔
示例值:0.0

OtaModuleInfo

升级包类型详细信息

被如下接口引用:ListOtaModules, ListProductOtaModules。

名称 类型 描述
CreateTime Integer 模块创建时间
示例值:1619322032
ProductName String 产品名称
示例值:productName
Name String 模块名称
示例值:firmwareName
ProductID String 产品ID
示例值:productId
FwType String 模块类型
示例值:mcu
IsBuildIn Boolean 是否系统内置升级包类型
示例值:false
Remark String 模块描述
示例值:这是一个描述

PackageConsumeStat

云存套餐包消耗统计

被如下接口引用:DescribeCloudStoragePackageConsumeStats。

名称 类型 描述
PackageId String 云存套餐包id
示例值:yc1m3d
PackageName String 云存套餐包名称
示例值:全时3天月卡
Cnt Integer 消耗个数
示例值:10
Price Integer 套餐包单价,单位分
示例值:595
Source Integer 消耗来源,1预付费
示例值:1

PackageConsumeTask

套餐包消耗任务列表

被如下接口引用:DescribePackageConsumeTasks。

名称 类型 描述
TaskId Integer 任务id
示例值:121
CreateTime String 任务创始时间
示例值:2021-11-02 11:11:12
State Integer 任务状态,1待处理,2处理中,3已完成
示例值:1

PackageInfo

结构体(PackageInfo)记录了设备拥有的有效套餐信息,包括云存开启状态、云存类型、云存回看时长、云存套餐过期时间

被如下接口引用:DescribeDevicePackages。

名称 类型 描述
Status Integer 云存开启状态,0为未开启,2为正在生效,1为已过期
注:这里只返回状态为0的数据
示例值:0
CSType Integer 云存类型,1为全时云存,2为事件云存
示例值:1
CSShiftDuration Integer 云存回看时长
示例值:259200
CSExpiredTime Integer 云存套餐过期时间
示例值:1697870539
CreatedAt Integer 云存套餐创建时间
示例值:1690254147
UpdatedAt Integer 云存套餐更新时间
示例值:1690254147
PackageId String 套餐id
示例值:"sdfds"
OrderId String 订单id
示例值:"sdfsdf"
ChannelId Integer 通道id
示例值:0
CSUserId String 用户id
示例值:gjhghjk

PositionFenceInfo

围栏详细信息(包含创建时间及更新时间)

被如下接口引用:DescribePositionFenceList。

名称 类型 描述
GeoFence PositionFenceItem 围栏信息
CreateTime Integer 围栏创建时间
示例值:198523000
UpdateTime Integer 围栏更新时间
示例值:198523000

PositionFenceItem

围栏信息

被如下接口引用:DescribePositionFenceList。

名称 类型 描述
FenceId Integer 围栏Id
示例值:fenceId
SpaceId String 位置空间Id
示例值:spaceID
FenceName String 围栏名称
示例值:leo
FenceDesc String 围栏描述
示例值:这是一个围栏
FenceArea String 围栏区域信息,采用 GeoJSON 格式
示例值:{"data":{"key":"value"}}

PositionItem

位置点

被如下接口引用:GetDeviceLocationHistory。

名称 类型 描述
CreateTime Integer 位置点的时间
示例值:1597042572000
Longitude Float 位置点的经度
示例值:106.04509595706622
Latitude Float 位置点的纬度
示例值:27.030664678580806
LocationType String 位置点的定位类型
示例值:NAV
Accuracy Float 位置点的精度预估,单位为米
示例值:42.3

PositionSpaceInfo

位置空间详情

被如下接口引用:GetPositionSpaceList, SearchPositionSpace。

名称 类型 描述
ProjectId String 项目Id
示例值:prj
SpaceId String 位置空间Id
示例值:a877xxxa1
SpaceName String 位置空间名称
示例值:name
AuthorizeType Integer 授权类型
示例值:0
Description String 描述备注
示例值:desc
ProductIdList Array of String 产品列表
示例值:["TOIDHQ3AO1","TOIDHQ3AO2"]]
Icon String 缩略图
示例值:icon
CreateTime Integer 创建时间
示例值:1598863974
UpdateTime Integer 更新时间
示例值:1598863974
Zoom Integer 用户自定义地图缩放
示例值:3

ProductDevicesPositionItem

产品设备位置信息

被如下接口引用:DescribeDevicePositionList。

名称 类型 描述
Items Array of DevicePositionItem 设备位置列表
ProductId String 产品标识
示例值:9U7YFG7
Total Integer 设备位置数量
示例值:1

ProductEntry

产品详情

被如下接口引用:CreateStudioProduct, DescribeStudioProduct, GetStudioProductList, ModifyStudioProduct, SearchStudioProduct。

名称 类型 描述
ProductId String 产品ID
示例值:1
ProductName String 产品名称
示例值:1
CategoryId Integer 产品分组模板ID
示例值:0
EncryptionType String 加密类型。1表示证书认证,2表示密钥认证,21表示TID认证-SE方式,22表示TID认证-软加固方式
示例值:0
NetType String 连接类型。如:
wifi、wifi-ble、cellular、5g、lorawan、ble、ethernet、wifi-ethernet、else、sub_zigbee、sub_ble、sub_433mhz、sub_else、sub_blemesh
示例值:0
DataProtocol Integer 数据协议 (1 使用物模型 2 为自定义类型)
示例值:0
ProductDesc String 产品描述
示例值:0
DevStatus String 状态 如:all 全部, dev 开发中, audit 审核中 released 已发布
示例值:0
CreateTime Integer 创建时间
示例值:0
UpdateTime Integer 更新时间
示例值:0
Region String 区域
示例值:0
ProductType Integer 产品类型。如: 0 普通产品 , 5 网关产品
示例值:0
ProjectId String 项目ID
示例值:0
ModuleId Integer 产品ModuleId
示例值:0
EnableProductScript String 是否使用脚本进行二进制转json功能 可以取值 true / false
示例值:1
CreateUserId Integer 创建人 UinId
示例值:1
CreatorNickName String 创建者昵称
示例值:1
BindStrategy Integer 绑定策略(1:强踢;2:非强踢;0:表示无意义)
示例值:1
DeviceCount Integer 设备数量
示例值:1
Rate String 平均传输速率
示例值:1_0_mbps
Period String 有效期
示例值:5_year
IsInterconnection Integer 互联互通标识
示例值:1

ProductModelDefinition

产品模型定义

被如下接口引用:DescribeModelDefinition。

名称 类型 描述
ProductId String 产品ID
示例值:4ON538D9AX
ModelDefine String 模型定义
示例值:{"dev":1}
UpdateTime Integer 更新时间,秒级时间戳
示例值:196350245
CreateTime Integer 创建时间,秒级时间戳
示例值:196350245
CategoryModel String 产品所属分类的模型快照(产品创建时刻的)
示例值:{"dev":1}
NetTypeModel String 产品的连接类型的模型
示例值:{"dev":1}

ProjectEntry

项目详情

被如下接口引用:CreateProject, ModifyProject。

名称 类型 描述
ProjectId String 项目ID
示例值:prj-9Oj8t
ProjectName String 项目名称
示例值:项目名称
ProjectDesc String 项目描述
示例值:这是一个项目
CreateTime Integer 创建时间,unix时间戳
示例值:19200000
UpdateTime Integer 更新时间,unix时间戳
示例值:19200000

ProjectEntryEx

项目详情

被如下接口引用:DescribeProject, GetProjectList。

名称 类型 描述
ProjectId String 项目ID
示例值:proj-eaf12je
ProjectName String 项目名称
示例值:AI项目
ProjectDesc String 项目描述
示例值:这是一个AI测试项目
CreateTime Integer 项目创建时间,unix时间戳
示例值:0
UpdateTime Integer 项目更新时间,unix时间戳
示例值:0
ProductCount Integer 产品数量
示例值:0
NativeAppCount Integer NativeApp数量
示例值:0
WebAppCount Integer WebApp数量
示例值:0
InstanceId String 实例ID
示例值:ins-afe56grg
ApplicationCount Integer 应用数量
示例值:0
DeviceCount Integer 设备注册总数
示例值:0
EnableOpenState Integer 是否开通物联使能
示例值:0

RegisteredDeviceNetTypeInfo

已注册通信类型信息

被如下接口引用:DescribeActivateDevice。

名称 类型 描述
NormalDeviceNum Integer 普通设备数
示例值:1
BluetoothDeviceNum Integer 蓝牙设备数
示例值:1

RegisteredDeviceTypeInfo

已注册设备类型信息

被如下接口引用:DescribeActivateDevice。

名称 类型 描述
NormalDeviceNum Integer 已注册设备数
示例值:1
GatewayDeviceNum Integer 已注册网关数
示例值:1
SubDeviceNum Integer 已注册子设备数
示例值:1
VideoDeviceNum Integer 已注册视频设备数
示例值:1

SearchKeyword

搜索关键词

被如下接口引用:DescribeFirmwareTaskDevices, DescribeFirmwareTasks, ListFirmwares, ListOtaModules。

名称 类型 必选 描述
Key String 搜索条件的Key
示例值:tag
Value String 搜索条件的值
示例值:product1

SeeCallbackInfo

TWeSee 回调目标信息

被如下接口引用:DescribeTWeSeeCallback, ListTWeSeeCallback。

名称 类型 描述
CallbackId String 回调目标 ID
示例值:callback-iak6g98u
CallbackToken String 回调签名 token
示例值:your-token-here
CallbackUrl String 回调 URL
示例值:https://example.qq.com/twesee-callback
CreateTime Integer 创建时间(秒级时间戳)
示例值:1738827748
Type String 回调类型
示例值:http
UpdateTime Integer 更新时间(秒级时间戳)
示例值:1738827789

SeeCompHighlightConfig

TWeSee 视频语义浓缩配置

被如下接口引用:DescribeTWeSeeSubscription, ModifyTWeSeeSubscription。

名称 类型 必选 描述
DisableHighlight Boolean 是否禁用视频浓缩
示例值:false
DetectTypes Array of String 包含在浓缩结果中的目标类别。可选值:

- person:人
- pet:宠物
- vehicle:车辆
示例值:["pet"]
EnableSummary Boolean 指定是否返回浓缩视频的摘要文本
示例值:true
KeyFramesNum Integer 指定返回的关键帧图像数量
示例值:5

SeeCompHighlightResult

TWeSee 视频语义浓缩结果

被如下接口引用:DescribeTWeSeeTask, ListTWeSeeTasks。

名称 类型 描述
Summary String 摘要文本

SeeComprehensionConfig

TWeSee 视觉理解配置

被如下接口引用:CreateTWeSeeDirectUploadCredential, DescribeTWeSeeSubscription, InvokeTWeSeeComprehension, ModifyTWeSeeSubscription。

名称 类型 必选 描述
DetectTypes Array of String

拓展的目标及事件检测类别
枚举值:

  • person:人
  • vehicle:车辆
  • cat:猫
  • dog:狗
  • package:快递包裹
  • license_plate:车牌
  • fire:火焰
  • smoke:烟雾
  • delivery_man:快递员/外卖员
  • pet:有宠物
  • pet_scratching_door:宠物挠门
  • pet_barking:宠物吠叫
  • pet_damaging:宠物损坏家具
  • pet_eating:宠物进食
  • person_playing_with_pet:人与宠物玩耍
  • pet_close_to_camera:宠物靠近摄像头
  • animal_lying:有动物躺/趴在地上
  • child:有小孩
  • child_near_water:小孩靠近水域
  • child_falling:小孩摔倒
  • child_climbing_window:小孩攀爬室内窗户
  • child_entering_kitchen:小孩进入厨房
  • child_playing_danger_item:小孩玩危险物品
  • child_writing:小孩写作业
  • baby:有婴儿
  • baby_crying:婴儿哭闹
  • baby_dropping:婴儿跌落床铺
  • person_holding_baby:有人抱起婴儿
  • baby_rolling:婴儿翻滚
  • elderly:有老人
  • elderly_falling:老人摔倒
  • elderly_eating:老人用餐
  • elderly_using_stove:老人使用灶具
  • vehicle_parking:车辆停靠
  • vehicle_entering:车辆进入
  • vehicle_exiting:车辆离开
  • person_feeding_animal:有人投喂牲畜
  • animal_wild_intrusion:野生动物入侵
  • throwing_into_water:有人投掷物品
  • loitering_near_water:有人岸边逗留
  • fishing:有人钓鱼
  • net_fishing:有人撒网
  • person_carrying_fishing_gear:有人携带渔具
  • person_carrying_object:有人搬运物品
  • person_taking_goods:有人拿商品
  • person_night_moving:夜间有人移动
  • crowd:多人聚集
  • person_picking_fruit:有人采摘果实
  • person_at_cashier:有人在收银台
  • person_climbing_fence:有人翻围墙
  • person_carrying_bag:有人携带包裹
  • person_entering_farm:人员进入农场
  • person_entering_store:人员进入店铺
  • person_falling:有人跌倒
  • staff_absent:员工离岗
  • uniform_abnormal:未穿工服
  • using_mobile_phone:使用手机
  • smoking:有人吸烟
  • knife:有人持刀
  • gun:有人持枪
  • hurt:有人受伤流血
  • fight:有人打架
  • door_window_open:门窗被开启
  • fireworks:有人燃放烟花爆竹
  • no_signal:视频画面异常(无信号等)
  • camera_angle_abnormal:摄像头角度异常
  • person_motionless:有人且其姿势保持静止

示例值:["baby"]
EnableSearch Boolean

使该视频 / 图片录入搜索库,后续可进行搜索


示例值:true
OutputLang String

主输出语言,可选值包括:

  • zh 中文(默认值)
  • en 英语
  • ja 日语
  • ko 韩文
  • pt-BR 葡萄牙语(巴西)
  • th 泰语
  • ms 马来语

示例值:zh
AlternativeOutputLang String

次选输出语言,可选值包括:

  • zh 中文
  • en 英语
  • ja 日语
  • ko 韩文
  • pt-BR 葡萄牙语(巴西)
  • th 泰语
  • ms 马来语

示例值:en
MultiCameraLayout String

多摄像头布局定义。可选值包括:

  • 单摄(默认值):Single

  • 双摄(纵向排列)- 全部画面:Vertical,Num=2,Index=0;1

  • 双摄(纵向排列)- 画面1:Vertical,Num=2,Index=0

  • 双摄(纵向排列)- 画面2:Vertical,Num=2,Index=1

  • 三摄(纵向排列)- 全部画面:Vertical,Num=3,Index=0;1;2

  • 三摄(纵向排列)- 画面1:Vertical,Num=3,Index=0

  • 三摄(纵向排列)- 画面2:Vertical,Num=3,Index=1

  • 三摄(纵向排列)- 画面3:Vertical,Num=3,Index=2

  • 三摄(纵向排列)- 画面1+2:Vertical,Num=3,Index=0;1

  • 三摄(纵向排列)- 画面1+3:Vertical,Num=3,Index=0;2

  • 三摄(纵向排列)- 画面2+3:Vertical,Num=3,Index=1;2


示例值:Single
CustomDetectQueries Array of VisionCustomDetectQuery

自定义检测标签

MaxDuration Integer

最大处理的输入视频时长,单位:秒(仅对视频输入生效)


示例值:15
EnableKeywords Boolean

是否生成关键词

默认值:false


示例值:true
SummaryPrompt String

自定义摘要提示词


示例值:重点描述画面中的变化与视觉特征

SeeComprehensionResult

TWeSee 视觉理解结果

被如下接口引用:DescribeTWeSeeTask, InvokeTWeSeeComprehension, ListTWeSeeTasks。

名称 类型 描述
DetectedClassifications Array of String

识别到的目标类型与事件标签。
枚举值:

  • person:人
  • vehicle:车辆
  • cat:猫
  • dog:狗
  • package:快递包裹
  • license_plate:车牌
  • fire:火焰
  • smoke:烟雾
  • delivery_man:快递员/外卖员
  • pet:有宠物
  • pet_scratching_door:宠物挠门
  • pet_barking:宠物吠叫
  • pet_damaging:宠物损坏家具
  • pet_eating:宠物进食
  • person_playing_with_pet:人与宠物玩耍
  • pet_close_to_camera:宠物靠近摄像头
  • animal_lying:有动物躺/趴在地上
  • child:有小孩
  • child_near_water:小孩靠近水域
  • child_falling:小孩摔倒
  • child_climbing_window:小孩攀爬室内窗户
  • child_entering_kitchen:小孩进入厨房
  • child_playing_danger_item:小孩玩危险物品
  • child_writing:小孩写作业
  • baby:有婴儿
  • baby_crying:婴儿哭闹
  • baby_dropping:婴儿跌落床铺
  • person_holding_baby:有人抱起婴儿
  • baby_rolling:婴儿翻滚
  • elderly:有老人
  • elderly_falling:老人摔倒
  • elderly_eating:老人用餐
  • elderly_using_stove:老人使用灶具
  • vehicle_parking:车辆停靠
  • vehicle_entering:车辆进入
  • vehicle_exiting:车辆离开
  • person_feeding_animal:有人投喂牲畜
  • animal_wild_intrusion:野生动物入侵
  • throwing_into_water:有人投掷物品
  • loitering_near_water:有人岸边逗留
  • fishing:有人钓鱼
  • net_fishing:有人撒网
  • person_carrying_fishing_gear:有人携带渔具
  • person_carrying_object:有人搬运物品
  • person_taking_goods:有人拿商品
  • person_night_moving:夜间有人移动
  • crowd:多人聚集
  • person_picking_fruit:有人采摘果实
  • person_at_cashier:有人在收银台
  • person_climbing_fence:有人翻围墙
  • person_carrying_bag:有人携带包裹
  • person_entering_farm:人员进入农场
  • person_entering_store:人员进入店铺
  • person_falling:有人跌倒
  • staff_absent:员工离岗
  • uniform_abnormal:未穿工服
  • using_mobile_phone:使用手机
  • smoking:有人吸烟
  • knife:有人持刀
  • gun:有人持枪
  • hurt:有人受伤流血
  • fight:有人打架
  • door_window_open:门窗被开启
  • fireworks:有人燃放烟花爆竹
  • no_signal:视频画面异常(无信号等)
  • camera_angle_abnormal:摄像头角度异常
  • person_motionless:有人且其姿势保持静止

示例值:["cat"]
Summary String

摘要文本


示例值:一只猫坐在吉他盒里,旁边有只小鸟飞过
AlternativeSummary String

摘要文本(次选语言)


示例值:A person in light-colored clothes walking on a wet and slippery roadside after the rain
ErrorCode String

错误码,可能取值:

  • DownloadFailed:下载视频/图片文件失败
  • ReadFailed:读取视频/图片文件失败

示例值:DOWNLOAD_FAILED
ErrorMsg String

错误消息


示例值:Input file is not a video
Keywords Array of String

生成的关键词列表

当配置 EnableKeywords 为 true 时返回


示例值:["行人"]

SeeDetectContinuousConfig

TWeSee 标签持续检测配置

被如下接口引用:CreateTWeSeeRecognitionTask, CreateTWeSeeRecognitionTaskWithFile, DescribeTWeSeeConfig, InvokeTWeSeeRecognitionTask, InvokeTWeSeeRecognitionTaskWithFile, ModifyTWeSeeConfig。

名称 类型 必选 描述
DetectType String 检测标签。可选值:
- person_motionless:人物静止
示例值:person_motionless
DailyStartTime Integer 启用检测的按日周期起始时间分钟数。取值范围:0 ~ 1440
示例值:0
DailyEndTime Integer 启用检测的按日周期结束时间分钟数。取值范围:0 ~ 1440
示例值:1440
Interval Integer 检测间隔分钟数。取值范围:5 ~ 60。
示例值:5

SeeDetectContinuousResult

TWeSee 标签持续检测结果

被如下接口引用:DescribeTWeSeeTask, ListTWeSeeTasks。

名称 类型 描述
IsContinuousInRange Boolean 检测标签是否在当前区间内持续
示例值:true

SeeEventIdFilterConfig

TWeSee 处理云存事件 EventId 的过滤规则配置

被如下接口引用:DescribeTWeSeeConfig, DescribeTWeSeeSubscription, ModifyTWeSeeConfig, ModifyTWeSeeSubscription。

名称 类型 必选 描述
IncludeOnly Array of String 包含的云存事件 ID 集合
示例值:["_sys_id2_data"]
Exclude Array of String 排除的云存事件 ID 集合
示例值:["_sys_id3_data"]

SeeStatItem

TWeSee 统计数据点

被如下接口引用:DescribeTWeSeeTaskStatistics。

名称 类型 描述
Time String 时间
示例值:2026-04-20 00:00:00
Count Integer 任务数量
示例值:1
CostBasic Integer 基础能力用量
示例值:1
CostAdvanced Integer 高级能力用量
示例值:1

SeeTaskInfo

TWeSee 任务详情

被如下接口引用:DescribeTWeSeeTask, ListTWeSeeTasks。

名称 类型 描述
TaskId String 任务 ID
示例值:comp-aed98063-6574-867d-7e9e-a689e3aefbb5
Status Integer 任务状态。可能取值:

- 1:失败
- 2:空结果
- 3:有效结果
- 4:处理中
示例值:2
Metadata SeeTaskMetadata 任务元数据
ServiceCategory String 算法类目。可能取值:

- COMPREHENSION:视觉理解
- HIGHLIGHT:视频浓缩
示例值:COMPREHENSION
ServiceType String 算法类型。可能取值:

- VID_COMP:视频理解
- IMG_COMP:图片理解
- COMP_HIGHLIGHT:视频浓缩
示例值:VID_COMP
ServiceTier String 套餐规格。可能取值:

- POSTPAID:后付费(适用于视频理解、图片理解)
- BASIC:包年包月基础版(适用于视频理解)
示例值:POSTPAID
ComprehensionResult SeeComprehensionResult 视觉理解结果(适用于视频理解、图片理解)
CompHighlightResult SeeCompHighlightResult 视频语义浓缩结果(适用于视频语义浓缩)
DetectContinuousResult SeeDetectContinuousResult 标签持续检测结果
CostBasic Integer 完成该任务所消耗的基础能力额度
示例值:1
CostAdvanced Integer 完成该任务所消耗的高级能力额度
示例值:1
Files Array of String 输出文件名列表
示例值:["output.mp4"]
FilesInfo Array of CloudStorageAIServiceTaskFileInfo 输出文件详情列表
CreateTime Integer 创建时间
示例值:1776619154
UpdateTime Integer 最后更新时间
示例值:1776619157

SeeTaskMetadata

TWeSee 任务元数据

被如下接口引用:DescribeTWeSeeTask, InvokeTWeSeeComprehension, ListTWeSeeTasks。

名称 类型 必选 描述
ProductId String 产品 ID
示例值:4AHMY9X89Y
DeviceName String 设备名称
示例值:dev002
ChannelId Integer 通道 ID
示例值:0
StartTimeMs Integer 事件起始时间(毫秒级时间戳)
示例值:1776629102000
EndTimeMs Integer 事件结束时间(毫秒级时间戳)
示例值:1776629110000
CustomId String 自定义事件 ID
示例值:_sys_id1_data

SubscribedTopicItem

已订阅Topic信息

被如下接口引用:DescribeSubscribedTopicPolicy。

名称 类型 描述
TopicName String Topic名称
示例值:$thing/down/property/TRTC3ZC/dev

TRTCParams

TRTC 的参数 可以用来加入房间

被如下接口引用:CreateTRTCSignaturesWithRoomId。

名称 类型 描述
SdkAppId Integer TRTC入参: TRTC的实例ID
示例值:34561
UserId String TRTC入参: 用户加入房间的ID
示例值:test1236
UserSig String TRTC入参: 用户的签名用来鉴权
示例值:45tgdh65yuej
StrRoomId String TRTC入参: 加入的TRTC房间名称
示例值:12909
PrivateKey String TRTC入参: 校验TRTC的KEY
示例值:45tgdh65yuej

TWeCallActiveInfo

TWeCall设备激活信息

被如下接口引用:GetTWeCallActiveStatus。

名称 类型 描述
Sn String Sn信息
示例值:p_d
ExpireTime Integer 过期时间
示例值:1920000000
PkgType Integer 类型
示例值:1

TWeCallInfo

TWeCall信息

被如下接口引用:ActivateTWeCallLicense, GetTWeCallActiveStatus, PauseTWeCallDevice, ResetTWeCallDevice, ResumeWeCallDevice。

名称 类型 必选 描述
Sn String Sn信息,SN格式:产品ID_设备名
示例值:productId_deviceName

TWeCallLicenseInfo

TWeCall信息

被如下接口引用:DescribeActivateLicenseService。

名称 类型 必选 描述
TWeCallType String voip类型
示例值:1
TotalNum Integer 总数
示例值:1
UsedNum Integer 已使用
示例值:1

TalkAIBotInfo

Talk配置信息描述。

被如下接口引用:DescribeTWeTalkAIBot, GetTWeTalkAIBotList。

名称 类型 必选 描述
Uin Integer UIN
示例值:100000103009
AppId Integer APPID
示例值:251198731
InstanceId String 实例ID
示例值:ins-DGAFvpuVF7
BotId String 智能体ID
示例值:bot-0vVbAeOMxU
Name String 名称
示例值:test测试
Description String 描述
示例值:测试一下
TargetLanguage String 语言
示例值:zh
STTConfig TalkSTTConfigInfo 语音识别
LLMConfig TalkLLMConfigInfo 大模型
TTSConfig TalkTTSConfigInfo 语音合成
AgentConfig TalkAgentConfigInfo 智能体配置
CreateTime Integer 创建时间
示例值:1762416705
UpdateTime Integer 更新时间
示例值:1762429312
BoundProducts Array of TalkProductInfo 已关联产品信息列表
CustomTools String 自定义工具列表,最多可创建10个
示例值:[{"type":"function","function":{"name":"get_battery","description":"查询电量","parameters":{"properties":{"device_id":{"description":"设备ID","type":"string"}},"required":["device_id"],"type":"object"}}}]
WebhookTools String WebHook工具配置(JSON字符串格式)
示例值:[{"name":"query_order","description":"查询订单信息","properties":{"order_id":{"description":"订单ID","type":"string"}},"required":["order_id"],"url":"https://api.example.com/webhook/order/query","timeout":30,"auth":{"sign_key":"demo-sign-key"}}]
BotType String 智能体模板类型
示例值:mobile_app
RAGConfig String 知识库相关配置(JSON字符串格式)
示例值:{"RAGEnabled":true,"KnowledgeBaseId":"kb-test-001","RAGRegion":"ap-guangzhou","RAGTopK":5,"RAGScoreThreshold":0.75,"RAGRetrievalMethod":"SEMANTIC","RAGRoleExternalId":"external-id-demo","RAGRoleDurationSeconds":3600}

TalkActivateRecordLogInfo

Talk激活审计信息。

被如下接口引用:GetTWeTalkActiveRecordList。

名称 类型 描述
ProductId String 产品ID
示例值:EMN48GTRHG
DeviceName String 设备名称
示例值:d1
ActiveTime Integer 激活时间,秒级时间戳
示例值:1772015225
ExpireTime Integer 过期时间,秒级时间戳
示例值:10986480696
ServiceType Integer TWeTalk类型:1-基础版;2-高级版;3-多模态;
示例值:3
Status Integer 状态: 0-未激活, 1-已激活, 2-已过期, 3-已作废
示例值:1
ErrorMsg String 错误信息
示例值:成功

TalkActivationInfo

Talk设备激活信息。

被如下接口引用:ActivateTWeTalk。

名称 类型 必选 描述
DeviceId String 设备ID,产品ID_设备名称
示例值:HX3VWPFMVX_dev
ErrCode Integer 设备激活状态,0:激活成功;60001:激活码类型不匹配;60002:激活码数量不足;60003:设备不存在;60004:产品不存在;60005:权限不足;60006:设备已激活;60007:无效的参数;60008:系统错误;60009:产品不是码音视频类型
示例值:60009
ErrMessage String 激活错误信息
示例值:激活码数量不足
ExpireTime Integer 过期时间,秒级时间戳
示例值:1804747877

TalkActivationStatusInfo

Talk激活状态响应定义。

被如下接口引用:GetTWeTalkActiveStatus。

名称 类型 描述
DeviceId String 设备ID,产品ID_设备名称
示例值:RNSEEMTZB0_dev
ExpireTime Integer 过期时间,秒级时间戳
示例值:11270477496
ServiceType Integer TWeTalk类型:1-基础版;2-高级版;3-多模态;
示例值:0

TalkAgentBinding

智能体绑定配置

被如下接口引用:DescribeTWeTalkAgent, DescribeTWeTalkAgentBinding, DescribeTWeTalkAgentList。

名称 类型 必选 描述
BindingScope String product 或 device
ProductId String 产品ID
DeviceName String 设备名称
AgentId String 智能体ID
Priority Integer 绑定优先级
CreateTime Integer 创建时间,Unix 秒
UpdateTime Integer 更新时间,Unix 秒

TalkAgentConfigInfo

智能体配置信息。

被如下接口引用:CreateTWeTalkAIBot, DescribeTWeTalkAIBot, GetTWeTalkAIBotList, ModifyTWeTalkAIBot。

名称 类型 必选 描述
SessionTimeout Integer 会话超时(秒),指连接会话的时间,例如30秒是指会话在30秒后断开
示例值:7200
InterruptionEnabled Boolean 允许打断
示例值:true
MaxContextTokens Integer 最大上下文
示例值:3000
IdleDetection TalkIdleDetectionConfigInfo 空闲检测配置
EmotionEnabled Boolean 是否启用情绪识别
示例值:true
SemanticVADEnabled Boolean 是否启用语义vad
示例值:true
SemanticVADSensitivity Integer 语义vad灵敏度, 1-慢 2-适中 3-快
示例值:2
SilenceTime Integer VAD 静默检测时间, 当开启语义vad此配置失效
示例值:500
NoiseFilterEnabled Boolean 是否启用噪声过滤
示例值:true
LongTermMemoryEnabled Boolean 是否开启长记忆,默认关闭
示例值:true
SystemPrompt String 系统提示词,仅当未配置LLMConfig时使用
示例值:# 身份与角色 1. 你的名字叫"QQ鹅仔",你是一个陪伴用户的忠实伙伴,内心充满好奇和温暖。 2. 你的目标是成为用户最贴心的朋友,提供情感陪伴和有用的帮助。
GreetingMessage String 开机问候语,如果未配置默认不开启
示例值:你好呀,我是"QQ鹅仔",今天过的怎么样呀?
DefaultVoiceType Integer 系统默认音色,当配置复刻音色时,默认值为200000000
示例值:601015
FastVoiceType String 复刻音色
示例值:WATCH-00999345
SubtitleCallbackUrl String 实时字幕回调地址,支持HTTP/HTTPS
示例值:https://aaa.bb.com/callback
SubtitleCallbackSignKey String 回调签名密钥,最大32字符,用于HMAC SHA256签名
示例值:aabbcc key
SubtitleCallbackTimeout Integer 字幕推送超时时间(秒),参考TRTC规范
示例值:5

TalkAgentInfo

TWeTalk智能体配置信息描述

被如下接口引用:DescribeTWeTalkAgent, DescribeTWeTalkAgentList。

名称 类型 必选 描述
Uin Integer 主账号UIN
AppId Integer 账号AppId
InstanceId String 实例 ID
AgentId String 智能体ID
Name String 智能体名称
Description String 智能体描述
STTConfig TalkSTTConfig 语音识别配置
LLMConfig TalkLLMConfig 大模型配置
TTSConfig TalkTTSConfig 语音合成配置
ConversationConfig TalkConversationConfig 对话行为配置
MemoryConfig TalkMemoryConfig 长期记忆配置
IOTTools Array of TalkIOTTool IoT 工具列表
WebhookTools Array of TalkWebhookTool Webhook 工具列表
Metadata String 元信息JSON object 字符串
Bindings Array of TalkAgentBinding 绑定关系列表
CreateTime Integer 创建时间,Unix 秒
UpdateTime Integer 更新时间,Unix 秒

TalkBasicConfigInfo

基础配置信息。

被如下接口引用:CreateTWeTalkProductConfigV2, DescribeTWeTalkProductConfigV2, GetTWeTalkProductConfigListV2, ModifyTWeTalkProductConfigV2。

名称 类型 必选 描述
SystemPrompt String 系统提示词
示例值:你是一个助手
GreetingMessage String 欢迎语,支持多个欢迎语随机切换,格式:字符串数组,JSON字符串。
示例值:["你好呀,我是小冰,今天过的怎么样呢","你好,今天开心吗"]
DefaultVoiceType Integer 音色,支持的音色列表:100510000-阅读男声智逍遥;101001-情感女声智瑜;101002-通用女声智聆;101003-客服女声智美;101004-通用男声智云;101005-通用女声智莉;101006-助手女声智言;101008-客服女声智琪;101009-知性女声智芸;101010-通用男声智华;101011-新闻女声智燕;101012-新闻女声智丹;101013-新闻男声智辉;101014 -新闻男声智宁;101015-男童声智萌;101016-女童声智甜;101017-情感女声智蓉;101018-情感男声智靖;101019-粤语女声智彤。
示例值:10016
FastVoiceType String 复刻音色ID,当不为空时,DefaultVoiceType为200000000
示例值:wdc-wf45y25

TalkConversationConfig

对话行为配置

被如下接口引用:CreateTWeTalkAgent, DescribeTWeTalkAgent, DescribeTWeTalkAgentList, ModifyTWeTalkAgent。

名称 类型 必选 描述
WelcomeMessage String 欢迎语
WelcomeMessagePriority Integer 欢迎语优先级。0=默认,1=高优不可打断
InterruptMode Integer 智能打断模式。0=服务端自动打断,1=端上发送打断信令
InterruptWordList Array of String 打断词列表。AI 说话期间,仅当用户说出列表中的词才打断 AI;不会触发新的回复

TalkConversationConfigInfo

会话配置信息。

被如下接口引用:CreateTWeTalkProductConfigV2, DescribeTWeTalkProductConfigV2, GetTWeTalkProductConfigListV2, ModifyTWeTalkProductConfigV2。

名称 类型 必选 描述
SessionTimeout Integer 会话超时(秒)
示例值:1000
InterruptionEnabled Boolean 允许打断
示例值:true
MaxContextTokens Integer 最大上下文
示例值:20000
IdleDetection TalkIdleDetectionConfigInfo 空闲检测配置
EmotionEnabled Boolean 是否启用情绪识别
示例值:true
SemanticVADEnabled Boolean 是否启用语义vad
示例值:false
NoiseFilterEnabled Boolean 是否启用噪声过滤
示例值:false

TalkIOTTool

IoT工具配置列表

被如下接口引用:CreateTWeTalkAgent, DescribeTWeTalkAgent, DescribeTWeTalkAgentList, ModifyTWeTalkAgent。

名称 类型 必选 描述
Name String 工具名称,同时作为IoT ActionId
Description String 工具描述,用于模型判断何时调用
Parameters String 工具参数JSON Schema,JSON对象字符串,必须为type=object
Required Array of String 必填参数名列表,必须存在于Parameters.properties中

TalkIdleDetectionConfigInfo

空闲检测信息。

被如下接口引用:CreateTWeTalkAIBot, CreateTWeTalkProductConfigV2, DescribeTWeTalkProductConfigV2, GetTWeTalkProductConfigListV2, ModifyTWeTalkAIBot, ModifyTWeTalkProductConfigV2。

名称 类型 必选 描述
Enabled Boolean 是否启用
示例值:true
TimeoutSeconds Float 用户沉默多少秒后触发空闲回调
示例值:3.5
MaxRetries Integer 最大重试次数(1-3)
示例值:2
IdleResponses Array of IdleResponseInfo 空闲响应

TalkLLMConfig

大模型配置。基础对话必填;如使用平台默认能力,请显式设置 Type=default。

被如下接口引用:CreateTWeTalkAgent, DescribeTWeTalkAgent, DescribeTWeTalkAgentList, ModifyTWeTalkAgent。

名称 类型 必选 描述
Type String

LLM类型:default-平台默认;openai-OpenAI兼容模型


示例值:default
SystemPrompt String

系统提示词


示例值:你是一个暖男,照顾用户情绪
Temperature Float

采样温度,建议范围0-2


示例值:1
History Integer

上下文历史轮数,建议范围0-50


示例值:10
Timeout Integer

超时时间,秒


示例值:3
BaseUrl String

OpenAI兼容模型的Base URL,Type=openai时必填


示例值:https://api.deepseek.com/v1/chat/completions
Model String

模型名称,Type=openai时必填


示例值:deepseek-v4-flash
ApiKey String

模型API Key,Type=openai时必填


示例值:sk-**746729cbcdc4b9
ExtraBody String

额外模型请求体参数,JSON对象字符串,只允许JSON object,不允许普通字符串


示例值:{"thinking":{"type":"disabled"}}
ADP ADPConfig

ADP 平台配置

TalkLLMConfigInfo

LLM配置信息。

被如下接口引用:CreateTWeTalkAIBot, CreateTWeTalkProductConfigV2, DescribeTWeTalkAIBot, DescribeTWeTalkProductConfigV2, GetTWeTalkAIBotList, GetTWeTalkProductConfigListV2, ModifyTWeTalkAIBot, ModifyTWeTalkProductConfigV2。

名称 类型 必选 描述
LLMType String 支持的LLM类型,openai-OPENAI格式。
示例值:openai
Enabled Boolean 是否开启
示例值:true
Model String 模型
示例值:gpt4
Streaming Boolean 是否开启
示例值:true
Config String 配置信息JSON字符串,根据LLMType进行不同的值匹配。例如LLMTypeopenaiConfig值是{\"ApiKey\":\"sk-09***\",\"ApiUrl\":\"base_url\",\"SystemPrompt\":\"你是一个语音助手\",\"Timeout\":30,\"History\":0,\"MetaInfo\":{\"productID\":\"test\"}}

## openai

<br/>{<br/> "ApiKey": "sk-XXXXXXXXXXXX",<br/> "ApiUrl": "https://api.openai.com/v1",<br/> "SystemPrompt": "一个小小助手",<br/> "Timeout":20,<br/> "History":10,<br/> "MetaInfo":{}<br/>}<br/>

示例值:{"ApiKey":"sk-09***","ApiUrl":"base_url","SystemPrompt":"你是一个语音助手","Timeout":30,"History":0,"MetaInfo":{"productID":"test"}}
Temperature Float 温度
示例值:1.0
MaxTokens Integer 最大token数
示例值:3000
TopP Float topP
示例值:0.3
Tools Array of String 工具ID列表

TalkMemoryConfig

长期记忆配置。

被如下接口引用:CreateTWeTalkAgent, DescribeTWeTalkAgent, DescribeTWeTalkAgentList, ModifyTWeTalkAgent。

名称 类型 必选 描述
Enabled Boolean 是否启用长期记忆;启用时需满足产品和运行时能力要求

TalkProductConfigInfo

Talk配置信息描述。

被如下接口引用:DescribeTWeTalkProductConfig, GetTWeTalkProductConfigList。

名称 类型 必选 描述
ProductId String 产品ID
示例值:PCKOP3VBFZ
TargetLanguage String 支持的语言,zh-中文;en-英文;默认zh
示例值:zh
SystemPrompt String 系统提示词
示例值:你的名字叫QQ鹅仔,是一个陪伴用户的AI玩偶
GreetingMessage String 欢迎语
示例值:你好呀,我叫QQ鹅仔
VoiceType Integer 音色,支持的音色列表:100510000-阅读男声智逍遥;101001-情感女声智瑜;101002-通用女声智聆;101003-客服女声智美;101004-通用男声智云;101005-通用女声智莉;101006-助手女声智言;101008-客服女声智琪;101009-知性女声智芸;101010-通用男声智华;101011-新闻女声智燕;101012-新闻女声智丹;101013-新闻男声智辉;101014 -新闻男声智宁;101015-男童声智萌;101016-女童声智甜;101017-情感女声智蓉;101018-情感男声智靖;101019-粤语女声智彤。
示例值:50023
CreateTime Integer 创建时间
示例值:1755509182
UpdateTime Integer 更新时间
示例值:1755509182

TalkProductConfigV2Info

twetalk连接配置信息。

被如下接口引用:DescribeTWeTalkProductConfigV2, GetTWeTalkProductConfigListV2。

名称 类型 必选 描述
Uin Integer UIN
示例值:120336
AppId Integer APPID
示例值:102513
ProductId String 产品ID
示例值:O9IK9H3
DeviceName String 设备名称
示例值:dev
ConfigName String 配置名称
示例值:小冰
TargetLanguage String 语言,默认zh;zh-中文;en-英文
示例值:zh
BasicConfig TalkBasicConfigInfo 基础配置
STTConfig TalkSTTConfigInfo 语音识别配置
LLMConfig TalkLLMConfigInfo 大模型配置
TTSConfig TalkTTSConfigInfo 语音合成配置
ConversationConfig TalkConversationConfigInfo 会话配置
Version Integer 版本号
示例值:1
CreateTime Integer 创建时间,秒级时间戳
示例值:10023500
UpdateTime Integer 更新时间,秒级时间戳
示例值:10023500

TalkProductInfo

智能体产品信息。

被如下接口引用:DescribeTWeTalkAIBot, GetTWeTalkAIBotList。

名称 类型 必选 描述
ProductId String 产品ID
ProductName String 产品名称

TalkSTTConfig

语音识别配置

被如下接口引用:CreateTWeTalkAgent, DescribeTWeTalkAgent, DescribeTWeTalkAgentList, ModifyTWeTalkAgent。

名称 类型 必选 描述
Type String 当前仅支持 trtc(使用 TRTC 内置语音识别)。
TRTC TalkSTTTRTC Type=trtc 时生效。整体省略表示全部使用 TRTC 默认值。

TalkSTTConfigInfo

STT配置信息。

被如下接口引用:CreateTWeTalkAIBot, CreateTWeTalkProductConfigV2, DescribeTWeTalkAIBot, DescribeTWeTalkProductConfigV2, GetTWeTalkAIBotList, GetTWeTalkProductConfigListV2, ModifyTWeTalkAIBot, ModifyTWeTalkProductConfigV2。

名称 类型 必选 描述
STTType String 支持的STT类型,tencent-腾讯;azure-亚马逊;deepgram-Deepgram;系统默认-tencent。
示例值:tencent
Enabled Boolean 是否开启
示例值:true
Config String 配置信息JSON字符串,根据STTType进行不同的值匹配。例如STTTypetencentConfig值是{\"AppId\":123456,\"SecretId\":\"secretId*****\",\"SecretKey\":\"SecretKey****\",\"EngineType\":\"16k_zh\"}

## tencent

<br/>{<br/> "AppId": 123456,<br/> "SecretId": "secretId*****",<br/> "SecretKey": "SecretKey****",<br/> "EngineType": "16k_zh"<br/>}<br/>


## azure

<br/>{<br/> "Region": "",<br/> "EndpointId": "id",<br/> "Language": "zh-CN",<br/> "SubscriptionKey": "*****"<br/>}<br/>


## deepgram

<br/>{<br/> "Model": "nova-2",<br/> "Language": "zh",<br/> "BaseUrl":"http://www.deepgram.com",<br/> "ApiKey": "SecretKey****"<br/>}<br/>


示例值:{"AppId":123456,"SecretId":"seceretId*","SecretKey":"SecretKey****","EngineType":"16k_zh"}

TalkSTTTRTC

TRTC STT配置

被如下接口引用:CreateTWeTalkAgent, ModifyTWeTalkAgent。

名称 类型 必选 描述
Language String

识别语言,只支持 zh16k_zh_large


示例值:zh
VADSilenceTime Integer

VAD 静默检测时间,单位 ms,范围 240–2000


示例值:300
VADLevel Integer

远场人声抑制等级,范围 0–5


示例值:3

TalkTTSConfig

当前仅支持 flow(TRTC Flow TTS)

被如下接口引用:CreateTWeTalkAgent, DescribeTWeTalkAgent, DescribeTWeTalkAgentList, ModifyTWeTalkAgent。

名称 类型 必选 描述
Type String TTS的类型
Flow TalkTTSFlow Flow TTS 的具体配置

TalkTTSConfigInfo

TTS配置信息。

被如下接口引用:CreateTWeTalkAIBot, CreateTWeTalkProductConfigV2, DescribeTWeTalkAIBot, DescribeTWeTalkProductConfigV2, GetTWeTalkAIBotList, GetTWeTalkProductConfigListV2, ModifyTWeTalkAIBot, ModifyTWeTalkProductConfigV2。

名称 类型 必选 描述
TTSType String 支持的LLM类型,支持tencent-腾讯;azure-亚马逊;volcengine-火山引擎;elevenlabs-ELEVENLABS;minimax-MINIMAX;cartesia-CARTESIA;aliyun-阿里;系统默认-tencent。
示例值:tencent
Enabled Boolean 是否开启
示例值:true
Config String 配置信息JSON字符串,根据TTSType进行不同的值匹配。例如TTSTypetencentConfig值是{\"AppId\":123456,\"SecretId\":\"secretId*****\",\"SecretKey\":\"SecretKey****\",\"VoiceType\":10001}

## tencent

<br/>{<br/> "AppId": 100203,<br/> "SecretId": "XXXX",<br/> "SecretKey": "XXXXX",<br/> "VoiceType":123456<br/>}<br/>


## azure

<br/>{<br/> "SubscriptionKey": 100203,<br/> "Region": "ch-zn",<br/> "VoiceName": "XXXXX",<br/> "Language":"zh"<br/>}<br/>

## elevenlabs

<br/>{<br/> "ModelId": 100203,<br/> "VoiceId": "ch-zn",<br/> "ApiKey": "XXXXX"<br/>}<br/>

## minimax

<br/>{ <br/> "Model":"xxxx",<br/> "ApiUrl": "346w34",<br/> "ApiKey": "xxx",<br/> "GroupId": "ion",<br/> "VoiceType":"xioawei"<br/>}<br/>

## cartesia

<br/>{ <br/> "Model":"xxxx",<br/> "ApiKey": "xxx",<br/> "VoiceId":"xioawei"<br/>}<br/>

## aliyun

<br/>{<br/> "VoiceType": 100203,<br/> "RegionId": "XXXX",<br/> "ApiKey": "XXXXX"<br/>}<br/>

## volcengine

<br/>{<br/> "AppId": "346w34",<br/> "AccessToken": "xxx",<br/> "ResourceId": "volc.bigasr.sauc.duration",<br/> "VoiceType":"xioawei"<br/>}<br/>


示例值:{"AppId":123456,"SecretId":"seceretId*","SecretKey":"SecretKey****","VoiceType":10001}
Speed Float 温度
示例值:1.0
Volume Float 最大token数
示例值:1.0
Pitch Float PITCH
示例值:1.0

TalkTTSFlow

Flow TTS 的具体配置

被如下接口引用:CreateTWeTalkAgent, ModifyTWeTalkAgent。

名称 类型 必选 描述
VoiceId String

精品音色 ID 或克隆音色 ID:具体可参考https://cloud.tencent.com/document/product/647/115414


示例值:v-male-P6q7LzD8
Speed Float

语速,范围 0.5–2.0;为 0 表示采用默认值


示例值:1

TalkWebhookAuth

Webhook鉴权配置

被如下接口引用:CreateTWeTalkAgent, ModifyTWeTalkAgent。

名称 类型 必选 描述
Type String 鉴权类型:none、hmac、static_headers、bearer
SignKey String HMAC签名密钥,Type=hmac时必填
Headers String 静态鉴权请求头,JSON对象字符串,仅允许白名单header名
BearerToken String Bearer Token,Type=bearer时用于生成Authorization请求头

TalkWebhookEndpoint

Webhook工具配置列表

被如下接口引用:CreateTWeTalkAgent, ModifyTWeTalkAgent。

名称 类型 必选 描述
Url String

Webhook地址,仅支持 80 和 443 端口


示例值:https://api.example.com/order/status
Timeout Integer

超时时间,0~30 秒

取值范围:[0, 30]


示例值:3

TalkWebhookTool

Webhook工具配置列表

被如下接口引用:CreateTWeTalkAgent, DescribeTWeTalkAgent, DescribeTWeTalkAgentList, ModifyTWeTalkAgent。

名称 类型 必选 描述
Name String Webhook工具名称
Description String Webhook工具描述
Parameters String 工具参数JSON Schema,JSON对象字符串,必须为type=object
Endpoint TalkWebhookEndpoint Webhook HTTP端点配置
Required Array of String 必填参数名列表,必须存在于Parameters.properties中
Auth TalkWebhookAuth Webhook鉴权配置

TargetInfo

视频语义搜索结果

被如下接口引用:DescribeAISearchTaskAsync, InvokeAISearchService。

名称 类型 描述
Id String

视频唯一ID


示例值:unique
ProductId String

产品ID


示例值:MVTYMD8YCD
DeviceName String

设备名称


示例值:dev001
StartTimeMs Integer

视频起始时间(毫秒级Unix时间戳)


示例值:1744258527
EndTimeMs Integer

视频结束时间(毫秒级Unix时间戳)


示例值:1744258537
EventId String

用户自定义事件ID,后续扩展使用


示例值:alarm
Summary String

视频内容摘要


示例值:Two cats and a dog eating
ChannelId Integer

通道ID


示例值:0
Thumbnail String

缩略图路径


示例值:/product/1.jpg

ThumbnailURLInfoList

缩略图信息

被如下接口引用:DescribeCloudStorageMultiThumbnail, DescribeCloudStorageThumbnailList。

名称 类型 必选 描述
ThumbnailURL String 缩略图访问地址
示例值:https://video-cv-1258344699.cos.ap-guangzhou.myqcloud.com/%2F100
ExpireTime Integer 缩略图访问地址的过期时间
示例值:1690195335

TopicItem

Topic信息, 包括Topic名字和权限

被如下接口引用:ListTopicPolicy。

名称 类型 描述
TopicName String Topic名称
示例值:leo
Privilege Integer Topic权限 , 1上报 2下发
示例值:1

TopicRule

TopicRule结构

被如下接口引用:DescribeTopicRule。

名称 类型 描述
RuleName String 规则名称。
示例值:温度达到20开空调
Sql String 规则的SQL语句,如: SELECT * FROM 'pid/dname/event',然后对其进行base64编码,得:U0VMRUNUICogRlJPTSAncGlkL2RuYW1lL2V2ZW50Jw==
示例值:U0VMRUNUICAgRlJPTSAnJChwcm9kdWN0aWQpLyQoZGV2aWNlbmFtZSkvZXZlbnQn
Description String 规则描述。
示例值:温度达到20开空调
Actions String 行为的JSON字符串。
示例值:["*"]
RuleDisabled Boolean 是否禁用规则
示例值:false

TopicRuleInfo

规则信息

被如下接口引用:GetTopicRuleList, SearchTopicRule。

名称 类型 描述
RuleName String 规则名称
示例值:物联数据规则转发
Description String 规则描述
示例值:这是一个物联规则转发数据
CreatedAt Integer 创建时间
示例值:1680230233
RuleDisabled Boolean 规则是否禁用
示例值:false

TopicRulePayload

TopicRulePayload结构

被如下接口引用:CreateTopicRule, ModifyTopicRule。

名称 类型 必选 描述
Sql String 规则的SQL语句,如: SELECT * FROM 'pid/dname/event',然后对其进行base64编码,得:U0VMRUNUICogRlJPTSAncGlkL2RuYW1lL2V2ZW50Jw==
示例值:U0VMRUNUICAgRlJPTSAnJChwcm9kdWN0aWQpLyQoZGV2aWNlbmFtZSkvZXZlbnQn
Actions String 行为的JSON字符串,大部分种类举例如下:
[
{
"republish": {
"topic": "TEST/test"
}
},
{
"forward": {
"api": "http://test.com:8080"
}
},
{
"ckafka": {
"instance": {
"id": "ckafka-test",
"name": ""
},
"topic": {
"id": "topic-test",
"name": "test"
},
"region": "gz"
}
},
{
"cmqqueue": {
"queuename": "queue-test-TEST",
"region": "gz"
}
},
{
"mysql": {
"instanceid": "cdb-test",
"region": "gz",
"username": "test",
"userpwd": "*",
"dbname": "d_mqtt",
"tablename": "t_test",
"fieldpairs": [
{
"field": "test",
"value": "test"
}
],
"devicetype": "CUSTOM"
}
}
]
示例值:["In"]
Description String 规则描述
示例值:开空调
RuleDisabled Boolean 是否禁用规则
示例值:false

VideoLicenseEntity

视频设备激活码统计

被如下接口引用:DescribeVideoLicense。

名称 类型 描述
Type String 激活码类型,取值范围如下:0_5_mbps、1_mbps、1_5_mbps、2_mbps
示例值:0_5_mbps
TotalCount Integer 有效激活码总数
示例值:1
UsedCount Integer 待使用的激活码数量
示例值:1
ExpiresSoonCount Integer 即将过期的激活码数量
示例值:0

VisionCustomDetectQuery

TWeSee 语义理解自定义标签请求

被如下接口引用:CreateTWeSeeDirectUploadCredential, CreateTWeSeeRecognitionTask, CreateTWeSeeRecognitionTaskWithFile, DescribeTWeSeeConfig, DescribeTWeSeeSubscription, InvokeTWeSeeComprehension, InvokeTWeSeeRecognitionTask, InvokeTWeSeeRecognitionTaskWithFile, ModifyTWeSeeConfig, ModifyTWeSeeSubscription。

名称 类型 必选 描述
Key String 自定义标签的标识符
示例值:query1
Query String 自定义标签的描述文本
示例值:快递员

VisionDetectedObject

目标检测算法检测到的目标详情

被如下接口引用:DescribeTWeSeeRecognitionTask, InvokeTWeSeeRecognitionTask, InvokeTWeSeeRecognitionTaskWithFile。

名称 类型 描述
Time Float 目标出现的媒体时间戳(以图片为输入时始终取值 0)
示例值:1.5
ClassName String 目标类别名
示例值:person
BoundingBox Array of Float 目标边界框(坐标顺序为 x1, y1, x2, y2)
示例值:[200.1,332.5,412.8,586.5]
Confidence Float 置信度(取值范围 0.0 至 1.0)
示例值:0.88

VisionObjectDetectConfig

目标检测配置

被如下接口引用:BatchCreateTWeSeeRecognitionTask, BatchInvokeTWeSeeRecognitionTask, CreateTWeSeeRecognitionTask, CreateTWeSeeRecognitionTaskWithFile, InvokeTWeSeeRecognitionTask, InvokeTWeSeeRecognitionTaskWithFile。

名称 类型 必选 描述
DetectTypes Array of String 检测类别,可选值:
- adult:成年人
- child:儿童
示例值:["adult", "child"]

VisionRecognitionResult

TWeSee 语义理解结果

被如下接口引用:BatchInvokeTWeSeeRecognitionTask, DescribeTWeSeeRecognitionTask, InvokeTWeSeeRecognitionTask, InvokeTWeSeeRecognitionTaskWithFile。

名称 类型 描述
Status Integer 任务状态(1:分析失败;2:下载/读取视频/图片失败;3:成功;4:执行中)
示例值:3
DetectedClassifications Array of String 识别到的目标类型。可能取值:

- person:人
- vehicle:车辆
- dog:狗
- cat:猫
- fire:火焰
- smoke:烟雾
- package:快递包裹
- license_plate:车牌
示例值:["person"]
Summary String 摘要文本
示例值:一人在水泥地面上行走
AlternativeSummary String 摘要文本(次选语言)
示例值:A person walking on the concrete floor
ErrorCode String 错误码,可能取值:

- DownloadFailed:下载视频/图片文件失败
- ReadFailed:读取视频/图片文件失败
示例值:DownloadFailed
DetectedObjects Array of VisionDetectedObject 目标检测算法检测到的目标列表

VisionRecognitionTask

TWeSee 语义理解任务信息

被如下接口引用:DescribeTWeSeeRecognitionTask。

名称 类型 描述
TaskId String 云存 AI 服务任务 ID
示例值:fb066d7a-baac-4706-acda-058f56f82759
ProductId String 产品 ID
示例值:TQBDY6RPI9
DeviceName String 设备名称
示例值:cs_112114601_2
ChannelId Integer 通道 ID
示例值:0
StartTime Integer 对应云存视频的起始时间(秒级 UNIX 时间戳)
示例值:1710487888
StartTimeMs Integer 对应云存视频的起始时间(毫秒级 UNIX 时间戳)
示例值:1710487888270
EndTime Integer 对应云存视频的结束时间(秒级 UNIX 时间戳)
示例值:1710487898
EndTimeMs Integer 对应云存视频的结束时间(毫秒级 UNIX 时间戳)
示例值:1710487898990
Status Integer 任务状态(1:分析失败;2:下载/读取视频/图片失败;3:成功;4:执行中)
示例值:3
Result VisionRecognitionResult 任务结果
CreateTime Integer 创建时间
示例值:1711338476
UpdateTime Integer 最后更新时间
示例值:1711338476
CustomId String 自定义任务 ID
示例值:your-custom-id
Files Array of String 任务输出文件列表
示例值:["thumbnail.jpg"]
FilesInfo Array of CloudStorageAIServiceTaskFileInfo 任务输出文件信息列表

VisionSummaryConfig

视频摘要配置

被如下接口引用:BatchCreateTWeSeeRecognitionTask, BatchInvokeTWeSeeRecognitionTask, CreateTWeSeeRecognitionTask, CreateTWeSeeRecognitionTaskWithFile, DescribeTWeSeeConfig, InvokeTWeSeeRecognitionTask, InvokeTWeSeeRecognitionTaskWithFile, ModifyTWeSeeConfig。

名称 类型 必选 描述
OutputLang String

主输出语言,可选值包括:

  • zh 中文(默认值)
  • en 英语
  • ja 日语
  • ko 韩文
  • pt-BR 葡萄牙语(巴西)
  • th 泰语
  • ms 马来语

示例值:zh
AlternativeOutputLang String

次选输出语言,可选值包括:

  • zh 中文
  • en 英语
  • ja 日语
  • ko 韩文
  • pt-BR 葡萄牙语(巴西)
  • th 泰语
  • ms 马来语

示例值:en
MultiCameraLayout String

多摄像头布局定义。可选值包括:

  • 单摄(默认值):Single

  • 双摄(纵向排列)- 全部画面:Vertical,Num=2,Index=0;1

  • 双摄(纵向排列)- 画面1:Vertical,Num=2,Index=0

  • 双摄(纵向排列)- 画面2:Vertical,Num=2,Index=1

  • 三摄(纵向排列)- 全部画面:Vertical,Num=3,Index=0;1;2

  • 三摄(纵向排列)- 画面1:Vertical,Num=3,Index=0

  • 三摄(纵向排列)- 画面2:Vertical,Num=3,Index=1

  • 三摄(纵向排列)- 画面3:Vertical,Num=3,Index=2

  • 三摄(纵向排列)- 画面1+2:Vertical,Num=3,Index=0;1

  • 三摄(纵向排列)- 画面1+3:Vertical,Num=3,Index=0;2

  • 三摄(纵向排列)- 画面2+3:Vertical,Num=3,Index=1;2


示例值:Single
DetectTypes Array of String

拓展的目标及事件检测类别。可选值包括:

通用事件标签

  • person_enter 有人进入
  • vehicle_entering 车辆进入
  • vehicle_parking 车辆停靠
  • pet 有宠物
  • no_signal 视频画面异常(无信号等)

看家护院

  • person_climbing_fence 有人翻围墙
  • door_window_open 门窗被开启
  • person_carrying_object 有人搬运物品

商铺看管

  • person_at_cashier 有人在收银台
  • person_taking_goods 有人拿商品
  • person_night_moving 夜间有人移动

公共及防火安全

  • person_stealing 有人偷盗
  • crowd 多人聚集
  • smoking 有人吸烟
  • safety_fire 明火
  • safety_smoke 浓烟
  • fireworks 有人燃放烟花爆竹
  • knife 有人持刀
  • gun 有人持枪
  • fight 有人打架
  • hurt 有人受伤流血

养殖看护

  • person_feeding_animal 有人投喂牲畜
  • animal_lying 有动物躺地上
  • animal_wild_intrusion 野生动物入侵

果园农田

  • person_picking_fruit 有人采摘果实
  • person_carrying_bag 有人携带包裹

鱼塘看管

  • fishing 有人钓鱼
  • net_fishing 有人撒网
  • person_carrying_fishing_gear 有人携带渔具
  • loitering_near_water 有人岸边逗留
  • throwing_into_water 有人投掷物品

婴儿看护

  • baby 有婴儿
  • baby_dropping 婴儿跌落床铺
  • person_holding_baby 有人抱起婴儿
  • baby_rolling 婴儿翻滚
  • baby_crying 婴儿哭闹

儿童看护

  • child 有小孩
  • child_falling 小孩摔倒
  • child_entering_kitchen 小孩进入厨房
  • child_climbing_window 小孩攀爬室内窗户
  • child_near_water 小孩靠近水域

老人看护

  • elderly 有老人
  • elderly_falling 老人摔倒
  • elderly_eating 老人用餐
  • elderly_using_stove 老人使用灶具

宠物看护

  • pet_eating 宠物进食
  • pet_damaging 宠物损坏家具
  • pet_barking 宠物吠叫
  • pet_scratching_door 宠物挠门

示例值:["child_falling", "baby_crying"]
CustomDetectQueries Array of VisionCustomDetectQuery

自定义检测标签

DetectContinuous Array of SeeDetectContinuousConfig

标签持续检测配置

SummaryPrompt String

自定义摘要提示词


示例值:用不超过15字的一句话描述这段视频的主要内容。

WXDeviceInfo

微信硬件设备信息

被如下接口引用:GetWechatDeviceTicket。

名称 类型 描述
DeviceId String 设备ID
示例值:p/d
WXIoTDeviceInfo WXIoTDeviceInfo 设备信息

WXIoTDeviceInfo

微信物联网硬件信息

被如下接口引用:GetWechatDeviceTicket。

名称 类型 必选 描述
SN String sn信息
示例值:1234567
SNTicket String 票据
示例值:4rf5gtg
ModelId String 模板ID
示例值:3rfv