PubBroadcast_物联网平台_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

使用说明

您可通过设置请求参数TopicFullName 值决定广播消息的对象:指定产品下所有在线设备或订阅了指定 Topic 的在线设备。广播 Topic 使用说明,请参见下文 TopicFullName 描述。

QPS 限制

  • 指定 Topic 订阅广播,单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为 1。

  • 全量在线设备广播,单个阿里云账号调用该接口的每分钟内请求数(QPM)最大限制为 1。

    说明 RAM 用户共享阿里云账号配额。

流控信息

当前云产品API请求速率暂未透出。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
IotInstanceIdstring

实例 ID。您可在物联网平台控制台的实例概览页面,查看当前实例的 ID展开详情

示例值:iot_instc_pu****_c*-v64********
ProductKeystring

要发送广播消息的产品的 ProductKey展开详情

示例值:aldeji3*****参考取值来源:
    CreateProduct
    QueryProductList
    ReleaseProduct
    ListProductByTags
    BindLicenseProduct
    BatchBindProductsIntoProject
TopicFullNamestring

可选参数:展开详情

示例值:/broadcast/UPqSxj2vXXX/xxx
MessageContentstring

要发送的消息主体,最大报文 64 KB。展开详情

示例值:aGVsbG93b3JsZA

请求说明

调用 API 时,除了本文介绍的该 API 的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回参数

字段名称字段详情
Codestring

调用失败时,返回的错误码。更多信息,请参见错误码

示例值:iot.system.SystemException
MessageIdinteger<int64>

成功发送消息后,云端生成的消息 ID,用于标识该消息。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:1234291569964771840
ErrorMessagestring

调用失败时,返回的出错信息。

示例值:系统异常
RequestIdstring

阿里云为该请求生成的唯一标识符。

示例值:BB71E443-4447-4024-A000-EDE09922891E
Successboolean

是否调用成功。展开详情

示例值:true

返回示例

变更历史

暂无变更历史