1. 接口描述
接口请求域名： iotexplorer.tencentcloudapi.com 。
批量设备透传指令控制
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：BatchPublishMessage。 |
| Version | 是 | String | 公共参数，本接口取值：2019-04-23。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| ProductId | 是 | String | 产品名称 示例值：XXV7WNTR4F |
| DeviceNames.N | 是 | Array of String | 设备名称 示例值：["dev_1"] |
| Topic | 是 | String | 主题 示例值：XXV7WNTR4F/${deviceName}/data |
| Payload | 是 | String | 消息体 示例值：hello |
| Qos | 否 | Integer | 服务质量 示例值：1 |
| PayloadEncoding | 否 | String | 消息体编码 示例值：base64 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 批量推送总数 示例值：4 |
| SuccessCount | Integer | 成功数量 示例值：3 |
| Failures | Array of DeviceResult | 失败明细 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 透传Payload批量下发至设备
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BatchPublishMessage
<公共请求参数>
{
"ProductId": "XXV7WNTR4F",
"DeviceNames": [
"dev_1"
],
"Topic": "XXV7WNTR4F/${deviceName}/data",
"Payload": "hello"
}输出示例
{
"Response": {
"Failures": [
{
"DeviceName": "dev_4",
"ErrCode": 23102,
"ErrMsg": "push: device offline (qos0): push: device unreachable",
"Status": "OFFLINE"
}
],
"SuccessCount": 3,
"Total": 4,
"RequestId": "d6120860-b5a0-4cb7-a0a7-8de054461ef3"
}
}示例2 将接收到的经过业务系统base64编码后的Payload进行二进制编码后批量下发至设备
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BatchPublishMessage
<公共请求参数>
{
"ProductId": "XXV7WNTR4F",
"DeviceNames": [
"dev_1"
],
"Topic": "XXV7WNTR4F/${deviceName}/data",
"Payload": "MQ==",
"Qos": 1,
"PayloadEncoding": "base64"
}输出示例
{
"Response": {
"Failures": [],
"SuccessCount": 2,
"Total": 2,
"RequestId": "5522bd8b-d860-45c3-86cb-0c829fabaace"
}
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded.DeviceLimitExceeded | 设备数量超出限制 |
| ResourceNotFound.DeviceNotExist | 设备不存在。 |
| ResourceNotFound.ProductNotExist | 产品不存在。 |
| UnauthorizedOperation.AccountRestricted | 账号被限制调用该接口 |
| UnauthorizedOperation.ProductACLDenied | 无该产品操作权限。 |
