PubBroadcast - IoT Platform - Centro de documentación de Alibaba Cloud

Transmite un mensaje a los dispositivos en línea de un producto. Puede especificar todos los dispositivos en línea o únicamente aquellos suscritos a un topic específico.

Notas de uso

Configure TopicFullName en la solicitud para indicar los dispositivos a los que desea transmitir el mensaje. Para obtener más información, consulte la descripción del parámetro TopicFullName en este tema.

Límites de QPS

Esta operación se puede invocar hasta 1 vez por segundo por cuenta para transmitir un mensaje a los dispositivos en línea suscritos a un topic específico.
Esta operación se puede invocar hasta 1 vez por minuto por cuenta para transmitir un mensaje a todos los dispositivos en línea de un producto.

Nota

Los usuarios de Resource Access Management (RAM) de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda invocar esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	PubBroadcast	La operación que se va a ejecutar. Establezca el valor en PubBroadcast.
MessageContent	String	Sí	aGVsbG93b3JsZA	El contenido del mensaje que desea enviar. El tamaño del mensaje no puede superar los 64 KB. Para generar el contenido del mensaje, convierta el mensaje original en datos binarios y aplique la codificación Base64. Nota IoT Platform decodifica los datos mediante el algoritmo Base64 y luego envía el mensaje decodificado al dispositivo. De este modo, el dispositivo no necesita decodificar los datos codificados en Base64.
ProductKey	String	Sí	aldeji3*	La clave ProductKey del producto al que pertenecen los dispositivos. La clave ProductKey es un identificador único que IoT Platform asigna al producto. Puede consultar la información de todos los productos de la cuenta actual de Alibaba Cloud en la consola de IoT Platform o mediante la operación QueryProductList.
IotInstanceId	String	No	iot_instc_pu*_c-v64	El ID de la instancia. Puede consultar el ID de la instancia en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe especificar este parámetro. De lo contrario, la solicitud fallará. Si no se ha generado ninguna página Overview ni ningún ID para su instancia, no es necesario especificar este parámetro. Para obtener más información, consulte Overview.
TopicFullName	String	No	/broadcast/UPqSxj2vXXX/xxx	El nombre del topic. Si no especifica este parámetro, el mensaje se envía a todos los dispositivos en línea que tienen la clave ProductKey indicada. Los dispositivos reciben el mensaje desde el topic de broadcast con el siguiente formato: `/sys/${productKey}/${deviceName}/broadcast/request/${MessageId}`. La variable MessageId la genera IoT Platform. Si especifica este parámetro, el mensaje se envía a los dispositivos que tienen la clave ProductKey indicada y están suscritos al topic especificado. Debe definir un topic de broadcast con la siguiente sintaxis: `/broadcast/${productKey}/Campo personalizado`. Reemplace ${productKey} con la clave ProductKey de los dispositivos que recibirán el mensaje. En el campo personalizado, puede establecer un valor según sus necesidades empresariales. Nota Al desarrollar dispositivos, solo necesita escribir código para definir un topic de broadcast. No es necesario crear un topic en la consola de IoT Platform. Un máximo de 1,000 dispositivos pueden suscribirse a un topic de broadcast. Si la cantidad de dispositivos supera el límite, puede dividirlos en grupos. Por ejemplo, puede dividir 5,000 dispositivos en 5 grupos, donde cada grupo contenga 1,000 dispositivos. En este caso, debe invocar la operación PubBroadcast cinco veces. En cada invocación, establezca el campo personalizado del topic de broadcast como group1, group2, group3, group4 y group5. Asegúrese de que cada grupo de dispositivos esté suscrito al topic de broadcast correspondiente.

Además de los parámetros de solicitud específicos de la operación mencionados anteriormente, debe especificar los parámetros de solicitud comunes al invocar esta operación. Para obtener más información, consulte Parámetros comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error devuelto si la solicitud falla. Para obtener más información, consulte la sección Códigos de error de este tema.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la solicitud falla.
MessageId	Long	1234291569964771840	El ID del mensaje que genera IoT Platform cuando se envía el mensaje.
RequestId	String	BB71E443-4447-4024-A000-EDE09922891E	El ID de la solicitud.
Success	Boolean	true	Indica si la solicitud se completó correctamente. Valores válidos: true false

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=PubBroadcast
&ProductKey=al**********
&TopicFullName=/broadcast/UPq****/xxx
&MessageContent=aGVsbG93b3JsZA
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<PubBroadcastResponse>
        <RequestId>BB71E443-4447-4024-A000-EDE09922891E</RequestId>
        <MessageId>1234291569964771840</MessageId>
        <Success>true</Success>
  </PubBroadcastResponse>

Formato JSON

{
      "RequestId":"BB71E443-4447-4024-A000-EDE09922891E",
      "MessageId":1234291569964771840,
      "Success":true
}

Códigos de error

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.