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

Envía un mensaje a varios dispositivos de un producto al mismo tiempo mediante un tema personalizado.

Notas de uso

Una sola llamada permite enviar un mensaje hasta a 100 dispositivos del mismo producto.
BatchPub no permite establecer propiedades ni invocar servicios. Para establecer propiedades, llame a SetDeviceProperty o a SetDevicesProperty. Para invocar servicios, llame a InvokeThingService o a InvokeThingsService.

Límites de QPS

Cada cuenta puede llamar a esta operación hasta 50 veces por segundo.

Nota

Los usuarios 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 mayor comodidad, se recomienda llamar a esta operación desde OpenAPI Explorer, ya que genera dinámicamente el código de ejemplo para distintos SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	BatchPub	Operación que desea ejecutar. Establezca el valor en BatchPub.
DeviceName.N	RepeatList	Sí	newdevice1	El DeviceName del dispositivo al que desea enviar el mensaje. Nota Este parámetro se utiliza junto con el parámetro ProductKey. Los dispositivos especificados deben pertenecer al mismo producto. En una sola solicitud se pueden especificar como máximo 100 nombres de dispositivo. Cada nombre debe ser único.
MessageContent	String	Sí	eyJ0ZXN0IjoidGFzayBiYXRjaHB1YiBicm9hZGNhc3QifQ==	Cuerpo del mensaje. El tamaño máximo es de 256 KB. Convierta el mensaje original en datos binarios y codifíquelo en Base64. Nota IoT Platform decodifica los datos en Base64 antes de enviarlos al dispositivo, por lo que este no necesita decodificarlos.
ProductKey	String	Sí	a1BwAGV****	El ProductKey del producto al que pertenece el dispositivo.
TopicShortName	String	Sí	get	Sufijo del tema personalizado. El nombre de un tema personalizado sigue el formato: `/${productKey}/${deviceName}/user/${TopicShortName}`. ${TopicShortName} indica el sufijo. Nota El tema debe tener el permiso Subscribe o los permisos Publish y Subscribe. Compruebe que todos los dispositivos especificados estén suscritos al tema. Consulte los temas personalizados mediante los siguientes métodos: En la pestaña Topic Categories de la página de detalles del producto, consulte los temas personalizados del producto. En la pestaña Topic List de la página de detalles del dispositivo, consulte los temas personalizados a los que está suscrito el dispositivo. Llame a la operación QueryProductTopic para consultar los temas personalizados del producto.
IotInstanceId	String	No	iot-cn-0pp1n8t****	ID de la instancia. Consulte el ID 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 la página Overview o el ID de la instancia no se muestran en la consola de IoT Platform, no es necesario especificar este parámetro. Para obtener más información, consulte Descripción general.
Qos	Integer	No	0	Nivel de calidad de servicio (QoS) del mensaje. Valores válidos: 0: el mensaje se envía como máximo una vez. 1: el mensaje se envía como mínimo una vez. Valor predeterminado: 0. Nota IoT Platform almacena los mensajes QoS 1 durante un máximo de siete días. Los mensajes QoS 0 no se almacenan.

Además de los parámetros específicos de esta operación, debe especificar los parámetros de solicitud comunes al llamarla. 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	Código de error devuelto si la solicitud finalizó con errores. Para obtener más información, consulte Códigos de error.
ErrorMessage	String	A system exception occurred.	Mensaje de error devuelto si la solicitud finalizó con errores.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID de la solicitud.
Success	Boolean	true	Indica si la solicitud fue exitosa. Valores válidos: true false

Ejemplos

Solicitudes de ejemplo

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=BatchPub
&DeviceName.1=newdevice1
&MessageContent=eyJ0ZXN0IjoidGFzayBiYXRjaHB1YiBicm9hZGNhc3QifQ==
&ProductKey=a1BwAGV****
&TopicShortName=get
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<BatchPubResponse>
  <RequestId>9E76053E-26ED-4AB4-AE58-8AFC3F1E7E8E</RequestId>
  <Success>true</Success>
</BatchPubResponse>

Formato JSON

{
  "RequestId": "9E76053E-26ED-4AB4-AE58-8AFC3F1E7E8E",
  "Success": true
}

Códigos de error

Para consultar la lista de códigos de error, visite Códigos de error del servicio.