PubBroadcast - IoT Platform: Central de Documentação do Alibaba Cloud

Transmite uma mensagem para dispositivos online de um produto. Especifique todos os dispositivos online ou apenas aqueles inscritos em um tópico específico.

Observações de uso

Defina TopicFullName na solicitação para indicar os dispositivos que receberão a transmissão da mensagem. Para mais detalhes, consulte a descrição do parâmetro TopicFullName neste tópico.

Limites de QPS

Chame esta operação até 1 vez por segundo por conta para transmitir mensagens a dispositivos online inscritos em um tópico específico.
Chame esta operação até 1 vez por minuto por conta para transmitir mensagens a todos os dispositivos online de um produto.

Nota

Os usuários do Resource Access Management (RAM) de uma conta Alibaba Cloud compartilham a cota dessa conta.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	PubBroadcast	A operação a ser executada. Defina o valor como PubBroadcast.
MessageContent	String	Sim	aGVsbG93b3JsZA	O conteúdo da mensagem a ser enviado. O tamanho da mensagem não pode exceder 64 KB. Para gerar o conteúdo da mensagem, converta a mensagem original em dados binários e aplique a codificação Base64. Nota O IoT Platform decodifica os dados com o algoritmo Base64 e envia a mensagem decodificada ao dispositivo. Assim, o dispositivo não precisa decodificar os dados em Base64.
ProductKey	String	Sim	aldeji3*	A ProductKey do produto ao qual os dispositivos pertencem. A ProductKey é um identificador exclusivo emitido pelo IoT Platform para o produto. Visualize as informações de todos os produtos da conta Alibaba Cloud atual no console do IoT Platform ou chame a operação QueryProductList.
IotInstanceId	String	Não	iot_instc_pu*_c-v64	O ID da instância. Consulte o ID da instância na página Overview do console do IoT Platform. Importante Se sua instância tiver um ID, especifique este parâmetro. Caso contrário, a solicitação falhará. Se não houver uma página Overview ou ID gerado para sua instância, não especifique este parâmetro. Para mais informações, consulte Overview.
TopicFullName	String	Não	/broadcast/UPqSxj2vXXX/xxx	O nome do tópico. Se você não especificar este parâmetro, a mensagem será enviada para todos os dispositivos online com a ProductKey indicada. Os dispositivos recebem a mensagem do tópico de broadcast no seguinte formato: `/sys/${productKey}/${deviceName}/broadcast/request/${MessageId}`. A variável MessageId é gerada pelo IoT Platform. Se você especificar este parâmetro, a mensagem será enviada apenas aos dispositivos que possuem a ProductKey indicada e estão inscritos no tópico especificado. Use a seguinte sintaxe para o tópico de broadcast: `/broadcast/${productKey}/Campo personalizado`. Substitua ${productKey} pela ProductKey dos dispositivos destinatários. No campo personalizado, defina um valor conforme suas necessidades de negócio. Nota Durante o desenvolvimento dos dispositivos, basta escrever o código para definir um tópico de broadcast. Não é preciso criar o tópico no console do IoT Platform. Um tópico de broadcast aceita no máximo 1.000 dispositivos inscritos. Se a quantidade ultrapassar esse limite, divida os dispositivos em grupos. Por exemplo, organize 5.000 dispositivos em 5 grupos de 1.000 cada. Nesse cenário, chame a operação PubBroadcast cinco vezes. Em cada chamada, defina o campo personalizado do tópico como group1, group2, group3, group4 e group5. Garanta que cada grupo de dispositivos esteja inscrito no tópico de broadcast correspondente.

Além dos parâmetros específicos da operação listados acima, inclua os parâmetros comuns de solicitação ao chamar esta API. Consulte Parâmetros comuns para mais detalhes.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Code	String	iot.system.SystemException	Código de erro retornado em caso de falha na solicitação. Para mais informações, consulte a seção Códigos de erro deste tópico.
ErrorMessage	String	A system exception occurred.	Mensagem de erro retornada quando a solicitação falha.
MessageId	Long	1234291569964771840	ID da mensagem gerado pelo IoT Platform durante o envio.
RequestId	String	BB71E443-4447-4024-A000-EDE09922891E	O ID da solicitação.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida. Valores válidos: true false

Exemplos

Exemplos de solicitações

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

Exemplos de respostas de sucesso

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 erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.