Broadcasts messages to online devices of a product. You can specify all online devices or only the online devices that subscribe to a specified topic.
Usage notes
You can use the TopicFullName parameter in the request to specify the devices to which you want to broadcast messages. For more information, see the description about the TopicFullName parameter in this topic.
QPS limits
- Each Alibaba Cloud account can run only one query per second (QPS) to broadcast a message to devices that subscribe to a topic.
-
Each Alibaba Cloud account can run only one query per minute (QPM) to broadcast a message to all online devices of a product.Note The RAM users of an Alibaba Cloud account share the quota of the account.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | PubBroadcast |
The operation that you want to perform. Set the value to PubBroadcast. |
MessageContent | String | Yes | aGVsbG93b3JsZA |
The message body that you want to send. The maximum size of a message is 64 KB. To generate a message body, you must convert the raw message into binary data and perform Base64 encoding. |
ProductKey | String | Yes | aldeji3***** |
The ProductKey of the product to which the devices belong. A ProductKey is the unique identifier of a product in IoT Platform. You can view the information about all products within the current Alibaba Cloud account in the IoT Platform console or by calling the QueryProductList operation. |
IotInstanceId | String | No | iot_instc_pu****_c*-v64******** |
The ID of the instance. You can view the ID of the instance on the Overview page in the IoT Platform console. Notice
For more information, see Overview. |
TopicFullName | String | No | /broadcast/UPqSxj2vXXX/xxx |
The name of the topic. This parameter is optional.
Note
|
In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information, see Common parameters.
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Code | String | iot.system.SystemException |
The error code returned if the call fails. For more information, see Error codes. |
ErrorMessage | String | A system exception occurred. |
The error message returned if the request fails. |
MessageId | Long | 1234291569964771840 |
The message ID that is generated by IoT Platform when the message is sent. |
RequestId | String | BB71E443-4447-4024-A000-EDE09922891E |
The ID of the request. The ID is a unique identifier of the request. |
Success | Boolean | true |
Indicates whether the call was successful. Valid values:
|
Examples
Sample requests
https://iot.cn-shanghai.aliyuncs.com/?Action=PubBroadcast
&ProductKey=al**********
&TopicFullName=/broadcast/UPq****/xxx
&MessageContent=aGVsbG93b3JsZA
&<Common request parameters>
Sample success responses
XML
format
<PubBroadcastResponse>
<RequestId>BB71E443-4447-4024-A000-EDE09922891E</RequestId>
<MessageId>1234291569964771840</MessageId>
<Success>true</Success>
</PubBroadcastResponse>
JSON
format
{
"RequestId":"BB71E443-4447-4024-A000-EDE09922891E",
"MessageId":1234291569964771840,
"Success":true
}