1. 接口描述
接口请求域名： iotvideo.tencentcloudapi.com 。
同步调用设备行为
默认接口请求频率限制：5000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CallDeviceActionSync。 |
| Version | 是 | String | 公共参数，本接口取值：2021-11-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ProductId | 是 | String | 产品Id 示例值：TOIDHQ3AOQ |
| DeviceName | 是 | String | 设备名称 示例值：light1 |
| ActionId | 是 | String | 产品数据模板中行为功能的标识符，由开发者自行根据设备的应用场景定义 示例值：actid |
| InputParams | 否 | String | 输入参数 示例值：{"vol":3} |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ClientToken | String | 调用Id 注意：此字段可能返回 null，表示取不到有效值。 示例值：0fe1260b7a724b67ba873ca7df703e0d |
| OutputParams | String | 输出参数 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"brightness":1,"color":1,"light_switch":1} |
| Status | String | 返回状态，当设备不在线等部分情况，会通过该 Status 返回。 注意：此字段可能返回 null，表示取不到有效值。 示例值：succ |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 同步调用设备行为
输入示例
POST / HTTP/1.1
Host: iotvideo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CallDeviceActionSync
<公共请求参数>
{
"DeviceName": "xxx_76854689_1",
"InputParams": "{\"test_para1\":22}",
"ActionId": "test_action",
"ProductId": "L78xxxxZ95"
}输出示例
{
"Response": {
"RequestId": "ea5f6542-3a2e-4bf7-8cac-11907e0a72a0",
"ClientToken": "141812200::ea5f6542-3a2e-4bf7-8cac-11907e0a72a0",
"OutputParams": "{\"test_res_para1\":3,\"test_res_para2\":5}",
"Status": "success"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| UnsupportedOperation | 操作不支持。 |
