PubBroadcast - IoT Platform

使用說明

您可通過設定請求參數中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。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
TopicFullName	String	否	/broadcast/UPqSxj2vXXX/xxx	選擇性參數：不賦值，表示全量線上裝置廣播，推送訊息到指定ProductKey的全量線上裝置。裝置端收到的廣播Topic格式為`/sys/${productKey}/${deviceName}/broadcast/request/${MessageId}`，其中MessageId由物聯網平台產生。賦值，表示指定Topic訂閱廣播，推送訊息到指定ProductKey的已訂閱廣播Topic的線上裝置。傳入要接收廣播訊息的Topic全稱，格式為：`/broadcast/${productKey}/自訂欄位`。其中，${productKey}是要接收廣播訊息的具體產品ProductKey；自訂欄位中您可以指定任意欄位。說明廣播Topic是在裝置開發時編碼定義的，無需控制台建立。一個廣播Topic最多可被1,000個裝置訂閱。如果您的裝置超過數量限制，您可以對裝置進行分組。例如，如果您有5,000個裝置，您可以將裝置按每組1,000個，而分成5組。您需要分5次調用廣播Topic，自訂欄位分別設定為group1、group2、group3、group4、group5，然後讓每組裝置分別訂閱各自分組的廣播Topic。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公用請求參數。公用請求參數說明，請參見公用參數文檔。

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
MessageId	Long	1234291569964771840	成功發送訊息後，雲端產生的訊息ID，用於標識該訊息。
RequestId	String	BB71E443-4447-4024-A000-EDE09922891E	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。