同步调用设备行为

1. 接口描述

接口请求域名： iotexplorer.tencentcloudapi.com 。

为用户提供同步调用设备行为的能力。

默认接口请求频率限制：200次/秒。

2. 输入参数

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

3. 输出参数

4. 示例

示例1 同步调用设备行为

云端调用后，设备端上报$thing/up/action/TOIDHQ3AOQ/light1

{
    "method": "action_reply",
    "clientToken": "0fe1260b7a724b67ba873ca7df703e0d",
    "code": 0,
    "response": { "brightness": 1, "color": 1, "light_switch": 1 },
    "status": "succ"
}

输入示例

POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CallDeviceActionSync
<公共请求参数>

{
    "DeviceName": "light1",
    "InputParams": "{\"vol\":3}",
    "ActionId": "actid",
    "ProductId": "TOIDHQ3AOQ"
}

输出示例

{
    "Response": {
        "ClientToken": "0fe1260b7a724b67ba873ca7df703e0d",
        "OutputParams": "{\"brightness\":1,\"color\":1,\"light_switch\":1}",
        "RequestId": "235fe48b-0c31-4a7c-aaf6-83ba3e9s4bcf",
        "Status": "succ"
    }
}

示例2 同步调用设备行为，设备超时

当设备响应时间过长时，设备返回情况如样例所示。

输入示例

POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CallDeviceActionSync
<公共请求参数>

{
    "DeviceName": "light1",
    "InputParams": "{\"brightness\":3}",
    "ActionId": "actid",
    "ProductId": "TOIDHQ3AOQ"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "FailedOperation.Timeout",
            "Message": "调用超时"
        },
        "RequestId": "b1de7dcf-5029-4d70-b6b5-d1ad0f785552"
    }
}

示例3 同步调用设备行为，设备不在线。

当设备不在线或未订阅相关 topic 时，设备返回情况如样例所示。

输入示例

POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CallDeviceActionSync
<公共请求参数>

{
    "DeviceName": "light1",
    "InputParams": "{\"brightness\":3}",
    "ActionId": "actid",
    "ProductId": "TOIDHQ3AOQ"
}

输出示例

{
    "Response": {
        "ClientToken": "",
        "OutputParams": "",
        "RequestId": "b2621fc1-d6d9-4929-af0b-3fb0e919658a",
        "Status": "FailedOperation.ActionUnreachable|动作消息不可达"
    }
}

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

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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