发布广播消息

最近更新时间:2024-03-12 01:34:15

我的收藏

1. 接口描述

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

发布广播消息

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:PublishBroadcastMessage。
Version String 公共参数,本接口取值:2019-04-23。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-guangzhou, ap-shanghai, ap-shanghai-fsi, eu-frankfurt, na-ashburn 。
ProductId String 产品ID
示例值:LK7LIPL6GE
Payload String 消息内容
示例值:1234561
Qos Integer 消息质量等级
示例值:1
PayloadEncoding String ayload内容的编码格式,取值为base64或空。base64表示云端将收到的请求数据进行base64解码后下发到设备,空则直接将原始内容下发到设备
示例值:base64

3. 输出参数

参数名称 类型 描述
TaskId Integer 广播消息任务Id
示例值:100523
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 发布广播消息

输入示例

https://iotexplorer.tencentcloudapi.com/?Action=PublishBroadcastMessage
&ProductId=LK7LIPL6GE
&Payload=123456
&Qos=1
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "be69a7a3-7315-40a7-9532-3316e4a3e97e",
        "TaskId": 1000523
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.BroadcastTaskIsRunning 广播任务正在执行。
InternalError.InternalRPCError 内部RPC错误。
InvalidParameterValue.PayloadOverLimit 消息Payload超出限制。
ResourceNotFound.ProductNotExist 产品不存在。
ResourceNotFound.StudioProductNotExist 产品不存在。
UnsupportedOperation 操作不支持。