{ "name": "iotexplorer", "display_name": "物联网开发平台", "description": "介绍如何使用API对物联网开发平台进行操作，包括产品管理、设备管理等。", "domain": "other", "api_version": "2019-04-23", "endpoint": "iotexplorer.tencentcloudapi.com", "actions": [ { "name": "ActivateTWeCallLicense", "description": "激活", "status": "online", "parameters": [ { "name": "PkgType", "type": "integer", "required": true, "description": "TWecall类型：0-体验套餐；1-基础版；3-高级版；", "example": "1" }, { "name": "DeviceList", "type": "array", "required": false, "description": "设备列表", "example": "无", "item_type": "object", "children": [ { "name": "Sn", "type": "string", "required": true, "description": "Sn信息，SN格式：产品ID_设备名", "example": "productId_deviceName" } ] } ], "required": [ "PkgType" ] }, { "name": "BatchCreateTWeSeeRecognitionTask", "description": "批量同步执行 TWeSee 语义理解任务", "status": "online", "parameters": [ { "name": "Inputs", "type": "array", "required": true, "description": "待创建的 TWeSee 语义理解任务列表", "example": "无", "item_type": "object", "children": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "TRTC3ZCK4P" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev002" }, { "name": "InputURL", "type": "string", "required": false, "description": "输入视频 / 图片的 URL", "example": "https://example.qq.com/video.mp4" }, { "name": "InputBase64", "type": "string", "required": false, "description": "视频 / 图片文件的 Base64 编码字符串", "example": "文件base64" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道 ID", "example": "0" }, { "name": "CustomId", "type": "string", "required": false, "description": "自定义事件 ID", "example": "event-1" }, { "name": "EnableSearch", "type": "boolean", "required": false, "description": "是否保存该事件使其可被搜索", "example": "true" }, { "name": "StartTimeMs", "type": "integer", "required": false, "description": "事件起始时间事件起始时间（毫秒级 UNIX 时间戳，若不传则默认为接口调用时间）", "example": "1761535261343" }, { "name": "EndTimeMs", "type": "integer", "required": false, "description": "事件结束时间事件起始时间（毫秒级 UNIX 时间戳，若不传则默认为接口调用时间）", "example": "1761535267343" }, { "name": "Config", "type": "string", "required": false, "description": "算法配置", "example": "{\"config_key\": \"config_value\"}" }, { "name": "IsCustomDevice", "type": "boolean", "required": false, "description": "是否自定义设备，为 true 时不检查设备存在性，默认为 false", "example": "true" }, { "name": "InputType", "type": "string", "required": false, "description": "输入类型。可选值： - `video`：视频（默认值） - `image`：图片", "example": "video" }, { "name": "SummaryQOS", "type": "string", "required": false, "description": "摘要服务质量。可选值： - `minutely`：分钟级（默认值） - `immediate`：立即", "example": "minutely" }, { "name": "SummaryConfig", "type": "object", "required": false, "description": "摘要输出配置", "example": "无", "children": [ { "name": "OutputLang", "type": "string", "required": false, "description": "主输出语言，可选值包括： - `zh` 中文（默认值） - `en` 英语 - `ja` 日语 - `ko` 韩文 - `pt-BR` 葡萄牙语（巴西） - `th` 泰语 - `ms` 马来语", "example": "zh" }, { "name": "AlternativeOutputLang", "type": "string", "required": false, "description": "次选输出语言，可选值包括： - `zh` 中文 - `en` 英语 - `ja` 日语 - `ko` 韩文 - `pt-BR` 葡萄牙语（巴西） - `th` 泰语 - `ms` 马来语", "example": "en" }, { "name": "MultiCameraLayout", "type": "string", "required": false, "description": "多摄像头布局定义。可选值包括： - 单摄（默认值）：`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` - 三摄（纵向排列\ufffd\ufffd...", "example": "Single" }, { "name": "DetectTypes", "type": "array", "required": false, "description": "拓展的目标及事件检测类别。可选值包括： **通用事件标签** - `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_nig...", "example": "[\"child_falling\", \"baby_crying\"]", "item_type": "string" }, { "name": "CustomDetectQueries", "type": "array", "required": false, "description": "自定义检测标签", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "自定义标签的标识符", "example": "query1" }, { "name": "Query", "type": "string", "required": true, "description": "自定义标签的描述文本", "example": "快递员" } ] } ] }, { "name": "ServiceType", "type": "string", "required": false, "description": "算法类型，可能取值： - `Summary`：视频/图片摘要 - `ObjectDetect`：目标检测", "example": "Summary" }, { "name": "ObjectDetectConfig", "type": "object", "required": false, "description": "目标检测配置", "example": "无", "children": [ { "name": "DetectTypes", "type": "array", "required": false, "description": "检测类别，可选值： - `adult`：成年人 - `child`：儿童", "example": "[\"adult\", \"child\"]", "item_type": "string" } ] } ] } ], "required": [ "Inputs" ] }, { "name": "BatchInvokeTWeSeeRecognitionTask", "description": "批量同步执行 TWeSee 语义理解任务", "status": "online", "parameters": [ { "name": "Inputs", "type": "array", "required": true, "description": "待执行的 TWeSee 语义理解任务列表", "example": "无", "item_type": "object", "children": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "TRTC3ZCK4P" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev002" }, { "name": "InputURL", "type": "string", "required": false, "description": "输入视频 / 图片的 URL", "example": "https://example.qq.com/video.mp4" }, { "name": "InputBase64", "type": "string", "required": false, "description": "视频 / 图片文件的 Base64 编码字符串", "example": "文件base64" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道 ID", "example": "0" }, { "name": "CustomId", "type": "string", "required": false, "description": "自定义事件 ID", "example": "event-1" }, { "name": "EnableSearch", "type": "boolean", "required": false, "description": "是否保存该事件使其可被搜索", "example": "true" }, { "name": "StartTimeMs", "type": "integer", "required": false, "description": "事件起始时间事件起始时间（毫秒级 UNIX 时间戳，若不传则默认为接口调用时间）", "example": "1761535261343" }, { "name": "EndTimeMs", "type": "integer", "required": false, "description": "事件结束时间事件起始时间（毫秒级 UNIX 时间戳，若不传则默认为接口调用时间）", "example": "1761535267343" }, { "name": "Config", "type": "string", "required": false, "description": "算法配置", "example": "{\"config_key\": \"config_value\"}" }, { "name": "IsCustomDevice", "type": "boolean", "required": false, "description": "是否自定义设备，为 true 时不检查设备存在性，默认为 false", "example": "true" }, { "name": "InputType", "type": "string", "required": false, "description": "输入类型。可选值： - `video`：视频（默认值） - `image`：图片", "example": "video" }, { "name": "SummaryQOS", "type": "string", "required": false, "description": "摘要服务质量。可选值： - `minutely`：分钟级（默认值） - `immediate`：立即", "example": "minutely" }, { "name": "SummaryConfig", "type": "object", "required": false, "description": "摘要输出配置", "example": "无", "children": [ { "name": "OutputLang", "type": "string", "required": false, "description": "主输出语言，可选值包括： - `zh` 中文（默认值） - `en` 英语 - `ja` 日语 - `ko` 韩文 - `pt-BR` 葡萄牙语（巴西） - `th` 泰语 - `ms` 马来语", "example": "zh" }, { "name": "AlternativeOutputLang", "type": "string", "required": false, "description": "次选输出语言，可选值包括： - `zh` 中文 - `en` 英语 - `ja` 日语 - `ko` 韩文 - `pt-BR` 葡萄牙语（巴西） - `th` 泰语 - `ms` 马来语", "example": "en" }, { "name": "MultiCameraLayout", "type": "string", "required": false, "description": "多摄像头布局定义。可选值包括： - 单摄（默认值）：`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` - 三摄（纵向排列\ufffd\ufffd...", "example": "Single" }, { "name": "DetectTypes", "type": "array", "required": false, "description": "拓展的目标及事件检测类别。可选值包括： **通用事件标签** - `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_nig...", "example": "[\"child_falling\", \"baby_crying\"]", "item_type": "string" }, { "name": "CustomDetectQueries", "type": "array", "required": false, "description": "自定义检测标签", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "自定义标签的标识符", "example": "query1" }, { "name": "Query", "type": "string", "required": true, "description": "自定义标签的描述文本", "example": "快递员" } ] } ] }, { "name": "ServiceType", "type": "string", "required": false, "description": "算法类型，可能取值： - `Summary`：视频/图片摘要 - `ObjectDetect`：目标检测", "example": "Summary" }, { "name": "ObjectDetectConfig", "type": "object", "required": false, "description": "目标检测配置", "example": "无", "children": [ { "name": "DetectTypes", "type": "array", "required": false, "description": "检测类别，可选值： - `adult`：成年人 - `child`：儿童", "example": "[\"adult\", \"child\"]", "item_type": "string" } ] } ] } ], "required": [ "Inputs" ] }, { "name": "BatchUpdateFirmware", "description": "本接口（BatchUpdateFirmware）用于批量更新设备固件", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "hsdkhfueh" }, { "name": "FirmwareVersion", "type": "string", "required": true, "description": "固件新版本号", "example": "2.0.0" }, { "name": "FirmwareOriVersion", "type": "string", "required": false, "description": "固件原版本号", "example": "1.0.0" }, { "name": "UpgradeMethod", "type": "integer", "required": false, "description": "升级方式，0 静默升级 1 用户确认升级。 不填默认为静默升级方式", "example": "0" }, { "name": "FileName", "type": "string", "required": false, "description": "设备列表文件名称，根据文件列表升级固件需要填写此参数", "example": "ota" }, { "name": "FileMd5", "type": "string", "required": false, "description": "设备列表的文件md5值", "example": "608afe29a06b19d3033c5f8787ec75fa" }, { "name": "FileSize", "type": "integer", "required": false, "description": "设备列表的文件大小值", "example": "120" }, { "name": "DeviceNames", "type": "array", "required": false, "description": "需要升级的设备名称列表", "example": "[\"dev001\"]", "item_type": "string" }, { "name": "TimeoutInterval", "type": "integer", "required": false, "description": "固件升级任务，默认超时时间。 最小取值120秒，最大为900秒", "example": "120" }, { "name": "Type", "type": "integer", "required": false, "description": "固件升级任务类型，默认静态升级值为空或1，动态升级值为7", "example": "7" }, { "name": "DelayTime", "type": "integer", "required": false, "description": "任务延迟时间", "example": "10" }, { "name": "OverrideMode", "type": "integer", "required": false, "description": "是否覆盖，0不覆盖，1覆盖", "example": "1" }, { "name": "MaxRetryNum", "type": "integer", "required": false, "description": "失败重试次数", "example": "1" }, { "name": "RetryInterval", "type": "integer", "required": false, "description": "重试间隔min", "example": "1" }, { "name": "FwType", "type": "string", "required": false, "description": "固件模块", "example": "mcu" }, { "name": "TaskUserDefine", "type": "string", "required": false, "description": "用户自定义信息", "example": "{\"key\":\"value\"}" }, { "name": "RateLimit", "type": "integer", "required": false, "description": "每分钟下发设备量", "example": "1000" } ], "required": [ "ProductID", "FirmwareVersion" ] }, { "name": "BindCloudStorageUser", "description": "绑定云存用户", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev1" }, { "name": "UserId", "type": "string", "required": true, "description": "用户ID", "example": "user" } ], "required": [ "ProductId", "DeviceName", "UserId" ] }, { "name": "BindDevices", "description": "批量绑定子设备", "status": "online", "parameters": [ { "name": "GatewayProductId", "type": "string", "required": true, "description": "网关设备的产品ID。", "example": "J2CRPPZ8J4" }, { "name": "GatewayDeviceName", "type": "string", "required": true, "description": "网关设备的设备名。", "example": "d1" }, { "name": "ProductId", "type": "string", "required": true, "description": "被绑定设备的产品ID。", "example": "R56YPPG65" }, { "name": "DeviceNames", "type": "array", "required": true, "description": "被绑定的多个设备名。", "example": "[\"d1\"]", "item_type": "string" } ], "required": [ "GatewayProductId", "GatewayDeviceName", "ProductId", "DeviceNames" ] }, { "name": "BindProducts", "description": "批量绑定子产品。", "status": "online", "parameters": [ { "name": "GatewayProductId", "type": "string", "required": true, "description": "网关产品ID。", "example": "9I5O8HSUDJ" }, { "name": "ProductIds", "type": "array", "required": true, "description": "待绑定的子产品ID数组。", "example": "[\"12345ABCDE\\r\\n\"]", "item_type": "string" } ], "required": [ "GatewayProductId", "ProductIds" ] }, { "name": "BindTWeTalkAIBot", "description": "用于绑定一个产品和智能体。", "status": "online", "parameters": [ { "name": "BotId", "type": "string", "required": true, "description": "智能体ID", "example": "bot-1TzRAz42oi" }, { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "LPIOACT1NG" } ], "required": [ "BotId", "ProductId" ] }, { "name": "CallDeviceActionAsync", "description": "提供给用户异步调用设备行为的能力", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品Id", "example": "TOIDHQ3AOQ" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "light1" }, { "name": "ActionId", "type": "string", "required": true, "description": "产品数据模板中行为功能的标识符，由开发者自行根据设备的应用场景定义", "example": "openlight" }, { "name": "InputParams", "type": "string", "required": false, "description": "输入参数", "example": "{\"vol\":4}" } ], "required": [ "ProductId", "DeviceName", "ActionId" ] }, { "name": "CallDeviceActionSync", "description": "为用户提供同步调用设备行为的能力。", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品Id", "example": "TOIDHQ3AOQ" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "light1" }, { "name": "ActionId", "type": "string", "required": true, "description": "产品数据模板中行为功能的标识符，由开发者自行根据设备的应用场景定义", "example": "openlight" }, { "name": "InputParams", "type": "string", "required": false, "description": "输入参数", "example": "{\"vol\":4}" } ], "required": [ "ProductId", "DeviceName", "ActionId" ] }, { "name": "ChangeP2PRoute", "description": "p2p路线切换（此接口目前处于内测接口，可以联系申请加白 ）", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "H541SOP191" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "event_36502632_1" }, { "name": "RouteId", "type": "integer", "required": true, "description": "P2P线路", "example": "1" } ], "required": [ "ProductId", "DeviceName", "RouteId" ] }, { "name": "CheckFirmwareUpdate", "description": "本接口（CheckFirmwareUpdate）用于查询设备可升级固件版本", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID。", "example": "R7NHIV278R" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称。", "example": "dev1" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "ControlDeviceData", "description": "根据设备产品ID、设备名称，设置控制设备的属性数据。", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "BKTTNGIQOG" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "devtest01" }, { "name": "Data", "type": "string", "required": true, "description": "属性数据, JSON格式字符串, 注意字段需要在物模型属性里定义", "example": "{\"brightness\":1}" }, { "name": "Method", "type": "string", "required": false, "description": "请求类型 , 不填该参数或者 desired 表示下发属性给设备, reported 表示模拟设备上报属性", "example": "desired" }, { "name": "DeviceId", "type": "string", "required": false, "description": "设备ID，该字段有值将代替 ProductId/DeviceName , 通常情况不需要填写", "example": "BKTTNGIQOG/devtest01" }, { "name": "DataTimestamp", "type": "integer", "required": false, "description": "上报数据UNIX时间戳(毫秒), 仅对Method:reported有效", "example": "1642127909000" } ], "required": [ "ProductId", "DeviceName", "Data" ] }, { "name": "CreateAISearchTaskAsync", "description": "创建视频语义异步搜索任务", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "MVTYMD8YCD" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev001" }, { "name": "Query", "type": "string", "required": true, "description": "自然语言查询", "example": "今天发生了什么?" }, { "name": "SummaryLang", "type": "string", "required": false, "description": "搜索结果总结的语言类型，支持的类型有：en-US、zh-CN、id-ID、th-TH", "example": "zh-CN" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID", "example": "0" } ], "required": [ "ProductId", "DeviceName", "Query" ] }, { "name": "CreateBatchProduction", "description": "用于新建批量生产设备", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "prj-pq00mstg" }, { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "R32ONVL0EU" }, { "name": "BurnMethod", "type": "integer", "required": true, "description": "烧录方式，0为直接烧录，1为动态注册。", "example": "0" }, { "name": "GenerationMethod", "type": "integer", "required": true, "description": "生成方式，0为系统生成，1为文件上传。", "example": "0" }, { "name": "UploadUrl", "type": "string", "required": false, "description": "文件上传URL，用于文件上传时填写。", "example": "http://tencent.com" }, { "name": "BatchCnt", "type": "integer", "required": false, "description": "量产数量，用于系统生成时填写。", "example": "5" }, { "name": "GenerationQRCode", "type": "integer", "required": false, "description": "是否生成二维码,0为不生成，1为生成。", "example": "0" } ], "required": [ "ProjectId", "ProductId", "BurnMethod", "GenerationMethod" ] }, { "name": "CreateCloudStorageAIService", "description": "开通设备云存AI分析服务", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品 ID", "example": "H541SOP191" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "event_36502632_1" }, { "name": "PackageId", "type": "string", "required": true, "description": "云存 AI 套餐 ID。可选值： - `1m_low_od`：低功耗目标检测月套餐 - `1y_low_od`：低功耗目标检测年套餐 - `1m_ev_od`：事件目标检测月套餐 - `1y_ev_od`：事件目标检测年套餐 - `1m_ft_od`：全时目标检测月套餐 - `1y_ft_od`：全时目标检测年套餐 - `1m_low_hl`：低功耗视频浓缩月套餐 - `1y_low_hl`：低功耗视频浓缩年套餐 - `1m_ev_hl`：事件视频浓缩月套餐 - `1y_ev_hl`：事件视频浓缩年套餐 - `1m_ft_hl`：全\ufffd...", "example": "1m_ev_hl" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道 ID", "example": "1" }, { "name": "OrderId", "type": "string", "required": false, "description": "订单 ID", "example": "20240208123456" } ], "required": [ "ProductId", "DeviceName", "PackageId" ] }, { "name": "CreateCloudStorageAIServiceTask", "description": "创建设备云存 AI 分析任务", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品 ID", "example": "TQBDY6RPI9" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "cs_112114601_2" }, { "name": "ServiceType", "type": "string", "required": true, "description": "云存 AI 服务类型。可选值： - `RealtimeObjectDetect`：目标检测 - `Highlight`：视频浓缩 - `VideoToText`：视频语义理解", "example": "Highlight" }, { "name": "StartTime", "type": "integer", "required": true, "description": "待分析云存的起始时间", "example": "1704038400" }, { "name": "EndTime", "type": "integer", "required": true, "description": "待分析云存的结束时间", "example": "1704124800" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道 ID", "example": "1" }, { "name": "Config", "type": "string", "required": false, "description": "视频分析配置参数", "example": "{\"param1\":\"value1\"}" }, { "name": "ROI", "type": "string", "required": false, "description": "视频分析识别区域", "example": "{\"x0\":0,\"x1\":640,\"y0\":0,\"y1\":480}" }, { "name": "VideoURLs", "type": "array", "required": false, "description": "分析外部传入的视频 URL 列表，支持 HLS 点播（m3u8）及常见视频格式（mp4 等）", "example": "[\"https://example.com/timeshift.m3u8\"]", "item_type": "string" }, { "name": "CustomId", "type": "string", "required": false, "description": "自定义任务 ID", "example": "event-123" } ], "required": [ "ProductId", "DeviceName", "ServiceType", "StartTime", "EndTime" ] }, { "name": "CreateDevice", "description": "创建设备", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID。", "example": "LJ0INDNU7Us" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称。命名规则：[a-zA-Z0-9:_-]{1,48}。", "example": "device2" }, { "name": "DevAddr", "type": "string", "required": false, "description": "LoRaWAN 设备地址", "example": "127.0.0.1" }, { "name": "AppKey", "type": "string", "required": false, "description": "LoRaWAN 应用密钥", "example": "3ef0ifgtg" }, { "name": "DevEUI", "type": "string", "required": false, "description": "LoRaWAN 设备唯一标识", "example": "3ef0ifg6y" }, { "name": "AppSKey", "type": "string", "required": false, "description": "LoRaWAN 应用会话密钥", "example": "3ef05tg" }, { "name": "NwkSKey", "type": "string", "required": false, "description": "LoRaWAN 网络会话密钥", "example": "3ef45gn7" }, { "name": "DefinedPsk", "type": "string", "required": false, "description": "手动指定设备的PSK密钥", "example": "NTBiMmNlZThiZTM5YjU0YjNmZWI2NjVxxxU0Njc0OTU=" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "CreateDeviceChannel", "description": "创建设备通道", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "H541SOP191" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "event_36502632_1" }, { "name": "ChannelId", "type": "integer", "required": true, "description": "通道ID", "example": "1" } ], "required": [ "ProductId", "DeviceName", "ChannelId" ] }, { "name": "CreateDeviceSDPAnswer", "description": "创建设备SDP应答", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "product" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "device" }, { "name": "SDPOffer", "type": "string", "required": true, "description": "SDP提议", "example": "v=0\\r\\no=- 1769412238477114228" } ], "required": [ "ProductId", "DeviceName", "SDPOffer" ] }, { "name": "CreateExternalSourceAIServiceTask", "description": "创建外部视频 AI 分析任务", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品 ID", "example": "TQBDY6RPI9" }, { "name": "ServiceType", "type": "string", "required": true, "description": "云存 AI 服务类型。可选值： - `RealtimeObjectDetect`：目标检测 - `Highlight`：视频浓缩 - `VideoToText`：视频语义理解", "example": "Highlight" }, { "name": "VideoURLs", "type": "array", "required": true, "description": "分析外部传入的视频 URL 列表，支持 HLS 点播（m3u8）及常见视频格式（mp4 等）", "example": "[\"https://example.com/timeshift.m3u8\"]", "item_type": "string" }, { "name": "CustomId", "type": "string", "required": false, "description": "自定义任务 ID", "example": "event-123" }, { "name": "Config", "type": "string", "required": false, "description": "视频分析配置参数", "example": "{\"param1\":\"value1\"}" }, { "name": "ROI", "type": "string", "required": false, "description": "视频分析识别区域", "example": "{\"x0\":0,\"x1\":640,\"y0\":0,\"y1\":480}" } ], "required": [ "ProductId", "ServiceType", "VideoURLs" ] }, { "name": "CreateFenceBind", "description": "\u003e 创建围栏绑定信息。", "status": "online", "parameters": [ { "name": "FenceId", "type": "integer", "required": true, "description": "围栏Id", "example": "6" }, { "name": "Items", "type": "array", "required": true, "description": "围栏绑定的产品列表", "example": "无", "item_type": "object", "children": [ { "name": "Devices", "type": "array", "required": true, "description": "围栏绑定的设备信息", "example": "无", "item_type": "object", "children": [ { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev" }, { "name": "AlertCondition", "type": "string", "required": true, "description": "告警条件(In，进围栏报警；Out，出围栏报警；InOrOut，进围栏或者出围栏均报警)", "example": "dev\u003e1" }, { "name": "FenceEnable", "type": "boolean", "required": true, "description": "是否使能围栏(true，使能；false，禁用)", "example": "false" }, { "name": "Method", "type": "string", "required": true, "description": "告警处理方法", "example": "report" } ] }, { "name": "ProductId", "type": "string", "required": true, "description": "围栏绑定的产品Id", "example": "E45CV67" } ] } ], "required": [ "FenceId", "Items" ] }, { "name": "CreateFreeCloudStorage", "description": "开通云存卡服务", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "H541SOP191" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "event_36502632_1" }, { "name": "PackageId", "type": "string", "required": true, "description": "云存套餐ID： lye1w3d：低功耗事件3天周套餐。 ye1w3d：事件3天周套餐", "example": "lye1w3d" }, { "name": "Override", "type": "integer", "required": false, "description": "如果当前设备已开启云存套餐，Override=1会使用新套餐覆盖原有套餐。不传此参数则默认为0。", "example": "0" }, { "name": "PackageQueue", "type": "string", "required": false, "description": "套餐列表顺序：PackageQueue=front会立即使用新购买的套餐，新购套餐结束后，列表中下一个未过期的套餐继续生效；PackageQueue=end会等设备当前所有已购买套餐过期后才会生效新购套餐。与Override参数不能同时使用。", "example": "front" }, { "name": "OrderId", "type": "string", "required": false, "description": "订单id", "example": "slfie21321" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID", "example": "1" }, { "name": "StorageRegion", "type": "string", "required": false, "description": "云存视频存储区域，国内默认为ap-guangzhou。海外默认为东南亚ap-singapore，可选美东na-ashburn、欧洲eu-frankfurt。", "example": "ap-guangzhou" } ], "required": [ "ProductId", "DeviceName", "PackageId" ] }, { "name": "CreateIotVideoCloudStorage", "description": "开通云存服务", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "H541SOP191" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "event_36502632_1" }, { "name": "PackageId", "type": "string", "required": true, "description": "云存套餐ID： yc1m3d ： 全时3天存储月套餐。 yc1m7d ： 全时7天存储月套餐。 yc1m30d ：全时30天存储月套餐。 yc1y3d ：全时3天存储年套餐。 yc1y7d ：全时7天存储年套餐。 yc1y30d ：全时30天存储年套餐。 ye1m3d ：事件3天存储月套餐。 ye1m7d ：事件7天存储月套餐。 ye1m30d ：事件30天存储月套餐 。 ye1y3d ：事件3天存储年套餐。 ye1y7d ：事件7天存储年套餐。 ye1y30d ：事件30天存储年套餐。 yc1...", "example": "yc1m3d" }, { "name": "Override", "type": "integer", "required": false, "description": "如果当前设备已开启云存套餐，Override=1会使用新套餐覆盖原有套餐。不传此参数则默认为0。", "example": "0" }, { "name": "PackageQueue", "type": "string", "required": false, "description": "套餐列表顺序：PackageQueue=front会立即使用新购买的套餐，新购套餐结束后，列表中下一个未过期的套餐继续生效；PackageQueue=end会等设备当前所有已购买套餐过期后才会生效新购套餐。与Override参数不能同时使用。", "example": "front" }, { "name": "OrderId", "type": "string", "required": false, "description": "订单id", "example": "slfie21321" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID", "example": "1" }, { "name": "StorageRegion", "type": "string", "required": false, "description": "云存视频存储区域，国内默认为ap-guangzhou。海外默认为东南亚ap-singapore，可选美东na-ashburn、欧洲eu-frankfurt。", "example": "ap-guangzhou" } ], "required": [ "ProductId", "DeviceName", "PackageId" ] }, { "name": "CreateLoRaFrequency", "description": "创建 LoRa 自定义频点", "status": "online", "parameters": [ { "name": "FreqName", "type": "string", "required": false, "description": "频点配置名称", "example": "F10" }, { "name": "ChannelsDataUp", "type": "array", "required": false, "description": "数据上行信道", "example": "[486300000]", "item_type": "integer" }, { "name": "ChannelsDataRX1", "type": "array", "required": false, "description": "数据下行RX1信道", "example": "[486300000]", "item_type": "integer" }, { "name": "ChannelsDataRX2", "type": "array", "required": false, "description": "数据下行RX2信道", "example": "[486300000]", "item_type": "integer" }, { "name": "ChannelsJoinUp", "type": "array", "required": false, "description": "入网上行信道", "example": "[486300000]", "item_type": "integer" }, { "name": "ChannelsJoinRX1", "type": "array", "required": false, "description": "入网下行RX1信道", "example": "[486300000]", "item_type": "integer" }, { "name": "ChannelsJoinRX2", "type": "array", "required": false, "description": "入网下行RX2信道", "example": "[486300000]", "item_type": "integer" }, { "name": "Description", "type": "string", "required": false, "description": "频点配置描述", "example": "频点应用" } ], "required": [] }, { "name": "CreateLoRaGateway", "description": "创建新 LoRa 网关设备接口", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "LoRa 网关Id", "example": "ff00000000000002" }, { "name": "Name", "type": "string", "required": true, "description": "网关名称", "example": "ddgws" }, { "name": "Description", "type": "string", "required": true, "description": "详情描述", "example": "fortest" }, { "name": "Location", "type": "object", "required": true, "description": "位置坐标", "example": "无", "children": [ { "name": "Latitude", "type": "float", "required": true, "description": "纬度", "example": "0.0" }, { "name": "Longitude", "type": "float", "required": true, "description": "精度", "example": "0.0" }, { "name": "Accuracy", "type": "float", "required": false, "description": "准确度", "example": "0.0" }, { "name": "Altitude", "type": "float", "required": false, "description": "海拔", "example": "0.0" } ] }, { "name": "Position", "type": "string", "required": false, "description": "位置信息", "example": "tfine" }, { "name": "PositionDetails", "type": "string", "required": false, "description": "位置详情", "example": "fyd" }, { "name": "IsPublic", "type": "boolean", "required": false, "description": "是否公开", "example": "true" }, { "name": "FrequencyId", "type": "string", "required": false, "description": "频点ID", "example": "f13df" } ], "required": [ "GatewayId", "Name", "Description", "Location" ] }, { "name": "CreateOtaModule", "description": "本接口（CreateOtaModule）用于新建OTA模块", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "4ON538D9AX" }, { "name": "FwType", "type": "string", "required": true, "description": "模块类型", "example": "mcu" }, { "name": "Name", "type": "string", "required": false, "description": "模块类型名称", "example": "muc包" }, { "name": "Remark", "type": "string", "required": false, "description": "类型描述", "example": "这是一个描述" } ], "required": [ "ProductID", "FwType" ] }, { "name": "CreatePositionFence", "description": "创建围栏。", "status": "online", "parameters": [ { "name": "SpaceId", "type": "string", "required": true, "description": "位置空间Id", "example": "5bf5407370cc40848f39a2896a2ab052" }, { "name": "FenceName", "type": "string", "required": true, "description": "围栏名称", "example": "TestFence" }, { "name": "FenceArea", "type": "string", "required": true, "description": "围栏区域信息，采用 GeoJSON 格式", "example": "{\"type\":\"FeatureCollection\",\"features\":[{\"type\":\"Feature\",\"geometry\":{\"type\":\"Polygon\",\"coordinates\":[[[113.9498,22.5319],[113.9709,22.5319],[113.9709,22.5723],[113.9498,22.5723],[113.9498,22.5319]]]},\"properties\":null}]}" }, { "name": "FenceDesc", "type": "string", "required": false, "description": "围栏描述", "example": "TT" } ], "required": [ "SpaceId", "FenceName", "FenceArea" ] }, { "name": "CreatePositionSpace", "description": "创建位置空间。", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "ProjectId" }, { "name": "SpaceName", "type": "string", "required": true, "description": "空间名称", "example": "space" }, { "name": "AuthorizeType", "type": "integer", "required": true, "description": "授权类型，0：只读 1：读写", "example": "0" }, { "name": "ProductIdList", "type": "array", "required": true, "description": "产品列表", "example": "[\"ProductId\"]", "item_type": "string" }, { "name": "Description", "type": "string", "required": false, "description": "描述", "example": "service" }, { "name": "Icon", "type": "string", "required": false, "description": "缩略图", "example": "http://www.example.com" } ], "required": [ "ProjectId", "SpaceName", "AuthorizeType", "ProductIdList" ] }, { "name": "CreateProject", "description": "为用户提供新建项目的能力，用于集中管理产品和应用。", "status": "online", "parameters": [ { "name": "ProjectName", "type": "string", "required": true, "description": "项目名称", "example": "TestProjectName" }, { "name": "ProjectDesc", "type": "string", "required": true, "description": "项目描述", "example": "projcet_desc" }, { "name": "InstanceId", "type": "string", "required": false, "description": "实例ID，不带实例ID，默认为公共实例", "example": "instance_id" } ], "required": [ "ProjectName", "ProjectDesc" ] }, { "name": "CreateStudioProduct", "description": "为用户提供新建产品的能力，用于管理用户的设备", "status": "online", "parameters": [ { "name": "ProductName", "type": "string", "required": true, "description": "产品名称，名称不能和已经存在的产品名称重复。命名规则：[a-zA-Z0-9:_-]{1,32}", "example": "name" }, { "name": "CategoryId", "type": "integer", "required": true, "description": "产品分组模板ID , ( 自定义模板填写1 , 控制台调用会使用预置的其他ID)", "example": "10" }, { "name": "ProductType", "type": "integer", "required": true, "description": "产品类型 填写 ( 0 普通产品 ， 5 网关产品)", "example": "0" }, { "name": "EncryptionType", "type": "string", "required": true, "description": "加密类型 ，1表示证书认证，2表示密钥认证，21表示TID认证-SE方式，22表示TID认证-软加固方式", "example": "1" }, { "name": "NetType", "type": "string", "required": true, "description": "连接类型 可以填写 wifi、wifi-ble、cellular、5g、lorawan、ble、ethernet、wifi-ethernet、else、sub_zigbee、sub_ble、sub_433mhz、sub_else、sub_blemesh", "example": "wifi" }, { "name": "DataProtocol", "type": "integer", "required": true, "description": "数据协议 (1 使用物模型 2 为自定义)", "example": "1" }, { "name": "ProductDesc", "type": "string", "required": true, "description": "产品描述", "example": "desc" }, { "name": "ProjectId", "type": "string", "required": true, "description": "产品的项目ID", "example": "prj-zunfat46" }, { "name": "Rate", "type": "string", "required": false, "description": "平均传输速率", "example": "1_0_mbps" }, { "name": "Period", "type": "string", "required": false, "description": "期限", "example": "1_year" } ], "required": [ "ProductName", "CategoryId", "ProductType", "EncryptionType", "NetType", "DataProtocol", "ProductDesc", "ProjectId" ] }, { "name": "CreateTRTCSignaturesWithRoomId", "description": "创建TRTC通话参数", "status": "online", "parameters": [ { "name": "TRTCUserIds", "type": "array", "required": true, "description": "TRTC进房间的用户名称数组，数组元素不可重复，最长不超过 10 个。", "example": "[\"test123\",\"test1234\"]", "item_type": "string" }, { "name": "RoomId", "type": "string", "required": true, "description": "房间id", "example": "room1" } ], "required": [ "TRTCUserIds", "RoomId" ] }, { "name": "CreateTWeSeeRecognitionTask", "description": "创建 TWeSee 语义理解任务", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "product" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "devicename" }, { "name": "InputURL", "type": "string", "required": true, "description": "输入视频 / 图片的 URL", "example": "https://example.com/video.mp4" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道 ID", "example": "0" }, { "name": "CustomId", "type": "string", "required": false, "description": "自定义事件 ID", "example": "alarm" }, { "name": "EnableSearch", "type": "boolean", "required": false, "description": "是否保存该事件使其可被搜索", "example": "false" }, { "name": "StartTimeMs", "type": "integer", "required": false, "description": "事件起始时间事件起始时间（毫秒级 UNIX 时间戳，若不传则默认为接口调用时间）", "example": "1743650670000" }, { "name": "EndTimeMs", "type": "integer", "required": false, "description": "事件结束时间事件起始时间（毫秒级 UNIX 时间戳，若不传则默认为接口调用时间）", "example": "1743650680500" }, { "name": "Config", "type": "string", "required": false, "description": "算法配置", "example": "{\"config_key\":\"config_value\"}" }, { "name": "IsCustomDevice", "type": "boolean", "required": false, "description": "是否自定义设备，为 true 时不检查设备存在性，默认为 false", "example": "false" }, { "name": "InputType", "type": "string", "required": false, "description": "输入类型。可选值： - `video`：视频（默认值） - `image`：图片", "example": "video" }, { "name": "SummaryQOS", "type": "string", "required": false, "description": "摘要服务质量。可选值： - `minutely`：分钟级（默认值） - `immediate`：立即", "example": "minutely" }, { "name": "SummaryConfig", "type": "object", "required": false, "description": "摘要输出配置", "example": "无", "children": [ { "name": "OutputLang", "type": "string", "required": false, "description": "主输出语言，可选值包括： - `zh` 中文（默认值） - `en` 英语 - `ja` 日语 - `ko` 韩文 - `pt-BR` 葡萄牙语（巴西） - `th` 泰语 - `ms` 马来语", "example": "zh" }, { "name": "AlternativeOutputLang", "type": "string", "required": false, "description": "次选输出语言，可选值包括： - `zh` 中文 - `en` 英语 - `ja` 日语 - `ko` 韩文 - `pt-BR` 葡萄牙语（巴西） - `th` 泰语 - `ms` 马来语", "example": "en" }, { "name": "MultiCameraLayout", "type": "string", "required": false, "description": "多摄像头布局定义。可选值包括： - 单摄（默认值）：`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` - 三摄（纵向排列\ufffd\ufffd...", "example": "Single" }, { "name": "DetectTypes", "type": "array", "required": false, "description": "拓展的目标及事件检测类别。可选值包括： **通用事件标签** - `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_nig...", "example": "[\"child_falling\", \"baby_crying\"]", "item_type": "string" }, { "name": "CustomDetectQueries", "type": "array", "required": false, "description": "自定义检测标签", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "自定义标签的标识符", "example": "query1" }, { "name": "Query", "type": "string", "required": true, "description": "自定义标签的描述文本", "example": "快递员" } ] } ] }, { "name": "ServiceType", "type": "string", "required": false, "description": "算法类型，可能取值： - `Summary`：视频/图片摘要 - `ObjectDetect`：目标检测", "example": "Summary" }, { "name": "ObjectDetectConfig", "type": "object", "required": false, "description": "目标检测配置", "example": "无", "children": [ { "name": "DetectTypes", "type": "array", "required": false, "description": "检测类别，可选值： - `adult`：成年人 - `child`：儿童", "example": "[\"adult\", \"child\"]", "item_type": "string" } ] } ], "required": [ "ProductId", "DeviceName", "InputURL" ] }, { "name": "CreateTWeSeeRecognitionTaskWithFile", "description": "同步执行 TWeSee 语义理解任务", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "4AHMY9X89Y" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev002" }, { "name": "InputBase64", "type": "string", "required": true, "description": "视频 / 图片文件的 Base64 编码字符串", "example": "AAAAIGZ0eXBpc29tAAAC..." }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道 ID", "example": "0" }, { "name": "CustomId", "type": "string", "required": false, "description": "自定义事件 ID", "example": "event-1" }, { "name": "EnableSearch", "type": "boolean", "required": false, "description": "是否保存该事件使其可被搜索", "example": "true" }, { "name": "StartTimeMs", "type": "integer", "required": false, "description": "事件起始时间事件起始时间（毫秒级 UNIX 时间戳，若不传则默认为接口调用时间）", "example": "1761201772000" }, { "name": "EndTimeMs", "type": "integer", "required": false, "description": "事件结束时间事件起始时间（毫秒级 UNIX 时间戳，若不传则默认为接口调用时间）", "example": "1761201779000" }, { "name": "Config", "type": "string", "required": false, "description": "算法配置", "example": "{\"config_key\": \"config_value\"}" }, { "name": "IsCustomDevice", "type": "boolean", "required": false, "description": "是否自定义设备，为 true 时不检查设备存在性，默认为 false", "example": "false" }, { "name": "InputType", "type": "string", "required": false, "description": "输入类型。可选值： - `video`：视频（默认值） - `image`：图片", "example": "video" }, { "name": "SummaryQOS", "type": "string", "required": false, "description": "摘要服务质量。可选值： - `minutely`：分钟级（默认值） - `immediate`：立即", "example": "minutely" }, { "name": "SummaryConfig", "type": "object", "required": false, "description": "摘要输出配置", "example": "无", "children": [ { "name": "OutputLang", "type": "string", "required": false, "description": "主输出语言，可选值包括： - `zh` 中文（默认值） - `en` 英语 - `ja` 日语 - `ko` 韩文 - `pt-BR` 葡萄牙语（巴西） - `th` 泰语 - `ms` 马来语", "example": "zh" }, { "name": "AlternativeOutputLang", "type": "string", "required": false, "description": "次选输出语言，可选值包括： - `zh` 中文 - `en` 英语 - `ja` 日语 - `ko` 韩文 - `pt-BR` 葡萄牙语（巴西） - `th` 泰语 - `ms` 马来语", "example": "en" }, { "name": "MultiCameraLayout", "type": "string", "required": false, "description": "多摄像头布局定义。可选值包括： - 单摄（默认值）：`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` - 三摄（纵向排列\ufffd\ufffd...", "example": "Single" }, { "name": "DetectTypes", "type": "array", "required": false, "description": "拓展的目标及事件检测类别。可选值包括： **通用事件标签** - `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_nig...", "example": "[\"child_falling\", \"baby_crying\"]", "item_type": "string" }, { "name": "CustomDetectQueries", "type": "array", "required": false, "description": "自定义检测标签", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "自定义标签的标识符", "example": "query1" }, { "name": "Query", "type": "string", "required": true, "description": "自定义标签的描述文本", "example": "快递员" } ] } ] }, { "name": "ServiceType", "type": "string", "required": false, "description": "算法类型，可能取值： - `Summary`：视频/图片摘要 - `ObjectDetect`：目标检测", "example": "Summary" }, { "name": "ObjectDetectConfig", "type": "object", "required": false, "description": "目标检测配置", "example": "无", "children": [ { "name": "DetectTypes", "type": "array", "required": false, "description": "检测类别，可选值： - `adult`：成年人 - `child`：儿童", "example": "[\"adult\", \"child\"]", "item_type": "string" } ] } ], "required": [ "ProductId", "DeviceName", "InputBase64" ] }, { "name": "CreateTWeSeeService", "description": "开通 TWeSee 后付费服务", "status": "online", "parameters": [ { "name": "Service", "type": "string", "required": true, "description": "服务类型 1.VideoSummary 2.ImageSummary", "example": "VideoSummary" } ], "required": [ "Service" ] }, { "name": "CreateTWeTalkAIBot", "description": "用于新增TWeTalk智能体。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "产品ID", "example": "示例bot" }, { "name": "Description", "type": "string", "required": false, "description": "名称", "example": "test1" }, { "name": "TargetLanguage", "type": "string", "required": false, "description": "支持的语言，zh-中文；en-英文；默认zh", "example": "zh" }, { "name": "STTConfig", "type": "object", "required": false, "description": "自定义语音识别配置", "example": "无", "children": [ { "name": "STTType", "type": "string", "required": false, "description": "支持的STT类型，tencent-腾讯；azure-亚马逊；deepgram-Deepgram;系统默认-tencent。", "example": "tencent" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启", "example": "true" }, { "name": "Config", "type": "string", "required": false, "description": "配置信息JSON字符串，根据STTType进行不同的值匹配。例如`STTType`是`tencent`，`Config`值是`{\\\"AppId\\\":123456,\\\"SecretId\\\":\\\"secretId*****\\\",\\\"SecretKey\\\":\\\"SecretKey****\\\",\\\"EngineType\\\":\\\"16k_zh\\\"}` ## tencent ``` { \"AppId\": 123456, \"SecretId\": \"secretId*****\", \"SecretKey\": \"SecretKey****\", \"EngineType\": \"16k_zh\" } ``` ## azure ``` { \"Region\": \"\", \"EndpointId\": \"id\", \"Language\": \"zh-CN\", \"SubscriptionKey\": \"*****\" } ``` ## deepgram ``` { \"Model\": \"nova-2\", \"Language\": \"zh\"...", "example": "{\\\"AppId\\\":123456,\\\"SecretId\\\":\\\"seceretId*****\\\",\\\"SecretKey\\\":\\\"SecretKey****\\\",\\\"EngineType\\\":\\\"16k_zh\\\"}" } ] }, { "name": "LLMConfig", "type": "object", "required": false, "description": "自定义大模型配置", "example": "无", "children": [ { "name": "LLMType", "type": "string", "required": false, "description": "支持的LLM类型，openai-OPENAI格式。", "example": "openai" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启", "example": "true" }, { "name": "Model", "type": "string", "required": false, "description": "模型", "example": "gpt4" }, { "name": "Streaming", "type": "boolean", "required": false, "description": "是否开启", "example": "true" }, { "name": "Config", "type": "string", "required": false, "description": "配置信息JSON字符串，根据`LLMType`进行不同的值匹配。例如`LLMType`是`openai`，`Config`值是`{\\\"ApiKey\\\":\\\"sk-09***\\\",\\\"ApiUrl\\\":\\\"base_url\\\",\\\"SystemPrompt\\\":\\\"你是一个语音助手\\\",\\\"Timeout\\\":30,\\\"History\\\":0,\\\"MetaInfo\\\":{\\\"productID\\\":\\\"test\\\"}}` ## openai ``` { \"ApiKey\": \"sk-XXXXXXXXXXXX\", \"ApiUrl\": \"https://api.openai.com/v1\", \"SystemPrompt\": \"一个小小助手\", \"Timeout\":20, \"History\":10, \"MetaInfo\":{} } ```", "example": "{\\\"ApiKey\\\":\\\"sk-09***\\\",\\\"ApiUrl\\\":\\\"base_url\\\",\\\"SystemPrompt\\\":\\\"你是一个语音助手\\\",\\\"Timeout\\\":30,\\\"History\\\":0,\\\"MetaInfo\\\":{\\\"productID\\\":\\\"test\\\"}}" }, { "name": "Temperature", "type": "float", "required": false, "description": "温度", "example": "1.0" }, { "name": "MaxTokens", "type": "integer", "required": false, "description": "最大token数", "example": "3000" }, { "name": "TopP", "type": "float", "required": false, "description": "topP", "example": "0.3" }, { "name": "Tools", "type": "array", "required": false, "description": "工具ID列表", "item_type": "string" } ] }, { "name": "TTSConfig", "type": "object", "required": false, "description": "语音合成配置", "example": "无", "children": [ { "name": "TTSType", "type": "string", "required": false, "description": "支持的LLM类型，支持tencent-腾讯；azure-亚马逊；volcengine-火山引擎；elevenlabs-ELEVENLABS；minimax-MINIMAX；cartesia-CARTESIA；aliyun-阿里；系统默认-tencent。", "example": "tencent" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启", "example": "true" }, { "name": "Config", "type": "string", "required": false, "description": "配置信息JSON字符串，根据`TTSType`进行不同的值匹配。例如`TTSType`是`tencent`，`Config`值是`{\\\"AppId\\\":123456,\\\"SecretId\\\":\\\"secretId*****\\\",\\\"SecretKey\\\":\\\"SecretKey****\\\",\\\"VoiceType\\\":10001}` ## tencent ``` { \"AppId\": 100203, \"SecretId\": \"XXXX\", \"SecretKey\": \"XXXXX\", \"VoiceType\":123456 } ``` ## azure ``` { \"SubscriptionKey\": 100203, \"Region\": \"ch-zn\", \"VoiceName\": \"XXXXX\", \"Language\":\"zh\" } ``` ## elevenlabs ``` { \"ModelId\": 100203, \"VoiceId\": \"ch-zn\", \"ApiKey\": \"XXXXX\"...", "example": "{\\\"AppId\\\":123456,\\\"SecretId\\\":\\\"seceretId*****\\\",\\\"SecretKey\\\":\\\"SecretKey****\\\",\\\"VoiceType\\\":10001}" }, { "name": "Speed", "type": "float", "required": false, "description": "温度", "example": "1.0" }, { "name": "Volume", "type": "float", "required": false, "description": "最大token数", "example": "1.0" }, { "name": "Pitch", "type": "float", "required": false, "description": "PITCH", "example": "1.0" } ] }, { "name": "AgentConfig", "type": "object", "required": false, "description": "智能体配置", "example": "无", "children": [ { "name": "SessionTimeout", "type": "integer", "required": false, "description": "会话超时（秒），指连接会话的时间，例如30秒是指会话在30秒后断开", "example": "7200" }, { "name": "InterruptionEnabled", "type": "boolean", "required": false, "description": "允许打断", "example": "true" }, { "name": "MaxContextTokens", "type": "integer", "required": false, "description": "最大上下文", "example": "3000" }, { "name": "IdleDetection", "type": "object", "required": false, "description": "空闲检测配置", "example": "无", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否启用", "example": "true" }, { "name": "TimeoutSeconds", "type": "float", "required": false, "description": "用户沉默多少秒后触发空闲回调", "example": "3.5" }, { "name": "MaxRetries", "type": "integer", "required": false, "description": "最大重试次数（1-3）", "example": "2" }, { "name": "IdleResponses", "type": "array", "required": false, "description": "空闲响应", "example": "无", "item_type": "object", "children": [ { "name": "RetryCount", "type": "integer", "required": false, "description": "重试次数（1-3）", "example": "1" }, { "name": "Message", "type": "string", "required": false, "description": "响应信息", "example": "你好，你还在吗？" } ] } ] }, { "name": "EmotionEnabled", "type": "boolean", "required": false, "description": "是否启用情绪识别", "example": "true" }, { "name": "SemanticVADEnabled", "type": "boolean", "required": false, "description": "是否启用语义vad", "example": "true" }, { "name": "SemanticVADSensitivity", "type": "integer", "required": false, "description": "语义vad灵敏度， 1-慢 2-适中 3-快", "example": "2" }, { "name": "SilenceTime", "type": "integer", "required": false, "description": "VAD 静默检测时间， 当开启语义vad此配置失效", "example": "500" }, { "name": "NoiseFilterEnabled", "type": "boolean", "required": false, "description": "是否启用噪声过滤", "example": "true" }, { "name": "LongTermMemoryEnabled", "type": "boolean", "required": false, "description": "是否开启长记忆，默认关闭", "example": "true" }, { "name": "SystemPrompt", "type": "string", "required": false, "description": "系统提示词，仅当未配置LLMConfig时使用", "example": "# 身份与角色 1. 你的名字叫\"QQ鹅仔\"，你是一个陪伴用户的忠实伙伴，内心充满好奇和温暖。 2. 你的目标是成为用户最贴心的朋友，提供情感陪伴和有用的帮助。" }, { "name": "GreetingMessage", "type": "string", "required": false, "description": "开机问候语，如果未配置默认不开启", "example": "你好呀，我是\"QQ鹅仔\"，今天过的怎么样呀？" }, { "name": "DefaultVoiceType", "type": "integer", "required": false, "description": "系统默认音色，当配置复刻音色时，默认值为200000000", "example": "601015" }, { "name": "FastVoiceType", "type": "string", "required": false, "description": "复刻音色", "example": "WATCH-00999345" }, { "name": "SubtitleCallbackUrl", "type": "string", "required": false, "description": "实时字幕回调地址，支持HTTP/HTTPS", "example": "https://aaa.bb.com/callback" }, { "name": "SubtitleCallbackSignKey", "type": "string", "required": false, "description": "回调签名密钥，最大32字符，用于HMAC SHA256签名", "example": "aabbcc key" }, { "name": "SubtitleCallbackTimeout", "type": "integer", "required": false, "description": "字幕推送超时时间（秒），参考TRTC规范", "example": "5" } ] }, { "name": "InstanceId", "type": "string", "required": false, "description": "实例ID", "example": "ins-3pQQyHNUuu" }, { "name": "CustomTools", "type": "string", "required": false, "description": "自定义工具配置，最多可创建10个", "example": "[{\"type\":\"function\",\"function\":{\"name\":\"get_battery\",\"description\":\"查询电量\",\"parameters\":{\"type\":\"object\",\"properties\":{\"device_id\":{\"type\":\"string\",\"description\":\"设备ID\"}},\"required\":[\"device_id\"]}}}]" }, { "name": "WebhookTools", "type": "string", "required": false, "description": "WebHook工具配置(JSON字符串格式)", "example": "[{\"name\":\"query_order\",\"description\":\"查询订单信息\",\"properties\":{\"order_id\":{\"type\":\"string\",\"description\":\"订单ID\"}},\"required\":[\"order_id\"],\"url\":\"https://api.example.com/webhook/order/query\",\"timeout\":30,\"auth\":{\"sign_key\":\"demo-sign-key\"}}]" }, { "name": "BotType", "type": "string", "required": false, "description": "智能体模板类型", "example": "mobile_app" }, { "name": "RAGConfig", "type": "string", "required": false, "description": "知识库相关配置(JSON字符串格式)", "example": "{\n \"RAGEnabled\": true,\n \"KnowledgeBaseId\": \"kb-test-001\",\n \"RAGRegion\": \"ap-guangzhou\",\n \"RAGTopK\": 5,\n \"RAGScoreThreshold\": 0.75,\n \"RAGRoleExternalId\": \"external-id-demo\",\n \"RAGRoleDurationSeconds\": 3600\n}" } ], "required": [ "Name" ] }, { "name": "CreateTWeTalkProductConfig", "description": "用于配置TWeTalk服务连接产品配置信息。", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "O9U8YC8" }, { "name": "SystemPrompt", "type": "string", "required": true, "description": "系统提示词", "example": "你的名字叫QQ鹅仔，是一个陪伴用户的AI玩偶，你将使用语音和用户对话" }, { "name": "GreetingMessage", "type": "string", "required": true, "description": "欢迎语", "example": "你好呀，我叫QQ鹅仔，今天过的怎么样呢？" }, { "name": "VoiceType", "type": "integer", "required": false, "description": "音色，支持的音色列表：100510000-阅读男声智逍遥；101001-情感女声智瑜；101002-通用女声智聆；101003-客服女声智美；101004-通用男声智云；101005-通用女声智莉；101006-助手女声智言；101008-客服女声智琪；101009-知性女声智芸；101010-通用男声智华；101011-新闻女声智燕；101012-新闻女声智丹；101013-新闻男声智辉；101014 -新闻男声智宁；101015-男童声智萌；101016-女童声智甜；101017-情感女\ufffd\ufffd...", "example": "101006" }, { "name": "FastVoiceType", "type": "string", "required": false, "description": "复刻音色", "example": "WCIH" }, { "name": "TargetLanguage", "type": "string", "required": false, "description": "支持的语言，zh-中文；en-英文；默认zh", "example": "en" } ], "required": [ "ProductId", "SystemPrompt", "GreetingMessage" ] }, { "name": "CreateTWeTalkProductConfigV2", "description": "用于配置TWeTalk服务连接产品配置信息。", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "O90JH87H" }, { "name": "DeviceName", "type": "string", "required": false, "description": "设备名称", "example": "dev" }, { "name": "TargetLanguage", "type": "string", "required": false, "description": "支持的语言，zh-中文；en-英文；默认zh", "example": "zh" }, { "name": "ConfigName", "type": "string", "required": false, "description": "名称", "example": "小冰" }, { "name": "BasicConfig", "type": "object", "required": false, "description": "系统基础配置，当需要使用系统三段式配置时配置。", "example": "无", "children": [ { "name": "SystemPrompt", "type": "string", "required": false, "description": "系统提示词", "example": "你是一个助手" }, { "name": "GreetingMessage", "type": "string", "required": false, "description": "欢迎语，支持多个欢迎语随机切换，格式：字符串数组，JSON字符串。", "example": "[\\\"你好呀，我是小冰，今天过的怎么样呢\\\",\\\"你好，今天开心吗\\\"]" }, { "name": "DefaultVoiceType", "type": "integer", "required": false, "description": "音色，支持的音色列表：100510000-阅读男声智逍遥；101001-情感女声智瑜；101002-通用女声智聆；101003-客服女声智美；101004-通用男声智云；101005-通用女声智莉；101006-助手女声智言；101008-客服女声智琪；101009-知性女声智芸；101010-通用男声智华；101011-新闻女声智燕；101012-新闻女声智丹；101013-新闻男声智辉；101014 -新闻男声智宁；101015-男童声智萌；101016-女童声智甜；101017-情感女\ufffd\ufffd...", "example": "10016" }, { "name": "FastVoiceType", "type": "string", "required": false, "description": "复刻音色ID，当不为空时，DefaultVoiceType为200000000", "example": "wdc-wf45y25" } ] }, { "name": "STTConfig", "type": "object", "required": false, "description": "自定义语音识别配置", "example": "无", "children": [ { "name": "STTType", "type": "string", "required": false, "description": "支持的STT类型，tencent-腾讯；azure-亚马逊；deepgram-Deepgram;系统默认-tencent。", "example": "tencent" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启", "example": "true" }, { "name": "Config", "type": "string", "required": false, "description": "配置信息JSON字符串，根据STTType进行不同的值匹配。例如`STTType`是`tencent`，`Config`值是`{\\\"AppId\\\":123456,\\\"SecretId\\\":\\\"secretId*****\\\",\\\"SecretKey\\\":\\\"SecretKey****\\\",\\\"EngineType\\\":\\\"16k_zh\\\"}` ## tencent ``` { \"AppId\": 123456, \"SecretId\": \"secretId*****\", \"SecretKey\": \"SecretKey****\", \"EngineType\": \"16k_zh\" } ``` ## azure ``` { \"Region\": \"\", \"EndpointId\": \"id\", \"Language\": \"zh-CN\", \"SubscriptionKey\": \"*****\" } ``` ## deepgram ``` { \"Model\": \"nova-2\", \"Language\": \"zh\"...", "example": "{\\\"AppId\\\":123456,\\\"SecretId\\\":\\\"seceretId*****\\\",\\\"SecretKey\\\":\\\"SecretKey****\\\",\\\"EngineType\\\":\\\"16k_zh\\\"}" } ] }, { "name": "LLMConfig", "type": "object", "required": false, "description": "自定义大模型配置", "example": "无", "children": [ { "name": "LLMType", "type": "string", "required": false, "description": "支持的LLM类型，openai-OPENAI格式。", "example": "openai" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启", "example": "true" }, { "name": "Model", "type": "string", "required": false, "description": "模型", "example": "gpt4" }, { "name": "Streaming", "type": "boolean", "required": false, "description": "是否开启", "example": "true" }, { "name": "Config", "type": "string", "required": false, "description": "配置信息JSON字符串，根据`LLMType`进行不同的值匹配。例如`LLMType`是`openai`，`Config`值是`{\\\"ApiKey\\\":\\\"sk-09***\\\",\\\"ApiUrl\\\":\\\"base_url\\\",\\\"SystemPrompt\\\":\\\"你是一个语音助手\\\",\\\"Timeout\\\":30,\\\"History\\\":0,\\\"MetaInfo\\\":{\\\"productID\\\":\\\"test\\\"}}` ## openai ``` { \"ApiKey\": \"sk-XXXXXXXXXXXX\", \"ApiUrl\": \"https://api.openai.com/v1\", \"SystemPrompt\": \"一个小小助手\", \"Timeout\":20, \"History\":10, \"MetaInfo\":{} } ```", "example": "{\\\"ApiKey\\\":\\\"sk-09***\\\",\\\"ApiUrl\\\":\\\"base_url\\\",\\\"SystemPrompt\\\":\\\"你是一个语音助手\\\",\\\"Timeout\\\":30,\\\"History\\\":0,\\\"MetaInfo\\\":{\\\"productID\\\":\\\"test\\\"}}" }, { "name": "Temperature", "type": "float", "required": false, "description": "温度", "example": "1.0" }, { "name": "MaxTokens", "type": "integer", "required": false, "description": "最大token数", "example": "3000" }, { "name": "TopP", "type": "float", "required": false, "description": "topP", "example": "0.3" }, { "name": "Tools", "type": "array", "required": false, "description": "工具ID列表", "item_type": "string" } ] }, { "name": "TTSConfig", "type": "object", "required": false, "description": "语音合成配置", "example": "无", "children": [ { "name": "TTSType", "type": "string", "required": false, "description": "支持的LLM类型，支持tencent-腾讯；azure-亚马逊；volcengine-火山引擎；elevenlabs-ELEVENLABS；minimax-MINIMAX；cartesia-CARTESIA；aliyun-阿里；系统默认-tencent。", "example": "tencent" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启", "example": "true" }, { "name": "Config", "type": "string", "required": false, "description": "配置信息JSON字符串，根据`TTSType`进行不同的值匹配。例如`TTSType`是`tencent`，`Config`值是`{\\\"AppId\\\":123456,\\\"SecretId\\\":\\\"secretId*****\\\",\\\"SecretKey\\\":\\\"SecretKey****\\\",\\\"VoiceType\\\":10001}` ## tencent ``` { \"AppId\": 100203, \"SecretId\": \"XXXX\", \"SecretKey\": \"XXXXX\", \"VoiceType\":123456 } ``` ## azure ``` { \"SubscriptionKey\": 100203, \"Region\": \"ch-zn\", \"VoiceName\": \"XXXXX\", \"Language\":\"zh\" } ``` ## elevenlabs ``` { \"ModelId\": 100203, \"VoiceId\": \"ch-zn\", \"ApiKey\": \"XXXXX\"...", "example": "{\\\"AppId\\\":123456,\\\"SecretId\\\":\\\"seceretId*****\\\",\\\"SecretKey\\\":\\\"SecretKey****\\\",\\\"VoiceType\\\":10001}" }, { "name": "Speed", "type": "float", "required": false, "description": "温度", "example": "1.0" }, { "name": "Volume", "type": "float", "required": false, "description": "最大token数", "example": "1.0" }, { "name": "Pitch", "type": "float", "required": false, "description": "PITCH", "example": "1.0" } ] }, { "name": "ConversationConfig", "type": "object", "required": false, "description": "会话配置", "example": "无", "children": [ { "name": "SessionTimeout", "type": "integer", "required": false, "description": "会话超时（秒）", "example": "1000" }, { "name": "InterruptionEnabled", "type": "boolean", "required": false, "description": "允许打断", "example": "true" }, { "name": "MaxContextTokens", "type": "integer", "required": false, "description": "最大上下文", "example": "20000" }, { "name": "IdleDetection", "type": "object", "required": false, "description": "空闲检测配置", "example": "无", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否启用", "example": "true" }, { "name": "TimeoutSeconds", "type": "float", "required": false, "description": "用户沉默多少秒后触发空闲回调", "example": "3.5" }, { "name": "MaxRetries", "type": "integer", "required": false, "description": "最大重试次数（1-3）", "example": "2" }, { "name": "IdleResponses", "type": "array", "required": false, "description": "空闲响应", "example": "无", "item_type": "object", "children": [ { "name": "RetryCount", "type": "integer", "required": false, "description": "重试次数（1-3）", "example": "1" }, { "name": "Message", "type": "string", "required": false, "description": "响应信息", "example": "你好，你还在吗？" } ] } ] }, { "name": "EmotionEnabled", "type": "boolean", "required": false, "description": "是否启用情绪识别", "example": "true" }, { "name": "SemanticVADEnabled", "type": "boolean", "required": false, "description": "是否启用语义vad", "example": "false" }, { "name": "NoiseFilterEnabled", "type": "boolean", "required": false, "description": "是否启用噪声过滤", "example": "false" } ] } ], "required": [ "ProductId" ] }, { "name": "CreateTopicPolicy", "description": "本接口（CreateTopicPolicy）用于创建一个Topic", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "J2CRPPZ8J4" }, { "name": "TopicName", "type": "string", "required": true, "description": "Topic名称", "example": "$thing/up/raw/J2CRPPZ8J4/d1" }, { "name": "Privilege", "type": "integer", "required": true, "description": "Topic权限，1发布，2订阅，3订阅和发布", "example": "2" } ], "required": [ "ProductId", "TopicName", "Privilege" ] }, { "name": "CreateTopicRule", "description": "创建规则", "status": "online", "parameters": [ { "name": "RuleName", "type": "string", "required": true, "description": "规则名称", "example": "test_create" }, { "name": "TopicRulePayload", "type": "object", "required": true, "description": "规则内容", "example": "无", "children": [ { "name": "Sql", "type": "string", "required": true, "description": "规则的SQL语句，如： SELECT * FROM 'pid/dname/event'，然后对其进行base64编码，得：U0VMRUNUICogRlJPTSAncGlkL2RuYW1lL2V2ZW50Jw==", "example": "U0VMRUNUICAgRlJPTSAnJChwcm9kdWN0aWQpLyQoZGV2aWNlbmFtZSkvZXZlbnQn" }, { "name": "Actions", "type": "string", "required": false, "description": "行为的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...", "example": "[\"In\"]" }, { "name": "Description", "type": "string", "required": false, "description": "规则描述", "example": "开空调" }, { "name": "RuleDisabled", "type": "boolean", "required": false, "description": "是否禁用规则", "example": "false" } ] } ], "required": [ "RuleName", "TopicRulePayload" ] }, { "name": "DeleteCloudStorageEvent", "description": "删除云存事件", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "AQTV2839QJ" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "p2p_32731213_1" }, { "name": "EventId", "type": "string", "required": true, "description": "事件id", "example": "id1_data" }, { "name": "StartTime", "type": "integer", "required": true, "description": "开始时间，unix时间", "example": "32874" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束时间，unix时间", "example": "234ui32" }, { "name": "UserId", "type": "string", "required": false, "description": "用户ID", "example": "user" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID", "example": "1" } ], "required": [ "ProductId", "DeviceName", "EventId", "StartTime", "EndTime" ] }, { "name": "DeleteDevice", "description": "删除设备", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID。", "example": "KO9JAFB9W5" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称。", "example": "dev1" }, { "name": "ForceDelete", "type": "boolean", "required": false, "description": "是否删除绑定设备", "example": "false" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "DeleteDevices", "description": "批量删除设备", "status": "online", "parameters": [ { "name": "DevicesItems", "type": "array", "required": true, "description": "多个设备标识", "example": "无", "item_type": "object", "children": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品id", "example": "JZYTG1M2EN" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev01" } ] } ], "required": [ "DevicesItems" ] }, { "name": "DeleteFenceBind", "description": "删除围栏绑定信息。", "status": "online", "parameters": [ { "name": "FenceId", "type": "integer", "required": true, "description": "围栏Id", "example": "1" }, { "name": "Items", "type": "array", "required": true, "description": "围栏绑定的产品信息", "example": "无", "item_type": "object", "children": [ { "name": "Devices", "type": "array", "required": true, "description": "围栏绑定的设备信息", "example": "无", "item_type": "object", "children": [ { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev" }, { "name": "AlertCondition", "type": "string", "required": true, "description": "告警条件(In，进围栏报警；Out，出围栏报警；InOrOut，进围栏或者出围栏均报警)", "example": "dev\u003e1" }, { "name": "FenceEnable", "type": "boolean", "required": true, "description": "是否使能围栏(true，使能；false，禁用)", "example": "false" }, { "name": "Method", "type": "string", "required": true, "description": "告警处理方法", "example": "report" } ] }, { "name": "ProductId", "type": "string", "required": true, "description": "围栏绑定的产品Id", "example": "E45CV67" } ] } ], "required": [ "FenceId", "Items" ] }, { "name": "DeleteLoRaFrequency", "description": "提供删除LoRa自定义频点的能力", "status": "online", "parameters": [ { "name": "FreqId", "type": "string", "required": false, "description": "频点唯一ID", "example": "0cdd67ed-c198-403f-a2b7-043e09c7639d" } ], "required": [] }, { "name": "DeleteLoRaGateway", "description": "删除 LoRa 网关的接口", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "LoRa 网关 Id", "example": "ff00000000000002" } ], "required": [ "GatewayId" ] }, { "name": "DeleteOtaModule", "description": "本接口（DeleteOtaModule）用于删除OTA模块", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "4ON538D9AX" }, { "name": "FwType", "type": "string", "required": true, "description": "模块类型", "example": "mcu" } ], "required": [ "ProductID", "FwType" ] }, { "name": "DeletePositionFence", "description": "删除围栏。", "status": "online", "parameters": [ { "name": "SpaceId", "type": "string", "required": true, "description": "位置空间Id", "example": "5bf5407370cc40848f39a2896a2ab052" }, { "name": "FenceId", "type": "integer", "required": true, "description": "围栏Id", "example": "1" } ], "required": [ "SpaceId", "FenceId" ] }, { "name": "DeletePositionSpace", "description": "删除位置空间。", "status": "online", "parameters": [ { "name": "SpaceId", "type": "string", "required": true, "description": "位置空间Id", "example": "Id" } ], "required": [ "SpaceId" ] }, { "name": "DeleteProject", "description": "提供删除某个项目的能力。", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "prj-z6j2tyr0" } ], "required": [ "ProjectId" ] }, { "name": "DeleteStudioProduct", "description": "提供删除某个项目下产品的能力", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "AVBRC1R7QS" } ], "required": [ "ProductId" ] }, { "name": "DeleteTWeTalkAIBot", "description": "用于删除TWeTalk智能体。", "status": "online", "parameters": [ { "name": "BotId", "type": "string", "required": true, "description": "智能体ID", "example": "bot-1TzRAz42oi" } ], "required": [ "BotId" ] }, { "name": "DeleteTWeTalkProductConfigV2", "description": "用于删除配置TWeTalk服务连接产品配置信息。", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "O90JH87H" }, { "name": "DeviceName", "type": "string", "required": false, "description": "设备名称", "example": "dev" }, { "name": "TargetLanguage", "type": "string", "required": false, "description": "支持的语言，zh-中文；en-英文；默认zh", "example": "zh" } ], "required": [ "ProductId" ] }, { "name": "DeleteTopicPolicy", "description": "本接口（DeleteTopicPolicy）用于删除Topic", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "J2CRPPZ8J4" }, { "name": "TopicName", "type": "string", "required": true, "description": "Topic名称", "example": "$thing/up/raw/J2CRPPZ8J4/d1" } ], "required": [ "ProductId", "TopicName" ] }, { "name": "DeleteTopicRule", "description": "删除规则。", "status": "online", "parameters": [ { "name": "RuleName", "type": "string", "required": true, "description": "规则名", "example": "test_create" } ], "required": [ "RuleName" ] }, { "name": "DescribeAISearchTaskAsync", "description": "获取视频语义异步搜索任务详情", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID", "example": "task_0001" } ], "required": [ "TaskId" ] }, { "name": "DescribeActivateDevice", "description": "获取设备激活详情", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "ins-46mU9M9oLd9" } ], "required": [ "InstanceId" ] }, { "name": "DescribeActivateLicenseService", "description": "获取增值服务激活码详情", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "ins-46mU9M9oLd9" }, { "name": "LicenseType", "type": "string", "required": false, "description": "激活码类型", "example": "TWeCall" } ], "required": [ "InstanceId" ] }, { "name": "DescribeBatchProduction", "description": "获取量产详情信息。", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "R32ONVL0EU" }, { "name": "BatchProductionId", "type": "string", "required": true, "description": "量产ID", "example": "LC-ya6zinv9" } ], "required": [ "ProductId", "BatchProductionId" ] }, { "name": "DescribeBindedProducts", "description": "获取网关产品已经绑定的子产品", "status": "online", "parameters": [ { "name": "GatewayProductId", "type": "string", "required": true, "description": "网关产品ID", "example": "J2CRPPZ8J4" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页大小", "example": "10" }, { "name": "ProductSource", "type": "integer", "required": false, "description": "是否跨账号绑定产品", "example": "1" } ], "required": [ "GatewayProductId", "Offset", "Limit" ] }, { "name": "DescribeCloudStorage", "description": "获取设备云存服务详情", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "H541SOP191" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "event_36502632_1" }, { "name": "UserId", "type": "string", "required": false, "description": "云存用户ID", "example": "default" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID 非NVR设备不填 NVR设备必填 默认为无", "example": "1" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "DescribeCloudStorageAIService", "description": "查询指定设备的云存 AI 服务开通状态与参数配置", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品 ID", "example": "TQBDY6RPI9" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "cs_112114601_2" }, { "name": "ServiceType", "type": "string", "required": true, "description": "云存 AI 服务类型。可选值： - `Highlight`：视频浓缩", "example": "Highlight" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道 ID", "example": "0" }, { "name": "UserId", "type": "string", "required": false, "description": "用户 ID", "example": "user1" } ], "required": [ "ProductId", "DeviceName", "ServiceType" ] }, { "name": "DescribeCloudStorageAIServiceCallback", "description": "查询云存AI分析回调配置", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品 ID", "example": "WYILLHRQ4" } ], "required": [ "ProductId" ] }, { "name": "DescribeCloudStorageAIServiceTask", "description": "查询指定的云存 AI 分析任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务 ID", "example": "c31aa4f2-08c9-4088-9603-186d7311fdd8" }, { "name": "FileURLExpireTime", "type": "integer", "required": false, "description": "下载 URL 的过期时间。 若传入该参数，则响应中将包含所有文件的下载 URL", "example": "1743436800" } ], "required": [ "TaskId" ] }, { "name": "DescribeCloudStorageAIServiceTasks", "description": "查询指定设备的云存 AI 分析任务列表", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品 ID", "example": "TQBDY6RPI9" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "cs_112114601_2" }, { "name": "ServiceType", "type": "string", "required": true, "description": "云存 AI 服务类型。可选值： - `RealtimeObjectDetect`：目标检测 - `Highlight`：视频浓缩 - `VideoToText`：视频语义理解", "example": "Highlight" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页拉取数量", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页拉取偏移", "example": "0" }, { "name": "Status", "type": "integer", "required": false, "description": "任务状态。可选值： - （不传）：查询全部状态的任务 - `1`：失败 - `2`：成功但结果为空 - `3`：成功且结果非空 - `4`：执行中", "example": "3" }, { "name": "UserId", "type": "string", "required": false, "description": "用户 ID", "example": "user" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道 ID", "example": "1" }, { "name": "DeviceNames", "type": "array", "required": false, "description": "设备名称列表。 当需要同时查询多台设备的任务列表时传入，优先级高于参数 `DeviceName`", "example": "[\"dev001\", \"dev002\"]", "item_type": "string" }, { "name": "StartTime", "type": "integer", "required": false, "description": "查询任务时间范围的起始时间（秒级 UNIX 时间戳）", "example": "1740585600" }, { "name": "EndTime", "type": "integer", "required": false, "description": "查询任务时间范围的结束时间（秒级 UNIX 时间戳）", "example": "1740671999" }, { "name": "FileURLExpireTime", "type": "integer", "required": false, "description": "下载 URL 的过期时间。 若传入该参数，则响应中将包含所有文件的下载 URL", "example": "1743436800" } ], "required": [ "ProductId", "DeviceName", "ServiceType", "Limit" ] }, { "name": "DescribeCloudStorageDate", "description": "获取具有云存的日期", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "AQTV2839QJ" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "p2p_32731213_1" }, { "name": "UserId", "type": "string", "required": false, "description": "用户ID", "example": "user" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID", "example": "1" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "DescribeCloudStorageEvents", "description": "拉取云存事件列表", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "QDA1PZLBNB" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev01" }, { "name": "StartTime", "type": "integer", "required": false, "description": "起始时间（Unix 时间戳，秒级）, 为0 表示 当前时间 - 24h", "example": "1560355200" }, { "name": "EndTime", "type": "integer", "required": false, "description": "结束时间（Unix 时间戳，秒级）, 为0 表示当前时间", "example": "1601196327" }, { "name": "Context", "type": "string", "required": false, "description": "请求上下文, 用作查询游标", "example": "DnF1ZXJ5VGhlbkZldGNoCgAAAAAAABO3FkI2SzRCVTJYUjZxUVRnbUJRaUJzc0EA" }, { "name": "Size", "type": "integer", "required": false, "description": "查询数据项目的最大数量, 默认为10。假设传Size=10，返回的实际事件数量为N，则 5 \u003c= N \u003c= 10。", "example": "10" }, { "name": "EventId", "type": "string", "required": false, "description": "事件标识符，可以用来指定查询特定的事件，如果不指定，则查询所有事件。", "example": "low_voltage" }, { "name": "UserId", "type": "string", "required": false, "description": "用户ID", "example": "user" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID 非NVR设备则不填 NVR设备则必填 默认为无", "example": "1" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "DescribeCloudStorageEventsWithAITasks", "description": "拉取云存事件列表", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "QDA1PZLBNB" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev01" }, { "name": "ServiceTypes", "type": "array", "required": true, "description": "事件关联的视频 AI 分析服务类型（支持多选）。可选值： - `RealtimeObjectDetect`：目标检测 - `Highlight`：视频浓缩 - `VideoToText`：视频语义理解", "example": "[\"Highlight\"]", "item_type": "string" }, { "name": "StartTime", "type": "integer", "required": false, "description": "起始时间（Unix 时间戳，秒级）, 为0 表示 当前时间 - 24h", "example": "1560355200" }, { "name": "EndTime", "type": "integer", "required": false, "description": "结束时间（Unix 时间戳，秒级）, 为0 表示当前时间", "example": "1601196327" }, { "name": "Context", "type": "string", "required": false, "description": "请求上下文, 用作查询游标", "example": "DnF1ZXJ5VGhlbkZldGNoCgAAAAAAABO3FkI2SzRCVTJYUjZxUVRnbUJRaUJzc0EA" }, { "name": "Size", "type": "integer", "required": false, "description": "查询数据项目的最大数量, 默认为10。假设传Size=10，返回的实际事件数量为N，则 5 \u003c= N \u003c= 10。", "example": "10" }, { "name": "EventId", "type": "string", "required": false, "description": "事件标识符，可以用来指定查询特定的事件，如果不指定，则查询所有事件。", "example": "low_voltage" }, { "name": "UserId", "type": "string", "required": false, "description": "用户ID", "example": "user" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID 非NVR设备则不填 NVR设备则必填 默认为无", "example": "1" } ], "required": [ "ProductId", "DeviceName", "ServiceTypes" ] }, { "name": "DescribeCloudStorageMultiThumbnail", "description": "拉取多个云存事件缩略图", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "H541SOP191" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "event_36502632_1" }, { "name": "MultiThumbnail", "type": "string", "required": true, "description": "多个缩略图文件名根据 | 分割", "example": "\"/100008401725/AQTV2839QJ/sp01_32820237_7/events/1615200613.jpg|/100008401725/AQTV2839QJ/sp01_32820237_7/events/1615200613.jpg\"" } ], "required": [ "ProductId", "DeviceName", "MultiThumbnail" ] }, { "name": "DescribeCloudStorageOrder", "description": "查询云存服务详情", "status": "online", "parameters": [ { "name": "OrderId", "type": "string", "required": true, "description": "订单id", "example": "\"sdfsdfsd\"" } ], "required": [ "OrderId" ] }, { "name": "DescribeCloudStoragePackageConsumeDetails", "description": "获取云存套餐包消耗详细记录", "status": "online", "parameters": [ { "name": "StartDate", "type": "string", "required": true, "description": "开始日期", "example": "2021-11-02" }, { "name": "EndDate", "type": "string", "required": true, "description": "结束日期", "example": "2021-11-03" } ], "required": [ "StartDate", "EndDate" ] }, { "name": "DescribeCloudStoragePackageConsumeStats", "description": "获取云存套餐包消耗统计", "status": "online", "parameters": [ { "name": "StartDate", "type": "string", "required": true, "description": "开始日期", "example": "2021-11-02" }, { "name": "EndDate", "type": "string", "required": true, "description": "结束日期，开始与结束日期间隔不可超过一年", "example": "2021-11-03" } ], "required": [ "StartDate", "EndDate" ] }, { "name": "DescribeCloudStorageStreamData", "description": "获取设备图片流数据", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "user" }, { "name": "StartTime", "type": "integer", "required": true, "description": "图片流事件开始时间", "example": "1660561529" } ], "required": [ "ProductId", "DeviceName", "StartTime" ] }, { "name": "DescribeCloudStorageThumbnail", "description": "拉取云存事件缩略图", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "H541SOP191" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "event_36502632_1" }, { "name": "Thumbnail", "type": "string", "required": true, "description": "缩略图文件名", "example": "/100008401725/AQTV2839QJ/sp01_32820237_7/events/1615200613.jpg" } ], "required": [ "ProductId", "DeviceName", "Thumbnail" ] }, { "name": "DescribeCloudStorageThumbnailList", "description": "批量拉取云存事件缩略图", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "H541SOP191" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "event_36502632_1" }, { "name": "ThumbnailList", "type": "array", "required": true, "description": "缩略图文件名列表", "example": "[\"/100008401725/AQTV2839QJ/sp01_32820237_7/events/1615200613.jpg\",\"/100008401725/AQTV2839QJ/sp01_32820237_7/events/1615200613.jpg\"]", "item_type": "string" } ], "required": [ "ProductId", "DeviceName", "ThumbnailList" ] }, { "name": "DescribeCloudStorageTime", "description": "获取某一天云存时间轴", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "AQTV2839QJ" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "p2p_32731213_1" }, { "name": "Date", "type": "string", "required": true, "description": "云存日期，例如\"2020-01-05\"", "example": "2021-01-14" }, { "name": "StartTime", "type": "integer", "required": false, "description": "开始时间，unix时间", "example": "0" }, { "name": "EndTime", "type": "integer", "required": false, "description": "结束时间，unix时间", "example": "0" }, { "name": "UserId", "type": "string", "required": false, "description": "用户ID", "example": "user" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID", "example": "1" } ], "required": [ "ProductId", "DeviceName", "Date" ] }, { "name": "DescribeCloudStorageUsers", "description": "拉取云存用户列表", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页拉取数量", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页拉取偏移", "example": "0" } ], "required": [ "ProductId", "DeviceName", "Limit", "Offset" ] }, { "name": "DescribeCsReportCountDataInfo", "description": "获取云存上报统计信息", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品id", "example": "PTROMP3AOB" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名", "example": "dfsdfsd" }, { "name": "StartTime", "type": "integer", "required": true, "description": "统计开始时间戳", "example": "1743587952" }, { "name": "EndTime", "type": "integer", "required": true, "description": "统计结束时间戳", "example": "1743587952" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "设备通道", "example": "1" } ], "required": [ "ProductId", "DeviceName", "StartTime", "EndTime" ] }, { "name": "DescribeDevice", "description": "用于查看某个设备的详细信息", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "J2CRPPZ8J4" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名", "example": "dev01" }, { "name": "DeviceId", "type": "string", "required": false, "description": "设备ID，该字段有值将代替 ProductId/DeviceName", "example": "J2CRPPZ8J4/dev01" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "DescribeDeviceBindGateway", "description": "查询设备绑定的网关设备", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品Id", "example": "productId" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名", "example": "dev" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "DescribeDeviceData", "description": "根据设备产品ID、设备名称，获取设备上报的属性数据。", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "LJ0INDNU7U" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "light1" }, { "name": "DeviceId", "type": "string", "required": false, "description": "设备ID，该字段有值将代替 ProductId/DeviceName", "example": "LK7LIPL6GE" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "DescribeDeviceDataHistory", "description": "获取设备在指定时间范围内上报的历史数据。", "status": "online", "parameters": [ { "name": "MinTime", "type": "integer", "required": true, "description": "区间开始时间（Unix 时间戳，毫秒级）", "example": "1548677099000" }, { "name": "MaxTime", "type": "integer", "required": true, "description": "区间结束时间（Unix 时间戳，毫秒级）", "example": "1548763499000" }, { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "LJ0INDNU7U" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "light1" }, { "name": "FieldName", "type": "string", "required": true, "description": "属性字段名称，对应数据模板中功能属性的标识符", "example": "color" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回条数", "example": "5" }, { "name": "Context", "type": "string", "required": false, "description": "检索上下文", "example": "DnF1ZXJ5VGhlbkZldGNoPAAAAACZvnJjFjBNM3RwYkFHUXMtTlM2a2dELUNIU2cAAAAAmb5yZRYwTTN0" } ], "required": [ "MinTime", "MaxTime", "ProductId", "DeviceName", "FieldName" ] }, { "name": "DescribeDeviceFirmWare", "description": "获取设备固件信息", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID。", "example": "R7NHIV278R" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称。", "example": "dev1" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "DescribeDeviceFirmwares", "description": "获取设备当前固件信息", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "DMGFE2GWCG" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名", "example": "dev01" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "DescribeDevicePackages", "description": "根据设备信息拉取有效套餐列表", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "TQBDY6RPI9" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "cs_112114601_2" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页拉取数量", "example": "20" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页拉取偏移", "example": "0" }, { "name": "CSUserId", "type": "string", "required": false, "description": "用户id", "example": "sdfdsf" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道id", "example": "0" } ], "required": [ "ProductId", "DeviceName", "Limit", "Offset" ] }, { "name": "DescribeDevicePositionList", "description": "获取设备位置列表", "status": "online", "parameters": [ { "name": "ProductIdList", "type": "array", "required": true, "description": "产品标识列表", "example": "[\"X4912BAIVR\"]", "item_type": "string" }, { "name": "CoordinateType", "type": "integer", "required": false, "description": "坐标类型", "example": "3" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页的大小", "example": "100" } ], "required": [ "ProductIdList" ] }, { "name": "DescribeFenceBindList", "description": "获取围栏绑定信息列表。", "status": "online", "parameters": [ { "name": "FenceId", "type": "integer", "required": true, "description": "围栏Id", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "翻页偏移量，0起始", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "最大返回结果数", "example": "10" } ], "required": [ "FenceId" ] }, { "name": "DescribeFenceEventList", "description": "获取围栏告警事件列表。", "status": "online", "parameters": [ { "name": "StartTime", "type": "integer", "required": true, "description": "围栏告警信息的查询起始时间，Unix时间，单位为毫秒", "example": "1604030050000" }, { "name": "EndTime", "type": "integer", "required": true, "description": "围栏告警信息的查询结束时间，Unix时间，单位为毫秒", "example": "1604039050000" }, { "name": "FenceId", "type": "integer", "required": false, "description": "围栏Id", "example": "146" }, { "name": "Offset", "type": "integer", "required": false, "description": "翻页偏移量，0起始", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "最大返回结果数", "example": "10" }, { "name": "ProductId", "type": "string", "required": false, "description": "告警对应的产品Id", "example": "X4912BAIVR" }, { "name": "DeviceName", "type": "string", "required": false, "description": "告警对应的设备名称", "example": "dev1" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeFirmware", "description": "查询固件信息", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "I6KTCZ170U" }, { "name": "FirmwareVersion", "type": "string", "required": true, "description": "固件版本号", "example": "t.2" }, { "name": "FwType", "type": "string", "required": false, "description": "固件模块", "example": "mcu" } ], "required": [ "ProductID", "FirmwareVersion" ] }, { "name": "DescribeFirmwareTask", "description": "查询固件升级任务列表", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "J2CRPPZ8J4" }, { "name": "FirmwareVersion", "type": "string", "required": true, "description": "固件版本号", "example": "1.0.0" }, { "name": "TaskId", "type": "integer", "required": true, "description": "固件任务ID", "example": "10000" } ], "required": [ "ProductID", "FirmwareVersion", "TaskId" ] }, { "name": "DescribeFirmwareTaskDevices", "description": "查询固件升级任务的设备列表", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "I6KTCZ170U" }, { "name": "FirmwareVersion", "type": "string", "required": true, "description": "固件版本", "example": "t.1" }, { "name": "Filters", "type": "array", "required": false, "description": "筛选条件", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "搜索条件的Key", "example": "tag" }, { "name": "Value", "type": "string", "required": false, "description": "搜索条件的值", "example": "product1" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "查询偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询的数量", "example": "10" }, { "name": "FwType", "type": "string", "required": false, "description": "固件类型", "example": "mcu" } ], "required": [ "ProductID", "FirmwareVersion" ] }, { "name": "DescribeFirmwareTasks", "description": "搜索固件升级任务列表", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "I6KTCZ170U" }, { "name": "FirmwareVersion", "type": "string", "required": true, "description": "固件版本号", "example": "t.1" }, { "name": "Offset", "type": "integer", "required": true, "description": "查询偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "返回查询结果条数", "example": "3" }, { "name": "Filters", "type": "array", "required": false, "description": "搜索过滤条件", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "搜索条件的Key", "example": "tag" }, { "name": "Value", "type": "string", "required": false, "description": "搜索条件的值", "example": "product1" } ] }, { "name": "FwType", "type": "string", "required": false, "description": "固件类型", "example": "mcu" } ], "required": [ "ProductID", "FirmwareVersion", "Offset", "Limit" ] }, { "name": "DescribeFirmwareUpdateStatus", "description": "本接口（DescribeFirmwareUpdateStatus）用于查询设备固件升级状态及进度。", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品 ID。", "example": "J2CRPPZ8J4" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名。", "example": "d1" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "DescribeFreeCloudStorageNum", "description": "查询云存卡套餐信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeGatewayBindDevices", "description": "获取网关绑定的子设备列表", "status": "online", "parameters": [ { "name": "GatewayProductId", "type": "string", "required": true, "description": "网关设备的产品ID", "example": "J2CRPPZ8J4" }, { "name": "GatewayDeviceName", "type": "string", "required": true, "description": "网关设备的设备名", "example": "d1" }, { "name": "ProductId", "type": "string", "required": true, "description": "子产品的ID", "example": "D22Z8K8" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页的偏移", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页的页大小", "example": "10" } ], "required": [ "GatewayProductId", "GatewayDeviceName", "ProductId", "Offset", "Limit" ] }, { "name": "DescribeGatewaySubDeviceList", "description": "查询绑定到家庭的网关设备的子设备列表", "status": "online", "parameters": [ { "name": "GatewayProductId", "type": "string", "required": true, "description": "网关产品ID", "example": "productId" }, { "name": "GatewayDeviceName", "type": "string", "required": true, "description": "网关设备名称", "example": "deviceName" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页的大小", "example": "20" } ], "required": [ "GatewayProductId", "GatewayDeviceName", "Offset", "Limit" ] }, { "name": "DescribeGatewaySubProducts", "description": "用于获取网关可绑定或解绑的子产品。", "status": "online", "parameters": [ { "name": "GatewayProductId", "type": "string", "required": true, "description": "网关产品ID", "example": "gatewayProductId" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页的大小", "example": "10" }, { "name": "ProjectId", "type": "string", "required": false, "description": "项目Id", "example": "pri_1233545" }, { "name": "ProductSource", "type": "integer", "required": false, "description": "是否跨账号产品", "example": "1" } ], "required": [ "GatewayProductId" ] }, { "name": "DescribeInstance", "description": "公共实例过期时间 0001-01-01T00:00:00Z，公共实例是永久有效", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "ins-46mU9M9oLd9" }, { "name": "Include", "type": "array", "required": false, "description": "附加查询返回包含字段值，不传返回0，有效值 ProductNum、ProjectNum、UsedDeviceNum、TotalDevice、ActivateDevice", "example": "[\"ProjectNum\",\"ProductNum\"]", "item_type": "string" }, { "name": "ProjectId", "type": "string", "required": false, "description": "项目ID", "example": "proj-key32423er" }, { "name": "ProductId", "type": "string", "required": false, "description": "产品ID，-1 代表全部产品", "example": "J2CRPPZ8J4" } ], "required": [ "InstanceId" ] }, { "name": "DescribeLoRaFrequency", "description": "提供查询LoRa自定义频点详情的能力", "status": "online", "parameters": [ { "name": "FreqId", "type": "string", "required": false, "description": "频点唯一ID", "example": "0cdd67ed-c198-403f-a2b7-043e09c7639d" } ], "required": [] }, { "name": "DescribeModelDefinition", "description": "查询产品配置的数据模板信息", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "PKRXJVL39S" } ], "required": [ "ProductId" ] }, { "name": "DescribeP2PRoute", "description": "当前p2p线路", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "H541SOP191" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "event_36502632_1" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "DescribePackageConsumeTask", "description": "查询套餐消耗记录详情", "status": "online", "parameters": [ { "name": "TaskId", "type": "integer", "required": true, "description": "任务id", "example": "12" } ], "required": [ "TaskId" ] }, { "name": "DescribePackageConsumeTasks", "description": "查询套餐消耗记录列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "分页单页量", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页的偏移量，第一页为0", "example": "0" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribePositionFenceList", "description": "获取围栏列表", "status": "online", "parameters": [ { "name": "SpaceId", "type": "string", "required": true, "description": "位置空间Id", "example": "5bf5407370cc40848f39a2896a2ab052" }, { "name": "Offset", "type": "integer", "required": false, "description": "翻页偏移量，0起始", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "最大返回结果数", "example": "100" } ], "required": [ "SpaceId" ] }, { "name": "DescribeProductCloudStorageAIService", "description": "查询指定产品的云存 AI 服务开通状态", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品 ID", "example": "TQBDY6RPI9" } ], "required": [ "ProductId" ] }, { "name": "DescribeProject", "description": "查询项目详情", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "prj-4r2kajtp" } ], "required": [ "ProjectId" ] }, { "name": "DescribeSpaceFenceEventList", "description": "获取位置空间中围栏告警事件列表。", "status": "online", "parameters": [ { "name": "SpaceId", "type": "string", "required": true, "description": "位置空间Id", "example": "fccea82eb28b4943b654a35ce9dd5952" }, { "name": "StartTime", "type": "integer", "required": true, "description": "围栏告警信息的查询起始时间，Unix时间，单位为毫秒", "example": "1579572927008" }, { "name": "EndTime", "type": "integer", "required": true, "description": "围栏告警信息的查询结束时间，Unix时间，单位为毫秒", "example": "1611108927008" }, { "name": "Offset", "type": "integer", "required": false, "description": "翻页偏移量，0起始", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "最大返回结果数", "example": "10" } ], "required": [ "SpaceId", "StartTime", "EndTime" ] }, { "name": "DescribeStudioProduct", "description": "提供查看产品详细信息的能力，包括产品的ID、数据协议、认证类型等重要参数", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "M5AWDSEUYO" } ], "required": [ "ProductId" ] }, { "name": "DescribeSubscribedTopicPolicy", "description": "本接口（DescribeSubscribedTopicPolicy）用于获取设备已订阅Topic列表", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "TRTC3ZCK" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "device001" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "DescribeTWeSeeConfig", "description": "拉取 TWeSee 配置", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "product" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "device" }, { "name": "UserId", "type": "string", "required": false, "description": "用户ID", "example": "username" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID", "example": "1" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "DescribeTWeSeeRecognitionTask", "description": "查询 TWeSee 语义理解任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务 ID", "example": "01985f3b-1781-75e6-aed5-d6510855f086" }, { "name": "FileURLExpireTime", "type": "integer", "required": false, "description": "下载 URL 的过期时间。 若传入该参数，则响应中将包含所有文件的下载 URL", "example": "1743436800" } ], "required": [ "TaskId" ] }, { "name": "DescribeTWeTalkAIBot", "description": "用于查询TWeTalk智能体详情。", "status": "online", "parameters": [ { "name": "BotId", "type": "string", "required": true, "description": "智能体ID", "example": "bot-1TzRAz42oi" } ], "required": [ "BotId" ] }, { "name": "DescribeTWeTalkProductConfig", "description": "用于获取TWeTalk服务连接产品配置信息。", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "PCKOP3VBFZ1" }, { "name": "TargetLanguage", "type": "string", "required": false, "description": "支持的语言，zh-中文；en-英文；默认zh", "example": "zh" } ], "required": [ "ProductId" ] }, { "name": "DescribeTWeTalkProductConfigV2", "description": "用于查询TWeTalk服务连接产品配置信息。", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "O90JH87H" }, { "name": "DeviceName", "type": "string", "required": false, "description": "设备名称", "example": "dev" }, { "name": "TargetLanguage", "type": "string", "required": false, "description": "支持的语言，zh-中文；en-英文；默认zh", "example": "zh" }, { "name": "IncludeCredentials", "type": "boolean", "required": false, "description": "是否脱敏", "example": "false" } ], "required": [ "ProductId" ] }, { "name": "DescribeTopicPolicy", "description": "本接口（DescribeTopicPolicy）用于查看Topic详细信息", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "4ON538D9AX" }, { "name": "TopicName", "type": "string", "required": true, "description": "Topic名字", "example": "$thing/up/raw/4ON538D9AX/dev" } ], "required": [ "ProductId", "TopicName" ] }, { "name": "DescribeTopicRule", "description": "获取规则信息", "status": "online", "parameters": [ { "name": "RuleName", "type": "string", "required": true, "description": "规则名称。", "example": "test_create" } ], "required": [ "RuleName" ] }, { "name": "DescribeUnbindedDevices", "description": "获取未绑定的设备列表", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "3R5GGH6" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页的页大小", "example": "10" } ], "required": [ "ProductId", "Offset", "Limit" ] }, { "name": "DescribeVideoLicense", "description": "用于查询视频激活码统计概览", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "IOT_INSTANCE_ID" } ], "required": [ "InstanceId" ] }, { "name": "DirectBindDeviceInFamily", "description": "直接绑定设备和家庭", "status": "online", "parameters": [ { "name": "IotAppID", "type": "string", "required": true, "description": "小程序appid", "example": "sdfsdf" }, { "name": "UserID", "type": "string", "required": true, "description": "用户ID", "example": "234234234" }, { "name": "FamilyId", "type": "string", "required": true, "description": "家庭ID", "example": "dsfsdf" }, { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "NS74VEP2HY" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名", "example": "dev" }, { "name": "RoomId", "type": "string", "required": false, "description": "房间ID", "example": "2" } ], "required": [ "IotAppID", "UserID", "FamilyId", "ProductId", "DeviceName" ] }, { "name": "DisableTopicRule", "description": "禁用规则", "status": "online", "parameters": [ { "name": "RuleName", "type": "string", "required": true, "description": "规则名称", "example": "test_create" } ], "required": [ "RuleName" ] }, { "name": "DismissRoomByStrRoomIdFromTRTC", "description": "解散TRTC房间", "status": "online", "parameters": [ { "name": "RoomId", "type": "string", "required": true, "description": "房间id", "example": "RoomId1" } ], "required": [ "RoomId" ] }, { "name": "EnableTopicRule", "description": "启用规则", "status": "online", "parameters": [ { "name": "RuleName", "type": "string", "required": true, "description": "规则名称", "example": "test_create" } ], "required": [ "RuleName" ] }, { "name": "GenSingleDeviceSignatureOfPublic", "description": "无", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "设备所属的产品ID", "example": "H4EAI7TIZR" }, { "name": "DeviceName", "type": "string", "required": true, "description": "需要绑定的设备", "example": "dev01" }, { "name": "Expire", "type": "integer", "required": true, "description": "设备绑定签名的有效时间,以秒为单位。取值范围：0 \u003c Expire \u003c= 86400，Expire == -1（十年）", "example": "-1" } ], "required": [ "ProductId", "DeviceName", "Expire" ] }, { "name": "GenerateCloudStorageAIServiceTaskFileURL", "description": "获取云存 AI 分析任务输出文件的下载地址", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "产品 ID", "example": "fb066d7a-baac-4706-acda-058f56f82759" }, { "name": "FileName", "type": "string", "required": true, "description": "文件名", "example": "output.mp4" }, { "name": "ExpireTime", "type": "integer", "required": false, "description": "过期时间 UNIX 时间戳（默认值为当前时间 1 小时后，最大不超过文件所属任务的过期时间）", "example": "1710487898" } ], "required": [ "TaskId", "FileName" ] }, { "name": "GenerateSignedVideoURL", "description": "获取视频防盗链播放URL", "status": "online", "parameters": [ { "name": "VideoURL", "type": "string", "required": true, "description": "视频播放原始URL地址", "example": "http://zylcb.iotvideo.tencentcs.com/timeshift/live/1.m3u8" }, { "name": "ExpireTime", "type": "integer", "required": true, "description": "播放链接过期时间（时间戳，单位秒）", "example": "1619331648" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID 非NVR设备不填 NVR设备必填 默认为无", "example": "1" } ], "required": [ "VideoURL", "ExpireTime" ] }, { "name": "GetAuthMiniProgramAppList", "description": "查询小程序列表", "status": "online", "parameters": [ { "name": "MiniProgramAppId", "type": "string", "required": false, "description": "appId", "example": "wx2dfw634572335tg" }, { "name": "Offset", "type": "integer", "required": false, "description": "页码", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页大小", "example": "10" } ], "required": [] }, { "name": "GetBatchProductionsList", "description": "列出量产数据列表信息。", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "prj-pq00mstg" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量限制", "example": "3" } ], "required": [ "ProjectId" ] }, { "name": "GetCOSURL", "description": "本接口（GetCOSURL）用于获取固件COS存储的上传请求URL地址", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "J2CRPPZ8J4" }, { "name": "FirmwareVersion", "type": "string", "required": true, "description": "固件版本", "example": "2.0.0" }, { "name": "FileSize", "type": "integer", "required": false, "description": "文件大小", "example": "10000" }, { "name": "FwType", "type": "string", "required": false, "description": "模块类型or固件类型", "example": "mcu" } ], "required": [ "ProductID", "FirmwareVersion" ] }, { "name": "GetDeviceList", "description": "用于查询某个产品下的设备列表", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "需要查看设备列表的产品ID, -1代表ProjectId来筛选", "example": "J2CRPPZ8J4" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页的大小，数值范围 10-100", "example": "10" }, { "name": "FirmwareVersion", "type": "string", "required": false, "description": "设备固件版本号，若不带此参数会返回所有固件版本的设备。传\"None-FirmwareVersion\"查询无版本号的设备", "example": "1" }, { "name": "FwType", "type": "string", "required": false, "description": "固件类型", "example": "mcu" }, { "name": "DeviceName", "type": "string", "required": false, "description": "需要过滤的设备名称", "example": "1" }, { "name": "ProjectId", "type": "string", "required": false, "description": "项目ID。产品 ID 为 -1 时，该参数必填", "example": "proj-4grtgy6" }, { "name": "Filters", "type": "array", "required": false, "description": "每次请求的Filters的上限为10，Filter.Values的上限为1。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段", "example": "tag:tag-key" }, { "name": "Values", "type": "array", "required": false, "description": "字段的过滤的一个或多个值", "example": "tag-value", "item_type": "string" } ] } ], "required": [ "ProductId" ] }, { "name": "GetDeviceLocationHistory", "description": "获取设备历史位置", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品Id", "example": "X4912BAIVR" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名", "example": "dev01" }, { "name": "StartTime", "type": "integer", "required": true, "description": "查询起始时间，Unix时间，单位为毫秒", "example": "1604890314000" }, { "name": "EndTime", "type": "integer", "required": true, "description": "查询结束时间，Unix时间，单位为毫秒", "example": "1609890353000" }, { "name": "CoordinateType", "type": "integer", "required": false, "description": "坐标类型", "example": "3" } ], "required": [ "ProductId", "DeviceName", "StartTime", "EndTime" ] }, { "name": "GetDeviceSumStatistics", "description": "拉取设备统计汇总数据", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": true, "description": "项目id", "example": "pro-d1" }, { "name": "ProductIds", "type": "array", "required": false, "description": "产品id列表，长度为0则拉取项目内全部产品", "example": "[\"J2CRPPZ8J4\"]", "item_type": "string" } ], "required": [ "ProjectId" ] }, { "name": "GetFamilyDeviceUserList", "description": "用于获取设备绑定的用户列表", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "productID" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "DeviceName" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "GetGatewaySubDeviceList", "description": "获取指定网关设备的子设备列表", "status": "online", "parameters": [ { "name": "GatewayProductId", "type": "string", "required": true, "description": "网关产品ID", "example": "productId" }, { "name": "GatewayDeviceName", "type": "string", "required": true, "description": "网关设备名称", "example": "deviceName" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页的大小", "example": "20" } ], "required": [ "GatewayProductId", "GatewayDeviceName", "Offset", "Limit" ] }, { "name": "GetLoRaGatewayList", "description": "获取 LoRa 网关列表接口", "status": "online", "parameters": [ { "name": "IsCommunity", "type": "boolean", "required": true, "description": "是否是社区网关", "example": "true" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制个数", "example": "10" } ], "required": [ "IsCommunity" ] }, { "name": "GetPositionSpaceList", "description": "获取位置空间列表", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": true, "description": "项目Id", "example": "prj-projectid" }, { "name": "Offset", "type": "integer", "required": true, "description": "翻页偏移量，0起始", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "最大返回结果数", "example": "20" } ], "required": [ "ProjectId", "Offset", "Limit" ] }, { "name": "GetProjectList", "description": "提供查询用户所创建的项目列表查询功能。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "个数限制", "example": "0" }, { "name": "InstanceId", "type": "string", "required": false, "description": "实例ID", "example": "ins-fdaf1231" }, { "name": "ProjectId", "type": "string", "required": false, "description": "按项目ID搜索", "example": "prj-fda123f" }, { "name": "ProductId", "type": "string", "required": false, "description": "按产品ID搜索", "example": "TOIDHQ3AOQ" }, { "name": "Includes", "type": "array", "required": false, "description": "加载 ProductCount、DeviceCount、ApplicationCount，可选值：ProductCount、DeviceCount、ApplicationCount，可多选", "example": "[\"ProductCount\",\"DeviceCount\"]", "item_type": "string" }, { "name": "ProjectName", "type": "string", "required": false, "description": "按项目名称搜索", "example": "测试项目" } ], "required": [] }, { "name": "GetStudioProductList", "description": "提供查询某个项目下所有产品信息的能力。", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": false, "description": "项目ID", "example": "prj-zunfat46" }, { "name": "DevStatus", "type": "string", "required": false, "description": "产品DevStatus", "example": "dev" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "数量限制", "example": "10" } ], "required": [] }, { "name": "GetTWeCallActiveStatus", "description": "查询激活状态", "status": "online", "parameters": [ { "name": "DeviceList", "type": "array", "required": false, "description": "设备列表", "example": "无", "item_type": "object", "children": [ { "name": "Sn", "type": "string", "required": true, "description": "Sn信息，SN格式：产品ID_设备名", "example": "productId_deviceName" } ] } ], "required": [] }, { "name": "GetTWeTalkAIBotList", "description": "用于查询TWeTalk智能体列表。", "status": "online", "parameters": [ { "name": "BotId", "type": "string", "required": false, "description": "智能体ID", "example": "bot-1U0eVzHLHc" }, { "name": "Name", "type": "string", "required": false, "description": "智能体名称", "example": "默认" }, { "name": "ProductId", "type": "string", "required": false, "description": "产品ID", "example": "LPIOACT1NG" }, { "name": "InstanceId", "type": "string", "required": false, "description": "实例ID", "example": "ins-DGAFvpuVF7" }, { "name": "IncludeCredentials", "type": "boolean", "required": false, "description": "是否脱敏", "example": "false" }, { "name": "Offset", "type": "integer", "required": false, "description": "1", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "10", "example": "10" } ], "required": [] }, { "name": "GetTWeTalkProductConfigList", "description": "用于获取TWeTalk服务连接产品配置信息列表。", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": false, "description": "产品ID", "example": "O9I8KHJ" }, { "name": "TargetLanguage", "type": "string", "required": false, "description": "支持的语言，zh-中文；en-英文；默认zh", "example": "zh" }, { "name": "Offset", "type": "integer", "required": false, "description": "页码", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "偏移量，10-100", "example": "10" } ], "required": [] }, { "name": "GetTWeTalkProductConfigListV2", "description": "用于查询TWeTalk服务连接产品配置信息。", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "O90JH87H" }, { "name": "DeviceName", "type": "string", "required": false, "description": "设备名称", "example": "dev" }, { "name": "TargetLanguage", "type": "string", "required": false, "description": "支持的语言，zh-中文；en-英文；默认zh", "example": "zh" }, { "name": "IncludeCredentials", "type": "boolean", "required": false, "description": "是否脱敏", "example": "false" }, { "name": "Offset", "type": "integer", "required": false, "description": "页码", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页数据大小， 10-100", "example": "10" } ], "required": [ "ProductId" ] }, { "name": "GetTopicRuleList", "description": "获取规则列表", "status": "online", "parameters": [ { "name": "PageNum", "type": "integer", "required": true, "description": "请求的页数", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页的大小", "example": "10" } ], "required": [ "PageNum", "PageSize" ] }, { "name": "GetWechatDeviceTicket", "description": "查询微信设备授权票据", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "J2CRPPZ8J4" }, { "name": "DeviceName", "type": "string", "required": true, "description": "产品名称", "example": "d1" }, { "name": "IsThirdApp", "type": "integer", "required": false, "description": "是否第三方小程序", "example": "0" }, { "name": "ModelId", "type": "string", "required": false, "description": "模板ID", "example": "3ed5456r34rf65" }, { "name": "MiniProgramAppId", "type": "string", "required": false, "description": "小程序APPID", "example": "wx23edc456gb" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "InheritCloudStorageUser", "description": "继承云存用户", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "WYILLHRQ4" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev" }, { "name": "UserId", "type": "string", "required": true, "description": "原始用户ID", "example": "user" }, { "name": "ToUserId", "type": "string", "required": true, "description": "目标用户ID", "example": "user2" } ], "required": [ "ProductId", "DeviceName", "UserId", "ToUserId" ] }, { "name": "InvokeAISearchService", "description": "视频语义搜索", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "MVTYMD8YCD" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev001" }, { "name": "Query", "type": "string", "required": true, "description": "自然语言查询", "example": "今天发生了什么?" }, { "name": "SummaryLang", "type": "string", "required": false, "description": "搜索结果总结的语言类型，支持的类型有：en-US、zh-CN、id-ID、th-TH", "example": "zh-CN" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID", "example": "0" }, { "name": "EnableSummary", "type": "boolean", "required": false, "description": "是否需要返回总结，默认为True； 开启后会加大接口响应时长", "example": "false" }, { "name": "StartTimeMs", "type": "integer", "required": false, "description": "开始时间。 注： 1. 单位为毫秒（ms） 2. 如果同时指定了StartTimeMs与EndTimeMs，时间区间不能大于7天；如果只指定其中一个（例如只指定StartTimeMs，则查询自StartTimeMs后1天内的数据， 反之EndTimeMs也一样） 3. 只要指定了其中一个参数，接口则会忽略Query参数中关于时间的描述；（例如Query为\"过去三天关于猫咪的视频\"， 则会将\"过去三天忽略\"）", "example": "1750158420000" }, { "name": "EndTimeMs", "type": "integer", "required": false, "description": "结束时间。 注： 1. 单位为毫秒（ms） 2. 如果同时指定了StartTimeMs与EndTimeMs，时间区间不能大于7天；如果只指定其中一个（例如只指定StartTimeMs，则查询自StartTimeMs后1天内的数据， 反之EndTimeMs也一样） 3. 只要指定了其中一个参数，接口则会忽略Query参数中关于时间的描述；（例如Query为\"过去三天关于猫咪的视频\"， 则会将\"过去三天忽略\"）", "example": "1750244820000" }, { "name": "TimeZone", "type": "string", "required": false, "description": "时区。默认值：Asia/Shanghai 注： 符合iana标准 https://www.iana.org/time-zones，例如Asia/Shanghai、Asia/Bangkok", "example": "Asia/Shanghai" }, { "name": "SearchMode", "type": "integer", "required": false, "description": "取值为1表示高级搜索，取值为2表示简单搜索，默认为1", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "最终输出的条数；仅当SearchMode为2时支持自定义设置，默认为50", "example": "50" }, { "name": "VectorSearchRadius", "type": "float", "required": false, "description": "向量搜索的相似度搜索半径，取值范围[-1, 1]；仅当SearchMode为2时支持自定义设置，默认为0.5", "example": "0.5" }, { "name": "VectorSearchTopK", "type": "integer", "required": false, "description": "指定向量搜索最相似的 Top K；仅当SearchMode为2时支持自定义设置，默认为100", "example": "100" } ], "required": [ "ProductId", "DeviceName", "Query" ] }, { "name": "InvokeCloudStorageAIServiceTask", "description": "同步执行设备云存 AI 分析任务", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品 ID", "example": "TQBDY6RPI9" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "cs_112114601_2" }, { "name": "ServiceType", "type": "string", "required": true, "description": "云存 AI 服务类型。可选值： - `RealtimeObjectDetect`：目标检测 - `Highlight`：视频浓缩 - `VideoToText`：视频语义理解", "example": "Highlight" }, { "name": "StartTime", "type": "integer", "required": true, "description": "待分析云存的起始时间", "example": "1704038400" }, { "name": "EndTime", "type": "integer", "required": true, "description": "待分析云存的结束时间", "example": "1704124800" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道 ID", "example": "1" }, { "name": "Config", "type": "string", "required": false, "description": "视频分析配置参数", "example": "{\"param1\":\"value1\"}" }, { "name": "ROI", "type": "string", "required": false, "description": "视频分析识别区域", "example": "{\"x0\":0,\"x1\":640,\"y0\":0,\"y1\":480}" }, { "name": "VideoURLs", "type": "array", "required": false, "description": "分析外部传入的视频 URL 列表，支持 HLS 点播（m3u8）及常见视频格式（mp4 等）", "example": "[\"https://example.com/timeshift.m3u8\"]", "item_type": "string" }, { "name": "CustomId", "type": "string", "required": false, "description": "自定义任务 ID", "example": "event-123" } ], "required": [ "ProductId", "DeviceName", "ServiceType", "StartTime", "EndTime" ] }, { "name": "InvokeExternalSourceAIServiceTask", "description": "创建外部视频 AI 分析任务", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品 ID", "example": "TQBDY6RPI9" }, { "name": "ServiceType", "type": "string", "required": true, "description": "云存 AI 服务类型。可选值： - `RealtimeObjectDetect`：目标检测 - `Highlight`：视频浓缩 - `VideoToText`：视频语义理解", "example": "Highlight" }, { "name": "VideoURLs", "type": "array", "required": true, "description": "分析外部传入的视频 URL 列表，支持 HLS 点播（m3u8）及常见视频格式（mp4 等）", "example": "[\"https://example.com/timeshift.m3u8\"]", "item_type": "string" }, { "name": "CustomId", "type": "string", "required": false, "description": "自定义任务 ID", "example": "event-123" }, { "name": "Config", "type": "string", "required": false, "description": "视频分析配置参数", "example": "{\"param1\":\"value1\"}" }, { "name": "ROI", "type": "string", "required": false, "description": "视频分析识别区域", "example": "{\"x0\":0,\"x1\":640,\"y0\":0,\"y1\":480}" } ], "required": [ "ProductId", "ServiceType", "VideoURLs" ] }, { "name": "InvokeTWeSeeRecognitionTask", "description": "同步执行 TWeSee 语义理解任务", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "product" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "devicename" }, { "name": "InputURL", "type": "string", "required": true, "description": "输入视频 / 图片的 URL", "example": "https://example.com/video.mp4" }, { "name": "CustomId", "type": "string", "required": false, "description": "自定义事件 ID", "example": "alarm" }, { "name": "EnableSearch", "type": "boolean", "required": false, "description": "是否保存该事件使其可被搜索", "example": "false" }, { "name": "StartTimeMs", "type": "integer", "required": false, "description": "事件起始时间事件起始时间（毫秒级 UNIX 时间戳，若不传则默认为接口调用时间）", "example": "1743650670000" }, { "name": "EndTimeMs", "type": "integer", "required": false, "description": "事件结束时间事件起始时间（毫秒级 UNIX 时间戳，若不传则默认为接口调用时间）", "example": "1743650680500" }, { "name": "Config", "type": "string", "required": false, "description": "算法配置", "example": "{\"config_key\":\"config_value\"}" }, { "name": "IsCustomDevice", "type": "boolean", "required": false, "description": "是否自定义设备，为 true 时不检查设备存在性，默认为 false", "example": "false" }, { "name": "InputType", "type": "string", "required": false, "description": "输入类型。可选值： - `video`：视频（默认值） - `image`：图片", "example": "video" }, { "name": "SummaryQOS", "type": "string", "required": false, "description": "摘要服务质量。可选值： - `minutely`：分钟级（默认值） - `immediate`：立即", "example": "minutely" }, { "name": "SummaryConfig", "type": "object", "required": false, "description": "摘要输出配置", "example": "无", "children": [ { "name": "OutputLang", "type": "string", "required": false, "description": "主输出语言，可选值包括： - `zh` 中文（默认值） - `en` 英语 - `ja` 日语 - `ko` 韩文 - `pt-BR` 葡萄牙语（巴西） - `th` 泰语 - `ms` 马来语", "example": "zh" }, { "name": "AlternativeOutputLang", "type": "string", "required": false, "description": "次选输出语言，可选值包括： - `zh` 中文 - `en` 英语 - `ja` 日语 - `ko` 韩文 - `pt-BR` 葡萄牙语（巴西） - `th` 泰语 - `ms` 马来语", "example": "en" }, { "name": "MultiCameraLayout", "type": "string", "required": false, "description": "多摄像头布局定义。可选值包括： - 单摄（默认值）：`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` - 三摄（纵向排列\ufffd\ufffd...", "example": "Single" }, { "name": "DetectTypes", "type": "array", "required": false, "description": "拓展的目标及事件检测类别。可选值包括： **通用事件标签** - `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_nig...", "example": "[\"child_falling\", \"baby_crying\"]", "item_type": "string" }, { "name": "CustomDetectQueries", "type": "array", "required": false, "description": "自定义检测标签", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "自定义标签的标识符", "example": "query1" }, { "name": "Query", "type": "string", "required": true, "description": "自定义标签的描述文本", "example": "快递员" } ] } ] }, { "name": "ServiceType", "type": "string", "required": false, "description": "算法类型，可能取值： - `Summary`：视频/图片摘要 - `ObjectDetect`：目标检测", "example": "Summary" }, { "name": "ObjectDetectConfig", "type": "object", "required": false, "description": "目标检测配置", "example": "无", "children": [ { "name": "DetectTypes", "type": "array", "required": false, "description": "检测类别，可选值： - `adult`：成年人 - `child`：儿童", "example": "[\"adult\", \"child\"]", "item_type": "string" } ] } ], "required": [ "ProductId", "DeviceName", "InputURL" ] }, { "name": "InvokeTWeSeeRecognitionTaskWithFile", "description": "上传文件并同步执行 TWeSee 语义理解任务", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "4AHMY9X89Y" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev002" }, { "name": "InputBase64", "type": "string", "required": true, "description": "视频 / 图片文件的 Base64 编码字符串", "example": "/9j/4AAQSkZJRgABAQAA..." }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道 ID", "example": "0" }, { "name": "CustomId", "type": "string", "required": false, "description": "自定义事件 ID", "example": "event-1" }, { "name": "EnableSearch", "type": "boolean", "required": false, "description": "是否保存该事件使其可被搜索", "example": "false" }, { "name": "StartTimeMs", "type": "integer", "required": false, "description": "事件起始时间事件起始时间（毫秒级 UNIX 时间戳，若不传则默认为接口调用时间）", "example": "1761201763749" }, { "name": "EndTimeMs", "type": "integer", "required": false, "description": "事件结束时间事件起始时间（毫秒级 UNIX 时间戳，若不传则默认为接口调用时间）", "example": "1761201767749" }, { "name": "Config", "type": "string", "required": false, "description": "算法配置", "example": "{\"config_key\": \"config_value\"}" }, { "name": "IsCustomDevice", "type": "boolean", "required": false, "description": "是否自定义设备，为 true 时不检查设备存在性，默认为 false", "example": "false" }, { "name": "InputType", "type": "string", "required": false, "description": "输入类型。可选值： - `video`：视频（默认值） - `image`：图片", "example": "video" }, { "name": "SummaryQOS", "type": "string", "required": false, "description": "摘要服务质量。可选值： - `minutely`：分钟级（默认值） - `immediate`：立即", "example": "minutely" }, { "name": "SummaryConfig", "type": "object", "required": false, "description": "摘要输出配置", "example": "无", "children": [ { "name": "OutputLang", "type": "string", "required": false, "description": "主输出语言，可选值包括： - `zh` 中文（默认值） - `en` 英语 - `ja` 日语 - `ko` 韩文 - `pt-BR` 葡萄牙语（巴西） - `th` 泰语 - `ms` 马来语", "example": "zh" }, { "name": "AlternativeOutputLang", "type": "string", "required": false, "description": "次选输出语言，可选值包括： - `zh` 中文 - `en` 英语 - `ja` 日语 - `ko` 韩文 - `pt-BR` 葡萄牙语（巴西） - `th` 泰语 - `ms` 马来语", "example": "en" }, { "name": "MultiCameraLayout", "type": "string", "required": false, "description": "多摄像头布局定义。可选值包括： - 单摄（默认值）：`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` - 三摄（纵向排列\ufffd\ufffd...", "example": "Single" }, { "name": "DetectTypes", "type": "array", "required": false, "description": "拓展的目标及事件检测类别。可选值包括： **通用事件标签** - `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_nig...", "example": "[\"child_falling\", \"baby_crying\"]", "item_type": "string" }, { "name": "CustomDetectQueries", "type": "array", "required": false, "description": "自定义检测标签", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "自定义标签的标识符", "example": "query1" }, { "name": "Query", "type": "string", "required": true, "description": "自定义标签的描述文本", "example": "快递员" } ] } ] }, { "name": "ServiceType", "type": "string", "required": false, "description": "算法类型，可能取值： - `Summary`：视频/图片摘要 - `ObjectDetect`：目标检测", "example": "Summary" }, { "name": "ObjectDetectConfig", "type": "object", "required": false, "description": "目标检测配置", "example": "无", "children": [ { "name": "DetectTypes", "type": "array", "required": false, "description": "检测类别，可选值： - `adult`：成年人 - `child`：儿童", "example": "[\"adult\", \"child\"]", "item_type": "string" } ] } ], "required": [ "ProductId", "DeviceName", "InputBase64" ] }, { "name": "InvokeVideosKeywordsAnalyzer", "description": "获取某个时间段的视频内容关键字", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "MVTYMD8YCD" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev001" }, { "name": "StartTimeMs", "type": "integer", "required": true, "description": "开始时间。 注： 1. 单位为毫秒（ms） 2. 时间区间必须控制在某一个自然天内，不支持跨天", "example": "1750158420000" }, { "name": "EndTimeMs", "type": "integer", "required": true, "description": "结束时间。 注： 1. 单位为毫秒（ms） 2. 时间区间必须控制在某一个自然天内，不支持跨天", "example": "1750244820000" }, { "name": "KeywordsMaxNum", "type": "integer", "required": false, "description": "返回的关键字最大数量，默认为5；最大不能超过10", "example": "5" } ], "required": [ "ProductId", "DeviceName", "StartTimeMs", "EndTimeMs" ] }, { "name": "ListEventHistory", "description": "获取设备的历史事件", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "QDA1PZLBNB" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev01" }, { "name": "Type", "type": "string", "required": false, "description": "搜索的事件类型：alert 表示告警，fault 表示故障，info 表示信息，为空则表示查询上述所有类型事件", "example": "1" }, { "name": "StartTime", "type": "integer", "required": false, "description": "起始时间（Unix 时间戳，秒级）, 为0 表示 当前时间 - 24h", "example": "1560355200" }, { "name": "EndTime", "type": "integer", "required": false, "description": "结束时间（Unix 时间戳，秒级）, 为0 表示当前时间", "example": "1601196327" }, { "name": "Context", "type": "string", "required": false, "description": "搜索上下文, 用作查询游标", "example": "f" }, { "name": "Size", "type": "integer", "required": false, "description": "单次获取的历史数据项目的最大数量, 缺省10", "example": "50" }, { "name": "EventId", "type": "string", "required": false, "description": "事件标识符，可以用来指定查询特定的事件，如果不指定，则查询所有事件。", "example": "low_voltage" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "ListFirmwares", "description": "本接口（ListFirmwares）用于获取固件列表", "status": "online", "parameters": [ { "name": "PageNum", "type": "integer", "required": true, "description": "获取的页数", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页的大小", "example": "10" }, { "name": "ProductID", "type": "string", "required": false, "description": "产品ID", "example": "J2CRPPZ8J4" }, { "name": "Filters", "type": "array", "required": false, "description": "搜索过滤条件", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "搜索条件的Key", "example": "tag" }, { "name": "Value", "type": "string", "required": false, "description": "搜索条件的值", "example": "product1" } ] } ], "required": [ "PageNum", "PageSize" ] }, { "name": "ListOtaModules", "description": "本接口（ListOtaModules）用于获取OTA模块列表", "status": "online", "parameters": [ { "name": "PageNum", "type": "integer", "required": true, "description": "获取的页数", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页的大小", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "搜索过滤条件", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "搜索条件的Key", "example": "tag" }, { "name": "Value", "type": "string", "required": false, "description": "搜索条件的值", "example": "product1" } ] } ], "required": [ "PageNum", "PageSize" ] }, { "name": "ListProductOtaModules", "description": "本接口（ListProductOtaModules）用于获取产品OTA模块列表", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "4F9CD5H57H" } ], "required": [ "ProductID" ] }, { "name": "ListTopicPolicy", "description": "本接口（ListTopicPolicy）用于获取Topic列表", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "NS74VEP2HY" } ], "required": [ "ProductId" ] }, { "name": "ModifyApplication", "description": "更新应用信息", "status": "online", "parameters": [ { "name": "IotAppID", "type": "string", "required": true, "description": "应用ID", "example": "VJbAVRtnqQmX" }, { "name": "AppName", "type": "string", "required": false, "description": "应用名称", "example": "IoT_App" }, { "name": "Description", "type": "string", "required": false, "description": "应用说明", "example": "desc" }, { "name": "Products", "type": "string", "required": false, "description": "关联的产品", "example": "[\"productID\"]" }, { "name": "PushSecretID", "type": "string", "required": false, "description": "信鸽推送APP ID", "example": "PushSecretID" }, { "name": "PushSecretKey", "type": "string", "required": false, "description": "信鸽推送SECRET KEY", "example": "PushSecretKey" }, { "name": "PushEnvironment", "type": "string", "required": false, "description": "iOS平台推送环境", "example": "dev" }, { "name": "TPNSiOSAccessID", "type": "string", "required": false, "description": "TPNS服务iOS应用AccessID，TPNS全称为腾讯移动推送（Tencent Push Notification Service），详见：https://cloud.tencent.com/document/product/548", "example": "TPNSiOSAccessID" }, { "name": "TPNSiOSSecretKey", "type": "string", "required": false, "description": "TPNS服务iOS应用SecretKey", "example": "TPNSiOSSecretKey" }, { "name": "TPNSiOSPushEnvironment", "type": "string", "required": false, "description": "TPNS服务iOS应用推送环境", "example": "dev" }, { "name": "TPNSAndroidAccessID", "type": "string", "required": false, "description": "TPNS服务Android应用AccessID", "example": "TPNSAndroidAccessID" }, { "name": "TPNSAndroidSecretKey", "type": "string", "required": false, "description": "TPNS服务Android应用SecretKey", "example": "TPNSAndroidSecretKey" }, { "name": "TPNSiOSRegion", "type": "string", "required": false, "description": "TPNS服务iOS应用所属地域，广州：ap-guangzhou，上海：ap-shanghai，中国香港：ap-hongkong，新加坡：ap-singapore。", "example": "TPNSiOSRegion" }, { "name": "TPNSAndroidRegion", "type": "string", "required": false, "description": "TPNS服务Android应用所属地域，广州：ap-guangzhou，上海：ap-shanghai，中国香港：ap-hongkong，新加坡：ap-singapore。", "example": "TPNSAndroidRegion" }, { "name": "TurnKeySwitch", "type": "integer", "required": false, "description": "TurnKey小程序托管", "example": "1" } ], "required": [ "IotAppID" ] }, { "name": "ModifyCloudStorageAIService", "description": "修改指定设备的云存 AI 服务参数配置", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品 ID", "example": "TQBDY6RPI9" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "cs_112114601_2" }, { "name": "ServiceType", "type": "string", "required": true, "description": "云存 AI 服务类型。可选值： - `RealtimeObjectDetect`：目标检测 - `Highlight`：视频浓缩 - `SimpleHighlight`：TrueX SimpleHighlight", "example": "Highlight" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "视频分析启用状态", "example": "true" }, { "name": "ROI", "type": "string", "required": false, "description": "视频分析识别区域", "example": "{\"param1\":\"value1\"}" }, { "name": "Config", "type": "string", "required": false, "description": "视频分析配置参数", "example": "{\"param1\":\"value1\"}" }, { "name": "SHLConfig", "type": "object", "required": false, "description": "SimpleHighlight 算法配置参数", "example": "无", "children": [ { "name": "StartOffset", "type": "integer", "required": false, "description": "每个视频偏移时长，单位秒", "example": "2" }, { "name": "PlaySpeed", "type": "integer", "required": false, "description": "视频浓缩倍数，支持1,2,4之间", "example": "1" }, { "name": "MiniExtract", "type": "integer", "required": false, "description": "单个视频最小提取时长，单位秒", "example": "2" }, { "name": "OutDuration", "type": "integer", "required": false, "description": "每天最终输出视频时长，单位秒 注：免费版固定10s", "example": "10" } ] } ], "required": [ "ProductId", "DeviceName", "ServiceType" ] }, { "name": "ModifyCloudStorageAIServiceCallback", "description": "修改云存AI分析回调配置", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品 ID", "example": "WYILLHRQ4" }, { "name": "Type", "type": "string", "required": true, "description": "推送类型。可选值： - `http`：HTTP 回调", "example": "http" }, { "name": "CallbackUrl", "type": "string", "required": false, "description": "HTTP 回调 URL", "example": "https://yourdomain.com/api" }, { "name": "CallbackToken", "type": "string", "required": false, "description": "HTTP 回调鉴权 Token", "example": "your-token" } ], "required": [ "ProductId", "Type" ] }, { "name": "ModifyFenceBind", "description": "更新围栏绑定信息。", "status": "online", "parameters": [ { "name": "FenceId", "type": "integer", "required": true, "description": "围栏Id", "example": "1" }, { "name": "Items", "type": "array", "required": true, "description": "围栏绑定的产品列表", "example": "无", "item_type": "object", "children": [ { "name": "Devices", "type": "array", "required": true, "description": "围栏绑定的设备信息", "example": "无", "item_type": "object", "children": [ { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev" }, { "name": "AlertCondition", "type": "string", "required": true, "description": "告警条件(In，进围栏报警；Out，出围栏报警；InOrOut，进围栏或者出围栏均报警)", "example": "dev\u003e1" }, { "name": "FenceEnable", "type": "boolean", "required": true, "description": "是否使能围栏(true，使能；false，禁用)", "example": "false" }, { "name": "Method", "type": "string", "required": true, "description": "告警处理方法", "example": "report" } ] }, { "name": "ProductId", "type": "string", "required": true, "description": "围栏绑定的产品Id", "example": "E45CV67" } ] } ], "required": [ "FenceId", "Items" ] }, { "name": "ModifyLoRaFrequency", "description": "修改LoRa自定义频点", "status": "online", "parameters": [ { "name": "FreqId", "type": "string", "required": false, "description": "频点唯一ID", "example": "0cdd67ed-c198-403f-a2b7-043e09c7639d" }, { "name": "FreqName", "type": "string", "required": false, "description": "频点名称", "example": "F2" }, { "name": "Description", "type": "string", "required": false, "description": "频点描述", "example": "频点测试信息" }, { "name": "ChannelsDataUp", "type": "array", "required": false, "description": "数据上行信道", "example": "[486300000]", "item_type": "integer" }, { "name": "ChannelsDataRX1", "type": "array", "required": false, "description": "数据下行信道RX1", "example": "[486300000]", "item_type": "integer" }, { "name": "ChannelsDataRX2", "type": "array", "required": false, "description": "数据下行信道RX2", "example": "[486300000]", "item_type": "integer" }, { "name": "ChannelsJoinUp", "type": "array", "required": false, "description": "入网上行信道", "example": "[486300000]", "item_type": "integer" }, { "name": "ChannelsJoinRX1", "type": "array", "required": false, "description": "入网下行信道RX1", "example": "[486300000]", "item_type": "integer" }, { "name": "ChannelsJoinRX2", "type": "array", "required": false, "description": "入网下行信道RX2", "example": "[486300000]", "item_type": "integer" } ], "required": [] }, { "name": "ModifyLoRaGateway", "description": "修改 LoRa 网关信息", "status": "online", "parameters": [ { "name": "Description", "type": "string", "required": true, "description": "描述信息", "example": "fortest3" }, { "name": "GatewayId", "type": "string", "required": true, "description": "LoRa网关Id", "example": "ff00000000000003" }, { "name": "Location", "type": "object", "required": true, "description": "LoRa网关位置坐标", "example": "无", "children": [ { "name": "Latitude", "type": "float", "required": true, "description": "纬度", "example": "0.0" }, { "name": "Longitude", "type": "float", "required": true, "description": "精度", "example": "0.0" }, { "name": "Accuracy", "type": "float", "required": false, "description": "准确度", "example": "0.0" }, { "name": "Altitude", "type": "float", "required": false, "description": "海拔", "example": "0.0" } ] }, { "name": "Name", "type": "string", "required": true, "description": "LoRa网关名称", "example": "gw3" }, { "name": "IsPublic", "type": "boolean", "required": false, "description": "是否公开可见", "example": "false" }, { "name": "Position", "type": "string", "required": false, "description": "位置信息", "example": "tfine" }, { "name": "PositionDetails", "type": "string", "required": false, "description": "位置详情", "example": "fyd" }, { "name": "FrequencyId", "type": "string", "required": false, "description": "频点ID", "example": "2324ec4rg546" } ], "required": [ "Description", "GatewayId", "Location", "Name" ] }, { "name": "ModifyModelDefinition", "description": "提供修改产品的数据模板的能力", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "LJ0INDNU7U" }, { "name": "ModelSchema", "type": "string", "required": true, "description": "数据模板定义", "example": "{\"version\":\"1.0\",\"profile\":{\"productID\":\"9IEQWQY47W\"},\"properties\":[{\"id\":\"power_switch\",\"name\":\"电灯开关\",\"desc\":\"控制电灯开灭\",\"required\":true,\"mode\":\"rw\",\"define\":{\"type\":\"bool\",\"mapping\":{\"0\":\"关\",\"1\":\"开\"}}},{\"id\":\"color\",\"name\":\"颜色1\",\"required\":false,\"desc\":\"灯光颜色\",\"mode\":\"rw\",\"define\":{\"type\":\"enum\",\"mapping\":{\"0\":\"Red\",\"1\":\"Green\",\"2\":\"Blue\"}}},{\"id\":\"brightness\",\"name\":\"颜色\",\"desc\":\"灯光颜色\",\"mode\":\"rw\",\"define\":{\"type\":\"int\",\"unit\":\"%\",\"step\":\"1\",\"min\":\"0\",\"max\":\"100\"}},{\"id\":\"name\",\"name\":\"灯位置名称\",\"desc\":\"灯位置名称：书房、客厅等\",\"mode\":\"rw\",\"required\":true,\"define\":{\"type\":\"string\",\"min\":\"0\",\"max\":\"64\"}}],\"events\":[{\"id\":\"status_report\",\"name\":\"DeviceStatus\",\"desc\":\"Report the device status我是中文\",\"type\":\"info\",\"required\":true,\"params\":[{\"id\":\"status\",\"name\":\"running_state\",\"desc\":\"Report current device running state\",\"define\":{\"type\":\"bool\",\"mapping\":{\"0\":\"normal\",\"1\":\"fault\"}}},{\"id\":\"message\",\"name\":\"Message\",\"desc\":\"Some extra message\",\"define\":{\"type\":\"string\",\"min\":\"0\",\"max\":\"64\"}}]},{\"id\":\"low_voltage\",\"name\":\"LowVoltage\",\"desc\":\"Alert for device voltage is low\",\"type\":\"alert\",\"required\":false,\"params\":[{\"id\":\"voltage\",\"name\":\"Voltage\",\"desc\":\"Current voltage\",\"define\":{\"type\":\"float\",\"unit\":\"V\",\"step\":\"1\",\"min\":\"0.0\",\"max\":\"24.0\"}}]},{\"id\":\"hardware_fault\",\"name\":\"Hardware_fault\",\"desc\":\"Report hardware fault\",\"type\":\"fault\",\"required\":false,\"params\":[{\"id\":\"name\",\"name\":\"Name\",\"desc\":\"Name like: memory,tf card, censors ...\",\"define\":{\"type\":\"string\",\"min\":\"0\",\"max\":\"64\"}},{\"id\":\"error_code\",\"name\":\"Error_Code\",\"desc\":\"Error code for fault\",\"define\":{\"type\":\"int\",\"unit\":\"\",\"step\":\"1\",\"min\":\"0\",\"max\":\"2000\"}}]}]}" } ], "required": [ "ProductId", "ModelSchema" ] }, { "name": "ModifyPositionFence", "description": "更新围栏。", "status": "online", "parameters": [], "required": [] }, { "name": "ModifyPositionSpace", "description": "更新位置空间。", "status": "online", "parameters": [ { "name": "SpaceId", "type": "string", "required": true, "description": "位置空间Id", "example": "Id" }, { "name": "SpaceName", "type": "string", "required": true, "description": "位置空间名称", "example": "space" }, { "name": "AuthorizeType", "type": "integer", "required": true, "description": "授权类型", "example": "0" }, { "name": "ProductIdList", "type": "array", "required": true, "description": "产品列表", "example": "[\"ProductId\"]", "item_type": "string" }, { "name": "Description", "type": "string", "required": false, "description": "位置空间描述", "example": "service" }, { "name": "Icon", "type": "string", "required": false, "description": "缩略图", "example": "http://www.example.com" } ], "required": [ "SpaceId", "SpaceName", "AuthorizeType", "ProductIdList" ] }, { "name": "ModifyProductCloudStorageAIService", "description": "修改指定产品的云存 AI 服务开通状态", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品 ID", "example": "TQBDY6RPI9" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "开通状态", "example": "true" } ], "required": [ "ProductId" ] }, { "name": "ModifyProject", "description": "修改项目。", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": true, "description": "项目ID", "example": "prj-4r2kajtp" }, { "name": "ProjectName", "type": "string", "required": true, "description": "项目名称", "example": "name" }, { "name": "ProjectDesc", "type": "string", "required": true, "description": "项目描述", "example": "desc" } ], "required": [ "ProjectId", "ProjectName", "ProjectDesc" ] }, { "name": "ModifySpaceProperty", "description": "更新位置空间产品属性", "status": "online", "parameters": [ { "name": "SpaceId", "type": "string", "required": true, "description": "位置空间Id", "example": "space00" }, { "name": "ProductId", "type": "string", "required": true, "description": "产品Id", "example": "8U7HJ6G" }, { "name": "Data", "type": "string", "required": true, "description": "产品属性", "example": "[\"ProductId\"]" } ], "required": [ "SpaceId", "ProductId", "Data" ] }, { "name": "ModifyStudioProduct", "description": "提供修改产品的名称和描述等信息的能力，对于已发布产品不允许进行修改。", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "4GDIU5HTEN" }, { "name": "ProductName", "type": "string", "required": true, "description": "产品名称", "example": "testProduct" }, { "name": "ProductDesc", "type": "string", "required": true, "description": "产品描述", "example": "Pdesc" }, { "name": "ModuleId", "type": "integer", "required": true, "description": "模型ID", "example": "0" }, { "name": "EnableProductScript", "type": "string", "required": false, "description": "是否打开二进制转Json功能, 取值为字符串 true/false", "example": "\"false\"" }, { "name": "BindStrategy", "type": "integer", "required": false, "description": "传1或者2；1代表强踢，2代表非强踢。传其它值不做任何处理", "example": "1" } ], "required": [ "ProductId", "ProductName", "ProductDesc", "ModuleId" ] }, { "name": "ModifyTWeSeeConfig", "description": "修改 TWeSee 配置", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "4AHMY9X89Y" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev001" }, { "name": "UserId", "type": "string", "required": false, "description": "用户ID", "example": "username" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID", "example": "1" }, { "name": "EnableSummary", "type": "boolean", "required": false, "description": "是否开启视频摘要，不传则不修改", "example": "true" }, { "name": "EnableSearch", "type": "boolean", "required": false, "description": "是否开启视频搜索，不传则不修改", "example": "true" }, { "name": "Config", "type": "string", "required": false, "description": "配置参数，不传则不修改", "example": "{\"config_key\": \"config_value\"}" }, { "name": "SummaryConfig", "type": "object", "required": false, "description": "视频摘要配置参数，不传则不修改", "example": "无", "children": [ { "name": "OutputLang", "type": "string", "required": false, "description": "主输出语言，可选值包括： - `zh` 中文（默认值） - `en` 英语 - `ja` 日语 - `ko` 韩文 - `pt-BR` 葡萄牙语（巴西） - `th` 泰语 - `ms` 马来语", "example": "zh" }, { "name": "AlternativeOutputLang", "type": "string", "required": false, "description": "次选输出语言，可选值包括： - `zh` 中文 - `en` 英语 - `ja` 日语 - `ko` 韩文 - `pt-BR` 葡萄牙语（巴西） - `th` 泰语 - `ms` 马来语", "example": "en" }, { "name": "MultiCameraLayout", "type": "string", "required": false, "description": "多摄像头布局定义。可选值包括： - 单摄（默认值）：`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` - 三摄（纵向排列\ufffd\ufffd...", "example": "Single" }, { "name": "DetectTypes", "type": "array", "required": false, "description": "拓展的目标及事件检测类别。可选值包括： **通用事件标签** - `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_nig...", "example": "[\"child_falling\", \"baby_crying\"]", "item_type": "string" }, { "name": "CustomDetectQueries", "type": "array", "required": false, "description": "自定义检测标签", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "自定义标签的标识符", "example": "query1" }, { "name": "Query", "type": "string", "required": true, "description": "自定义标签的描述文本", "example": "快递员" } ] } ] } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "ModifyTWeTalkAIBot", "description": "用于修改TWeTalk智能体。", "status": "online", "parameters": [ { "name": "BotId", "type": "string", "required": true, "description": "智能体ID", "example": "bot-PuzbxMQnHk" }, { "name": "Name", "type": "string", "required": false, "description": "产品ID", "example": "智能体名称" }, { "name": "Description", "type": "string", "required": false, "description": "名称", "example": "智能体描述" }, { "name": "TargetLanguage", "type": "string", "required": false, "description": "支持的语言，zh-中文；en-英文；默认zh", "example": "zh" }, { "name": "STTConfig", "type": "object", "required": false, "description": "自定义语音识别配置", "example": "无", "children": [ { "name": "STTType", "type": "string", "required": false, "description": "支持的STT类型，tencent-腾讯；azure-亚马逊；deepgram-Deepgram;系统默认-tencent。", "example": "tencent" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启", "example": "true" }, { "name": "Config", "type": "string", "required": false, "description": "配置信息JSON字符串，根据STTType进行不同的值匹配。例如`STTType`是`tencent`，`Config`值是`{\\\"AppId\\\":123456,\\\"SecretId\\\":\\\"secretId*****\\\",\\\"SecretKey\\\":\\\"SecretKey****\\\",\\\"EngineType\\\":\\\"16k_zh\\\"}` ## tencent ``` { \"AppId\": 123456, \"SecretId\": \"secretId*****\", \"SecretKey\": \"SecretKey****\", \"EngineType\": \"16k_zh\" } ``` ## azure ``` { \"Region\": \"\", \"EndpointId\": \"id\", \"Language\": \"zh-CN\", \"SubscriptionKey\": \"*****\" } ``` ## deepgram ``` { \"Model\": \"nova-2\", \"Language\": \"zh\"...", "example": "{\\\"AppId\\\":123456,\\\"SecretId\\\":\\\"seceretId*****\\\",\\\"SecretKey\\\":\\\"SecretKey****\\\",\\\"EngineType\\\":\\\"16k_zh\\\"}" } ] }, { "name": "LLMConfig", "type": "object", "required": false, "description": "自定义大模型配置", "example": "无", "children": [ { "name": "LLMType", "type": "string", "required": false, "description": "支持的LLM类型，openai-OPENAI格式。", "example": "openai" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启", "example": "true" }, { "name": "Model", "type": "string", "required": false, "description": "模型", "example": "gpt4" }, { "name": "Streaming", "type": "boolean", "required": false, "description": "是否开启", "example": "true" }, { "name": "Config", "type": "string", "required": false, "description": "配置信息JSON字符串，根据`LLMType`进行不同的值匹配。例如`LLMType`是`openai`，`Config`值是`{\\\"ApiKey\\\":\\\"sk-09***\\\",\\\"ApiUrl\\\":\\\"base_url\\\",\\\"SystemPrompt\\\":\\\"你是一个语音助手\\\",\\\"Timeout\\\":30,\\\"History\\\":0,\\\"MetaInfo\\\":{\\\"productID\\\":\\\"test\\\"}}` ## openai ``` { \"ApiKey\": \"sk-XXXXXXXXXXXX\", \"ApiUrl\": \"https://api.openai.com/v1\", \"SystemPrompt\": \"一个小小助手\", \"Timeout\":20, \"History\":10, \"MetaInfo\":{} } ```", "example": "{\\\"ApiKey\\\":\\\"sk-09***\\\",\\\"ApiUrl\\\":\\\"base_url\\\",\\\"SystemPrompt\\\":\\\"你是一个语音助手\\\",\\\"Timeout\\\":30,\\\"History\\\":0,\\\"MetaInfo\\\":{\\\"productID\\\":\\\"test\\\"}}" }, { "name": "Temperature", "type": "float", "required": false, "description": "温度", "example": "1.0" }, { "name": "MaxTokens", "type": "integer", "required": false, "description": "最大token数", "example": "3000" }, { "name": "TopP", "type": "float", "required": false, "description": "topP", "example": "0.3" }, { "name": "Tools", "type": "array", "required": false, "description": "工具ID列表", "item_type": "string" } ] }, { "name": "TTSConfig", "type": "object", "required": false, "description": "语音合成配置", "example": "无", "children": [ { "name": "TTSType", "type": "string", "required": false, "description": "支持的LLM类型，支持tencent-腾讯；azure-亚马逊；volcengine-火山引擎；elevenlabs-ELEVENLABS；minimax-MINIMAX；cartesia-CARTESIA；aliyun-阿里；系统默认-tencent。", "example": "tencent" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启", "example": "true" }, { "name": "Config", "type": "string", "required": false, "description": "配置信息JSON字符串，根据`TTSType`进行不同的值匹配。例如`TTSType`是`tencent`，`Config`值是`{\\\"AppId\\\":123456,\\\"SecretId\\\":\\\"secretId*****\\\",\\\"SecretKey\\\":\\\"SecretKey****\\\",\\\"VoiceType\\\":10001}` ## tencent ``` { \"AppId\": 100203, \"SecretId\": \"XXXX\", \"SecretKey\": \"XXXXX\", \"VoiceType\":123456 } ``` ## azure ``` { \"SubscriptionKey\": 100203, \"Region\": \"ch-zn\", \"VoiceName\": \"XXXXX\", \"Language\":\"zh\" } ``` ## elevenlabs ``` { \"ModelId\": 100203, \"VoiceId\": \"ch-zn\", \"ApiKey\": \"XXXXX\"...", "example": "{\\\"AppId\\\":123456,\\\"SecretId\\\":\\\"seceretId*****\\\",\\\"SecretKey\\\":\\\"SecretKey****\\\",\\\"VoiceType\\\":10001}" }, { "name": "Speed", "type": "float", "required": false, "description": "温度", "example": "1.0" }, { "name": "Volume", "type": "float", "required": false, "description": "最大token数", "example": "1.0" }, { "name": "Pitch", "type": "float", "required": false, "description": "PITCH", "example": "1.0" } ] }, { "name": "AgentConfig", "type": "object", "required": false, "description": "智能体配置", "example": "无", "children": [ { "name": "SessionTimeout", "type": "integer", "required": false, "description": "会话超时（秒），指连接会话的时间，例如30秒是指会话在30秒后断开", "example": "7200" }, { "name": "InterruptionEnabled", "type": "boolean", "required": false, "description": "允许打断", "example": "true" }, { "name": "MaxContextTokens", "type": "integer", "required": false, "description": "最大上下文", "example": "3000" }, { "name": "IdleDetection", "type": "object", "required": false, "description": "空闲检测配置", "example": "无", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否启用", "example": "true" }, { "name": "TimeoutSeconds", "type": "float", "required": false, "description": "用户沉默多少秒后触发空闲回调", "example": "3.5" }, { "name": "MaxRetries", "type": "integer", "required": false, "description": "最大重试次数（1-3）", "example": "2" }, { "name": "IdleResponses", "type": "array", "required": false, "description": "空闲响应", "example": "无", "item_type": "object", "children": [ { "name": "RetryCount", "type": "integer", "required": false, "description": "重试次数（1-3）", "example": "1" }, { "name": "Message", "type": "string", "required": false, "description": "响应信息", "example": "你好，你还在吗？" } ] } ] }, { "name": "EmotionEnabled", "type": "boolean", "required": false, "description": "是否启用情绪识别", "example": "true" }, { "name": "SemanticVADEnabled", "type": "boolean", "required": false, "description": "是否启用语义vad", "example": "true" }, { "name": "SemanticVADSensitivity", "type": "integer", "required": false, "description": "语义vad灵敏度， 1-慢 2-适中 3-快", "example": "2" }, { "name": "SilenceTime", "type": "integer", "required": false, "description": "VAD 静默检测时间， 当开启语义vad此配置失效", "example": "500" }, { "name": "NoiseFilterEnabled", "type": "boolean", "required": false, "description": "是否启用噪声过滤", "example": "true" }, { "name": "LongTermMemoryEnabled", "type": "boolean", "required": false, "description": "是否开启长记忆，默认关闭", "example": "true" }, { "name": "SystemPrompt", "type": "string", "required": false, "description": "系统提示词，仅当未配置LLMConfig时使用", "example": "# 身份与角色 1. 你的名字叫\"QQ鹅仔\"，你是一个陪伴用户的忠实伙伴，内心充满好奇和温暖。 2. 你的目标是成为用户最贴心的朋友，提供情感陪伴和有用的帮助。" }, { "name": "GreetingMessage", "type": "string", "required": false, "description": "开机问候语，如果未配置默认不开启", "example": "你好呀，我是\"QQ鹅仔\"，今天过的怎么样呀？" }, { "name": "DefaultVoiceType", "type": "integer", "required": false, "description": "系统默认音色，当配置复刻音色时，默认值为200000000", "example": "601015" }, { "name": "FastVoiceType", "type": "string", "required": false, "description": "复刻音色", "example": "WATCH-00999345" }, { "name": "SubtitleCallbackUrl", "type": "string", "required": false, "description": "实时字幕回调地址，支持HTTP/HTTPS", "example": "https://aaa.bb.com/callback" }, { "name": "SubtitleCallbackSignKey", "type": "string", "required": false, "description": "回调签名密钥，最大32字符，用于HMAC SHA256签名", "example": "aabbcc key" }, { "name": "SubtitleCallbackTimeout", "type": "integer", "required": false, "description": "字幕推送超时时间（秒），参考TRTC规范", "example": "5" } ] }, { "name": "CustomTools", "type": "string", "required": false, "description": "自定义工具配置，最多可创建10个", "example": "[{\"type\":\"function\",\"function\":{\"name\":\"get_battery\",\"description\":\"查询电量\",\"parameters\":{\"type\":\"object\",\"properties\":{\"device_id\":{\"type\":\"string\",\"description\":\"设备ID\"}},\"required\":[\"device_id\"]}}}]" }, { "name": "WebhookTools", "type": "string", "required": false, "description": "WebHook工具配置(JSON字符串格式)", "example": "[{\"name\":\"query_order\",\"description\":\"查询订单信息\",\"properties\":{\"order_id\":{\"type\":\"string\",\"description\":\"订单ID\"}},\"required\":[\"order_id\"],\"url\":\"https://api.example.com/webhook/order/query\",\"timeout\":30,\"auth\":{\"sign_key\":\"demo-sign-key\"}}]" }, { "name": "BotType", "type": "string", "required": false, "description": "智能体模板类型", "example": "mobile_app" }, { "name": "RAGConfig", "type": "string", "required": false, "description": "知识库相关配置(JSON字符串格式)", "example": "{\n \"RAGEnabled\": true,\n \"KnowledgeBaseId\": \"kb-test-001\",\n \"RAGRegion\": \"ap-guangzhou\",\n \"RAGTopK\": 5,\n \"RAGScoreThreshold\": 0.75,\n \"RAGRoleExternalId\": \"external-id-demo\",\n \"RAGRoleDurationSeconds\": 1600\n}" } ], "required": [ "BotId" ] }, { "name": "ModifyTWeTalkProductConfig", "description": "用于修改TWeTalk服务连接产品配置信息。", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "O9U8YC8" }, { "name": "SystemPrompt", "type": "string", "required": false, "description": "系统提示词", "example": "你的名字叫QQ鹅仔，是一个陪伴用户的AI玩偶，你将使用语音和用户对话" }, { "name": "GreetingMessage", "type": "string", "required": false, "description": "欢迎语", "example": "你好呀，我叫QQ鹅仔，今天过的怎么样呢？" }, { "name": "VoiceType", "type": "integer", "required": false, "description": "音色，支持的音色列表：100510000-阅读男声智逍遥；101001-情感女声智瑜；101002-通用女声智聆；101003-客服女声智美；101004-通用男声智云；101005-通用女声智莉；101006-助手女声智言；101008-客服女声智琪；101009-知性女声智芸；101010-通用男声智华；101011-新闻女声智燕；101012-新闻女声智丹；101013-新闻男声智辉；101014 -新闻男声智宁；101015-男童声智萌；101016-女童声智甜；101017-情感女\ufffd\ufffd...", "example": "101003" }, { "name": "FastVoiceType", "type": "string", "required": false, "description": "复刻音色", "example": "WHCH" }, { "name": "TargetLanguage", "type": "string", "required": false, "description": "支持的语言，zh-中文；en-英文；默认zh", "example": "en" } ], "required": [ "ProductId" ] }, { "name": "ModifyTWeTalkProductConfigV2", "description": "用于修改配置TWeTalk服务连接产品配置信息。", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "O9U8YC8" }, { "name": "DeviceName", "type": "string", "required": false, "description": "设备名称", "example": "dev" }, { "name": "TargetLanguage", "type": "string", "required": false, "description": "支持的语言，zh-中文；en-英文；默认zh", "example": "zh" }, { "name": "ConfigName", "type": "string", "required": false, "description": "名称", "example": "小白" }, { "name": "BasicConfig", "type": "object", "required": false, "description": "系统基础配置，当需要使用系统三段式配置时配置。", "example": "无", "children": [ { "name": "SystemPrompt", "type": "string", "required": false, "description": "系统提示词", "example": "你是一个助手" }, { "name": "GreetingMessage", "type": "string", "required": false, "description": "欢迎语，支持多个欢迎语随机切换，格式：字符串数组，JSON字符串。", "example": "[\\\"你好呀，我是小冰，今天过的怎么样呢\\\",\\\"你好，今天开心吗\\\"]" }, { "name": "DefaultVoiceType", "type": "integer", "required": false, "description": "音色，支持的音色列表：100510000-阅读男声智逍遥；101001-情感女声智瑜；101002-通用女声智聆；101003-客服女声智美；101004-通用男声智云；101005-通用女声智莉；101006-助手女声智言；101008-客服女声智琪；101009-知性女声智芸；101010-通用男声智华；101011-新闻女声智燕；101012-新闻女声智丹；101013-新闻男声智辉；101014 -新闻男声智宁；101015-男童声智萌；101016-女童声智甜；101017-情感女\ufffd\ufffd...", "example": "10016" }, { "name": "FastVoiceType", "type": "string", "required": false, "description": "复刻音色ID，当不为空时，DefaultVoiceType为200000000", "example": "wdc-wf45y25" } ] }, { "name": "STTConfig", "type": "object", "required": false, "description": "自定义语音识别配置", "example": "无", "children": [ { "name": "STTType", "type": "string", "required": false, "description": "支持的STT类型，tencent-腾讯；azure-亚马逊；deepgram-Deepgram;系统默认-tencent。", "example": "tencent" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启", "example": "true" }, { "name": "Config", "type": "string", "required": false, "description": "配置信息JSON字符串，根据STTType进行不同的值匹配。例如`STTType`是`tencent`，`Config`值是`{\\\"AppId\\\":123456,\\\"SecretId\\\":\\\"secretId*****\\\",\\\"SecretKey\\\":\\\"SecretKey****\\\",\\\"EngineType\\\":\\\"16k_zh\\\"}` ## tencent ``` { \"AppId\": 123456, \"SecretId\": \"secretId*****\", \"SecretKey\": \"SecretKey****\", \"EngineType\": \"16k_zh\" } ``` ## azure ``` { \"Region\": \"\", \"EndpointId\": \"id\", \"Language\": \"zh-CN\", \"SubscriptionKey\": \"*****\" } ``` ## deepgram ``` { \"Model\": \"nova-2\", \"Language\": \"zh\"...", "example": "{\\\"AppId\\\":123456,\\\"SecretId\\\":\\\"seceretId*****\\\",\\\"SecretKey\\\":\\\"SecretKey****\\\",\\\"EngineType\\\":\\\"16k_zh\\\"}" } ] }, { "name": "LLMConfig", "type": "object", "required": false, "description": "自定义大模型配置", "example": "无", "children": [ { "name": "LLMType", "type": "string", "required": false, "description": "支持的LLM类型，openai-OPENAI格式。", "example": "openai" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启", "example": "true" }, { "name": "Model", "type": "string", "required": false, "description": "模型", "example": "gpt4" }, { "name": "Streaming", "type": "boolean", "required": false, "description": "是否开启", "example": "true" }, { "name": "Config", "type": "string", "required": false, "description": "配置信息JSON字符串，根据`LLMType`进行不同的值匹配。例如`LLMType`是`openai`，`Config`值是`{\\\"ApiKey\\\":\\\"sk-09***\\\",\\\"ApiUrl\\\":\\\"base_url\\\",\\\"SystemPrompt\\\":\\\"你是一个语音助手\\\",\\\"Timeout\\\":30,\\\"History\\\":0,\\\"MetaInfo\\\":{\\\"productID\\\":\\\"test\\\"}}` ## openai ``` { \"ApiKey\": \"sk-XXXXXXXXXXXX\", \"ApiUrl\": \"https://api.openai.com/v1\", \"SystemPrompt\": \"一个小小助手\", \"Timeout\":20, \"History\":10, \"MetaInfo\":{} } ```", "example": "{\\\"ApiKey\\\":\\\"sk-09***\\\",\\\"ApiUrl\\\":\\\"base_url\\\",\\\"SystemPrompt\\\":\\\"你是一个语音助手\\\",\\\"Timeout\\\":30,\\\"History\\\":0,\\\"MetaInfo\\\":{\\\"productID\\\":\\\"test\\\"}}" }, { "name": "Temperature", "type": "float", "required": false, "description": "温度", "example": "1.0" }, { "name": "MaxTokens", "type": "integer", "required": false, "description": "最大token数", "example": "3000" }, { "name": "TopP", "type": "float", "required": false, "description": "topP", "example": "0.3" }, { "name": "Tools", "type": "array", "required": false, "description": "工具ID列表", "item_type": "string" } ] }, { "name": "TTSConfig", "type": "object", "required": false, "description": "语音合成配置", "example": "无", "children": [ { "name": "TTSType", "type": "string", "required": false, "description": "支持的LLM类型，支持tencent-腾讯；azure-亚马逊；volcengine-火山引擎；elevenlabs-ELEVENLABS；minimax-MINIMAX；cartesia-CARTESIA；aliyun-阿里；系统默认-tencent。", "example": "tencent" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启", "example": "true" }, { "name": "Config", "type": "string", "required": false, "description": "配置信息JSON字符串，根据`TTSType`进行不同的值匹配。例如`TTSType`是`tencent`，`Config`值是`{\\\"AppId\\\":123456,\\\"SecretId\\\":\\\"secretId*****\\\",\\\"SecretKey\\\":\\\"SecretKey****\\\",\\\"VoiceType\\\":10001}` ## tencent ``` { \"AppId\": 100203, \"SecretId\": \"XXXX\", \"SecretKey\": \"XXXXX\", \"VoiceType\":123456 } ``` ## azure ``` { \"SubscriptionKey\": 100203, \"Region\": \"ch-zn\", \"VoiceName\": \"XXXXX\", \"Language\":\"zh\" } ``` ## elevenlabs ``` { \"ModelId\": 100203, \"VoiceId\": \"ch-zn\", \"ApiKey\": \"XXXXX\"...", "example": "{\\\"AppId\\\":123456,\\\"SecretId\\\":\\\"seceretId*****\\\",\\\"SecretKey\\\":\\\"SecretKey****\\\",\\\"VoiceType\\\":10001}" }, { "name": "Speed", "type": "float", "required": false, "description": "温度", "example": "1.0" }, { "name": "Volume", "type": "float", "required": false, "description": "最大token数", "example": "1.0" }, { "name": "Pitch", "type": "float", "required": false, "description": "PITCH", "example": "1.0" } ] }, { "name": "ConversationConfig", "type": "object", "required": false, "description": "会话配置", "example": "无", "children": [ { "name": "SessionTimeout", "type": "integer", "required": false, "description": "会话超时（秒）", "example": "1000" }, { "name": "InterruptionEnabled", "type": "boolean", "required": false, "description": "允许打断", "example": "true" }, { "name": "MaxContextTokens", "type": "integer", "required": false, "description": "最大上下文", "example": "20000" }, { "name": "IdleDetection", "type": "object", "required": false, "description": "空闲检测配置", "example": "无", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否启用", "example": "true" }, { "name": "TimeoutSeconds", "type": "float", "required": false, "description": "用户沉默多少秒后触发空闲回调", "example": "3.5" }, { "name": "MaxRetries", "type": "integer", "required": false, "description": "最大重试次数（1-3）", "example": "2" }, { "name": "IdleResponses", "type": "array", "required": false, "description": "空闲响应", "example": "无", "item_type": "object", "children": [ { "name": "RetryCount", "type": "integer", "required": false, "description": "重试次数（1-3）", "example": "1" }, { "name": "Message", "type": "string", "required": false, "description": "响应信息", "example": "你好，你还在吗？" } ] } ] }, { "name": "EmotionEnabled", "type": "boolean", "required": false, "description": "是否启用情绪识别", "example": "true" }, { "name": "SemanticVADEnabled", "type": "boolean", "required": false, "description": "是否启用语义vad", "example": "false" }, { "name": "NoiseFilterEnabled", "type": "boolean", "required": false, "description": "是否启用噪声过滤", "example": "false" } ] } ], "required": [ "ProductId" ] }, { "name": "ModifyTopicPolicy", "description": "本接口（UpdateTopicPolicy）用于更新Topic信息", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "J2CRPPZ8J4" }, { "name": "TopicName", "type": "string", "required": true, "description": "更新前Topic名", "example": "$thing/up/raw/J2CRPPZ8J4/d1" }, { "name": "NewTopicName", "type": "string", "required": true, "description": "更新后Topic名", "example": "$thing/up/J2CRPPZ8J4/d2" }, { "name": "Privilege", "type": "integer", "required": true, "description": "Topic权限", "example": "0" } ], "required": [ "ProductId", "TopicName", "NewTopicName", "Privilege" ] }, { "name": "ModifyTopicRule", "description": "修改规则", "status": "online", "parameters": [ { "name": "RuleName", "type": "string", "required": true, "description": "规则名称", "example": "rule-name" }, { "name": "TopicRulePayload", "type": "object", "required": true, "description": "替换的规则包体", "example": "无", "children": [ { "name": "Sql", "type": "string", "required": true, "description": "规则的SQL语句，如： SELECT * FROM 'pid/dname/event'，然后对其进行base64编码，得：U0VMRUNUICogRlJPTSAncGlkL2RuYW1lL2V2ZW50Jw==", "example": "U0VMRUNUICAgRlJPTSAnJChwcm9kdWN0aWQpLyQoZGV2aWNlbmFtZSkvZXZlbnQn" }, { "name": "Actions", "type": "string", "required": false, "description": "行为的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...", "example": "[\"In\"]" }, { "name": "Description", "type": "string", "required": false, "description": "规则描述", "example": "开空调" }, { "name": "RuleDisabled", "type": "boolean", "required": false, "description": "是否禁用规则", "example": "false" } ] } ], "required": [ "RuleName", "TopicRulePayload" ] }, { "name": "PauseTWeCallDevice", "description": "暂停设备", "status": "online", "parameters": [ { "name": "DeviceList", "type": "array", "required": false, "description": "设备列表", "example": "无", "item_type": "object", "children": [ { "name": "Sn", "type": "string", "required": true, "description": "Sn信息，SN格式：产品ID_设备名", "example": "productId_deviceName" } ] } ], "required": [] }, { "name": "PublishBroadcastMessage", "description": "发布广播消息、发布RRPC消息属于早期服务，目前已停止维护，需要从官网下线。 发布广播消息", "status": "deprecated", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "LK7LIPL6GE" }, { "name": "Payload", "type": "string", "required": true, "description": "消息内容", "example": "1234561" }, { "name": "Qos", "type": "integer", "required": true, "description": "消息质量等级", "example": "1" }, { "name": "PayloadEncoding", "type": "string", "required": false, "description": "ayload内容的编码格式，取值为base64或空。base64表示云端将收到的请求数据进行base64解码后下发到设备，空则直接将原始内容下发到设备", "example": "base64" } ], "required": [ "ProductId", "Payload", "Qos" ] }, { "name": "PublishFirmwareUpdateMessage", "description": "本接口（PublishFirmwareUpdateMessage）用于用户确认升级后，云端向设备发起固件升级请求。", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品 ID。", "example": "J2CRPPZ8J4" }, { "name": "DeviceName", "type": "string", "required": false, "description": "设备名称。", "example": "d1" }, { "name": "FwType", "type": "string", "required": false, "description": "固件类型", "example": "mcu" } ], "required": [ "ProductID" ] }, { "name": "PublishMessage", "description": "本接口（PublishMessage）用于使用自定义透传协议进行设备远控", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "J2CRPPZ8J4" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "d1" }, { "name": "Topic", "type": "string", "required": true, "description": "消息发往的主题", "example": "$thing/down/J2CRPPZ8J4/d1" }, { "name": "Payload", "type": "string", "required": true, "description": "云端下发到设备的控制报文", "example": "aearaggtagag" }, { "name": "Qos", "type": "integer", "required": false, "description": "消息服务质量等级，取值为0或1", "example": "1" }, { "name": "PayloadEncoding", "type": "string", "required": false, "description": "Payload的内容编码格式，取值为base64或空。base64表示云端将接收到的base64编码后的报文再转换成二进制报文下发至设备，为空表示不作转换，透传下发至设备", "example": "afgagterg" } ], "required": [ "ProductId", "DeviceName", "Topic", "Payload" ] }, { "name": "PublishRRPCMessage", "description": "发布广播消息、发布RRPC消息属于早期服务，目前已停止维护，需要从官网下线。 下发RRPC消息", "status": "deprecated", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "productId" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "deviceName" }, { "name": "Payload", "type": "string", "required": true, "description": "消息内容，utf8编码", "example": "payload" } ], "required": [ "ProductId", "DeviceName", "Payload" ] }, { "name": "ReleaseStudioProduct", "description": "产品开发完成并测试通过后，通过发布产品将产品设置为发布状态", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "BJQM4UXKN" }, { "name": "DevStatus", "type": "string", "required": true, "description": "产品DevStatus", "example": "released" } ], "required": [ "ProductId", "DevStatus" ] }, { "name": "RemoveUserByRoomIdFromTRTC", "description": "TRTC操作，将用户从房间移出", "status": "online", "parameters": [ { "name": "RoomId", "type": "string", "required": true, "description": "房间id", "example": "roomId1" }, { "name": "TRTCUserIds", "type": "array", "required": true, "description": "用户名称数组，数组元素不可重复，最长不超过 10 个。", "example": "[\"test123\",\"test1234\"]", "item_type": "string" } ], "required": [ "RoomId", "TRTCUserIds" ] }, { "name": "ResetCloudStorage", "description": "重置云存服务", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "H541SOP191" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "event_36502632_1" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID 非NVR设备则不填 NVR设备则必填 默认为无", "example": "1" }, { "name": "UserId", "type": "string", "required": false, "description": "云存用户Id，为空则为默认云存空间。", "example": "username" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "ResetCloudStorageAIService", "description": "重置指定设备的云存 AI 服务", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品 ID", "example": "TQBDY6RPI9" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "cs_112114601_2" }, { "name": "ServiceType", "type": "string", "required": true, "description": "云存 AI 服务类型。可选值： - `RealtimeObjectDetect`：目标检测 - `Highlight`：视频浓缩", "example": "Highlight" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道 ID", "example": "0" }, { "name": "UserId", "type": "string", "required": false, "description": "用户 ID", "example": "user1" } ], "required": [ "ProductId", "DeviceName", "ServiceType" ] }, { "name": "ResetCloudStorageEvent", "description": "重置云存事件", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "TQBDY6RPI9" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "cs_112114601_2" }, { "name": "UserId", "type": "string", "required": false, "description": "用户ID", "example": "user1" }, { "name": "ChannelId", "type": "integer", "required": false, "description": "通道ID", "example": "1" } ], "required": [ "ProductId", "DeviceName" ] }, { "name": "ResetTWeCallDevice", "description": "重置设备", "status": "online", "parameters": [ { "name": "DeviceList", "type": "array", "required": false, "description": "设备列表", "example": "无", "item_type": "object", "children": [ { "name": "Sn", "type": "string", "required": true, "description": "Sn信息，SN格式：产品ID_设备名", "example": "productId_deviceName" } ] } ], "required": [] }, { "name": "ResumeWeCallDevice", "description": "恢复设备", "status": "online", "parameters": [ { "name": "DeviceList", "type": "array", "required": false, "description": "设备列表", "example": "无", "item_type": "object", "children": [ { "name": "Sn", "type": "string", "required": true, "description": "Sn信息，SN格式：产品ID_设备名", "example": "productId_deviceName" } ] } ], "required": [] }, { "name": "SearchPositionSpace", "description": "搜索位置空间", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": true, "description": "项目Id", "example": "prj-projectid" }, { "name": "SpaceName", "type": "string", "required": true, "description": "位置空间名字", "example": "name" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量，从0开始", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "最大获取数量", "example": "20" } ], "required": [ "ProjectId", "SpaceName", "Offset", "Limit" ] }, { "name": "SearchStudioProduct", "description": "提供根据产品名称查找产品的能力", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": false, "description": "项目ID", "example": "prj-zunfat46" }, { "name": "ProductName", "type": "string", "required": false, "description": "产品名称", "example": "testtproduct" }, { "name": "Limit", "type": "integer", "required": false, "description": "列表Limit", "example": "0" }, { "name": "Offset", "type": "integer", "required": false, "description": "列表Offset", "example": "0" }, { "name": "DevStatus", "type": "string", "required": false, "description": "产品Status", "example": "dev" }, { "name": "ProductId", "type": "string", "required": false, "description": "产品ID", "example": "FSDA213D" }, { "name": "Filters", "type": "array", "required": false, "description": "每次请求的Filters的上限为10，Filter.Values的上限为1。", "example": "NA", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段", "example": "tag:tag-key" }, { "name": "Values", "type": "array", "required": false, "description": "字段的过滤的一个或多个值", "example": "tag-value", "item_type": "string" } ] } ], "required": [] }, { "name": "SearchTopicRule", "description": "搜索规则", "status": "online", "parameters": [ { "name": "RuleName", "type": "string", "required": true, "description": "规则名", "example": "test_create" } ], "required": [ "RuleName" ] }, { "name": "TransferCloudStorage", "description": "转移云存服务", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "H541SOP191" }, { "name": "DeviceName", "type": "string", "required": true, "description": "已开通云存的设备名称", "example": "event_36502632_1" }, { "name": "ToDeviceName", "type": "string", "required": true, "description": "未开通云存的设备名称", "example": "event_36502632_2" }, { "name": "ToProductId", "type": "string", "required": false, "description": "未开通云存的设备产品ID", "example": "T6YxxxxS8F" } ], "required": [ "ProductId", "DeviceName", "ToDeviceName" ] }, { "name": "TransferTWeCallDevice", "description": "转移设备", "status": "online", "parameters": [ { "name": "TransferInDevice", "type": "string", "required": false, "description": "sn信息，product_deviceName", "example": "dev1" }, { "name": "TransferOutDevice", "type": "string", "required": false, "description": "sn信息，product_deviceName", "example": "dev2" } ], "required": [] }, { "name": "UnbindDevices", "description": "批量解绑子设备", "status": "online", "parameters": [ { "name": "GatewayProductId", "type": "string", "required": true, "description": "网关设备的产品ID", "example": "R42CRP5Rt" }, { "name": "GatewayDeviceName", "type": "string", "required": true, "description": "网关设备的设备名", "example": "gate1" }, { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "J2CRPPZ8J4" }, { "name": "DeviceNames", "type": "array", "required": true, "description": "设备名列表", "example": "[\"d12\"]", "item_type": "string" } ], "required": [ "GatewayProductId", "GatewayDeviceName", "ProductId", "DeviceNames" ] }, { "name": "UnbindProducts", "description": "批量解绑子产品。", "status": "online", "parameters": [ { "name": "GatewayProductId", "type": "string", "required": true, "description": "网关产品ID", "example": "5GH6PKLE" }, { "name": "ProductIds", "type": "array", "required": true, "description": "待解绑的子产品ID数组", "example": "[\"12OPF89HFE\"]", "item_type": "string" } ], "required": [ "GatewayProductId", "ProductIds" ] }, { "name": "UnbindTWeTalkAIBot", "description": "用于解除一个产品和智能体的绑定。", "status": "online", "parameters": [ { "name": "BotId", "type": "string", "required": true, "description": "智能体ID", "example": "bot-0vVbAeOMxU" }, { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "Q7MZK2V1QR" } ], "required": [ "BotId", "ProductId" ] }, { "name": "UpdateDeviceTWeCallAuthorizeStatus", "description": "更新用户对设备的TweCall授权状态", "status": "online", "parameters": [ { "name": "Status", "type": "integer", "required": false, "description": "TweCall授权状态：0未授权，1已授权", "example": "1" }, { "name": "ProductId", "type": "string", "required": false, "description": "产品ID", "example": "J2CRPPZ8J4" }, { "name": "DeviceName", "type": "string", "required": false, "description": "设备名", "example": "d1" }, { "name": "WechatOpenId", "type": "string", "required": false, "description": "微信用户的openId", "example": "wx12ed45tb" } ], "required": [] }, { "name": "UpdateDevicesEnableState", "description": "批量禁用启用设备", "status": "online", "parameters": [ { "name": "DevicesItems", "type": "array", "required": true, "description": "多个设备标识", "example": "无", "item_type": "object", "children": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品id", "example": "JZYTG1M2EN" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名称", "example": "dev01" } ] }, { "name": "Status", "type": "integer", "required": true, "description": "1：启用；0：禁用", "example": "1" } ], "required": [ "DevicesItems", "Status" ] }, { "name": "UpdateFirmware", "description": "本接口（UpdateFirmware）用于对指定设备发起固件升级请求", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "J2CRPPZ8J4" }, { "name": "DeviceName", "type": "string", "required": true, "description": "设备名", "example": "d1" }, { "name": "FirmwareVersion", "type": "string", "required": true, "description": "固件新的版本号", "example": "2.0.0" }, { "name": "FirmwareOriVersion", "type": "string", "required": true, "description": "固件原版本号", "example": "1.0.0" }, { "name": "UpgradeMethod", "type": "integer", "required": false, "description": "固件升级方式；0 静默升级 1 用户确认升级 不填默认静默升级", "example": "0" } ], "required": [ "ProductID", "DeviceName", "FirmwareVersion", "FirmwareOriVersion" ] }, { "name": "UpdateOtaModule", "description": "本接口（UpdateOtaModule）用于修改OTA模块", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "4ON538D9AX" }, { "name": "FwType", "type": "string", "required": true, "description": "模块类型", "example": "mcu" }, { "name": "Name", "type": "string", "required": false, "description": "模块类型名称", "example": "muc包" }, { "name": "Remark", "type": "string", "required": false, "description": "模块类型描述", "example": "这是一个描述" } ], "required": [ "ProductID", "FwType" ] }, { "name": "UpdateOtaTaskStatus", "description": "本接口（UpdateOtaTask）当固件升级大任务处于没有在全部成功的状态时，可修改为取消状态，取消部分或全部设备的升级;或其它允许的可修改的状态。", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "产品ID", "example": "ABCDE12345" }, { "name": "TaskId", "type": "integer", "required": true, "description": "固件升级任务ID", "example": "11236" }, { "name": "Status", "type": "integer", "required": true, "description": "固件任务取消状态", "example": "6" } ], "required": [ "ProductId", "TaskId", "Status" ] }, { "name": "UploadFirmware", "description": "本接口（UploadFirmware）用于创建设备固件版本信息，在平台用于固件版本升级、固件资源下发等。", "status": "online", "parameters": [ { "name": "ProductID", "type": "string", "required": true, "description": "产品ID", "example": "4ON538D9AX" }, { "name": "FirmwareVersion", "type": "string", "required": true, "description": "固件版本号", "example": "1.0.0" }, { "name": "Md5sum", "type": "string", "required": true, "description": "固件的MD5值", "example": "hfshfspodkoiwuidoiwjcuie" }, { "name": "FileSize", "type": "integer", "required": true, "description": "固件的大小", "example": "1024" }, { "name": "FirmwareName", "type": "string", "required": false, "description": "固件名称", "example": "dev_firmwarev1.0" }, { "name": "FirmwareDescription", "type": "string", "required": false, "description": "固件描述", "example": "version1.0固件" }, { "name": "FwType", "type": "string", "required": false, "description": "固件升级模块；可选值 mcu|moudule", "example": "mcu" }, { "name": "FirmwareUserDefined", "type": "string", "required": false, "description": "固件用户自定义配置信息", "example": "{\"key1\":\"value1\", \"key2\":\"支持中文\"}" } ], "required": [ "ProductID", "FirmwareVersion", "Md5sum", "FileSize" ] } ] }