調用該接口向指定產品下在線設備發布廣播消息。在線設備可指定為所有在線設備或訂閱了指定Topic的在線設備。
使用說明
您可通過設置請求參數中TopicFullName值決定廣播消息的對象:指定產品下所有在線設備或訂閱了指定Topic的在線設備。廣播Topic使用說明,請參見下文TopicFullName描述。
QPS限制
- 指定Topic訂閱廣播,單個阿里云賬號調用該接口的每秒請求數(QPS)最大限制為1。
- 全量在線設備廣播,單個阿里云賬號調用該接口的每分鐘內請求數(QPM)最大限制為1。
單個阿里云賬號下的所有RAM用戶共享該阿里云賬號的配額。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | PubBroadcast | 系統規定參數。取值:PubBroadcast。 |
MessageContent | String | 是 | aGVsbG93b3JsZA | 要發送的消息內容,最大報文64 KB。 您需要將消息原文轉換成二進制數據,并進行Base64編碼,從而生成消息內容。 說明
物聯網平臺會先對消息內容進行Base64解碼,再將解碼后的對應消息發送給設備。設備端無需進行Base64解碼。 |
ProductKey | String | 是 | aldeji3***** | 要發送廣播消息的產品的ProductKey。 ProductKey是物聯網平臺為產品頒發的全局唯一標識符。您可以在物聯網平臺控制臺或調用QueryProductList,查看當前賬號下所有產品的信息。 |
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** | 實例ID。您可在物聯網平臺控制臺的實例概覽頁面,查看當前實例的ID。 重要
實例的更多信息,請參見實例概述。 |
TopicFullName | String | 否 | /broadcast/UPqSxj2vXXX/xxx | 可選參數:
說明
|
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公共請求參數。公共請求參數說明,請參見公共參數文檔。
返回數據
名稱 |
類型 |
示例值 |
描述 |
Code | String | iot.system.SystemException | 調用失敗時,返回的錯誤碼。更多信息,請參見錯誤碼。 |
ErrorMessage | String | 系統異常 | 調用失敗時,返回的出錯信息。 |
MessageId | Long | 1234291569964771840 | 成功發送消息后,云端生成的消息ID,用于標識該消息。 |
RequestId | String | BB71E443-4447-4024-A000-EDE09922891E | 阿里云為該請求生成的唯一標識符。 |
Success | Boolean | true | 是否調用成功。
|
示例
請求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=PubBroadcast
&ProductKey=al**********
&TopicFullName=/broadcast/UPq****/xxx
&MessageContent=aGVsbG93b3JsZA
&<公共請求參數>
正常返回示例
XML
格式
<PubBroadcastResponse>
<RequestId>BB71E443-4447-4024-A000-EDE09922891E</RequestId>
<MessageId>1234291569964771840</MessageId>
<Success>true</Success>
</PubBroadcastResponse>
JSON
格式
{
"RequestId":"BB71E443-4447-4024-A000-EDE09922891E",
"MessageId":1234291569964771840,
"Success":true
}