下发广播消息
功能介绍
应用服务器可调用此接口向订阅了指定Topic的所有在线设备发布广播消息。应用将广播消息下发给平台后,平台会先返回应用响应结果,再将消息广播给设备。 注意:
此接口只适用于使用MQTT协议接入的设备。
调用方法
请参见如何调用API。
URI
POST /v5/iot/{project_id}/broadcast-messages
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数说明:项目ID。获取方法请参见 获取项目ID 。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 |
Instance-Id |
否 |
String |
参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考查看实例详情 。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
app_id |
否 |
String |
参数说明:资源空间ID。此参数为非必选参数,存在多资源空间的用户需要使用该接口时,建议携带该参数指定广播消息所属的资源空间,否则广播消息将会向默认资源空间下订阅指定topic的设备发送。 取值范围:长度不超过36,只允许字母、数字、下划线(_)、连接符(-)的组合。 |
topic_full_name |
是 |
String |
参数说明:接收广播消息的完整Topic名称, 必选。用户需要发布广播消息给设备时,可以使用该参数指定完整的topic名称,物联网平台会向指定资源空间下订阅了该topic的所有在线设备发送消息。广播的topic无需控制台创建,但topic的前缀必须为$oc/broadcast/ 最大长度:128 |
message |
是 |
String |
参数说明:广播消息的内容,用户需要将消息原文使用Base64编码。请求参数体最大长度为256KB。 最大长度:261848 |
ttl |
否 |
Integer |
参数说明:广播消息在平台缓存的老化时间,时间单位是分钟,默认值为0, 即默认不缓存消息;ttl>0时表示缓存消息,ttl参数数值必须是5的倍数,即以5分钟为粒度,默认最大缓存时间为1440分钟,指定的缓存时间超过1440分钟需申请,否则下发失败;ttl>0时,一个topic订阅设备数限制为10,如果一个topic订阅设备数超过10,则接口返回错误。 最小值:0 最大值:10080 缺省值:0 |
message_id |
否 |
String |
参数说明:消息id,由用户生成(推荐使用UUID)。ttl> 0时,平台会缓存消息,需确保message_id是唯一的, 否则接口返回错误。 取值范围:默认最大长度为100,超过需申请,只允许字母、数字、下划线(_)、连接符(-)的组合。 最大长度:128 |
响应参数
状态码: 201
参数 |
参数类型 |
描述 |
---|---|---|
app_id |
String |
参数说明:资源空间ID。 |
topic_full_name |
String |
参数说明:接收广播消息的完整Topic名称 最大长度:128 |
message_id |
String |
消息id,由物联网平台生成,用于标识该消息。 |
created_time |
String |
消息的创建时间,"yyyyMMdd'T'HHmmss'Z'"格式的UTC字符串。 |
请求示例
下发广播消息。
POST https://{endpoint}/v5/iot/{project_id}/broadcast-messages { "topic_full_name" : "$oc/broadcast/test", "message" : "SGVsbG9Xb3JsZA==" }
响应示例
状态码: 201
Created
{ "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "topic_full_name" : "$oc/broadcast/test", "message_id" : "b1224afb-e9f0-4916-8220-b6bab568e888", "created_time" : "20151212T121212Z" }
SDK代码示例
SDK代码示例如下。
Java
下发广播消息。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.AbstractCredentials; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.iotda.v5.region.IoTDARegion; import com.huaweicloud.sdk.iotda.v5.*; import com.huaweicloud.sdk.iotda.v5.model.*; public class BroadcastMessageSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withDerivedPredicate(AbstractCredentials.DEFAULT_DERIVED_PREDICATE) // Used in derivative ak/sk authentication scenarios .withAk(ak) .withSk(sk); IoTDAClient client = IoTDAClient.newBuilder() .withCredential(auth) .withRegion(IoTDARegion.valueOf("<YOUR REGION>")) .build(); BroadcastMessageRequest request = new BroadcastMessageRequest(); DeviceBroadcastRequest body = new DeviceBroadcastRequest(); body.withMessage("SGVsbG9Xb3JsZA=="); body.withTopicFullName("$oc/broadcast/test"); request.withBody(body); try { BroadcastMessageResponse response = client.broadcastMessage(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
下发广播消息。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcore.auth.credentials import DerivedCredentials from huaweicloudsdkiotda.v5.region.iotda_region import IoTDARegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkiotda.v5 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ .with_derived_predicate(DerivedCredentials.get_default_derived_predicate()) \ client = IoTDAClient.new_builder() \ .with_credentials(credentials) \ .with_region(IoTDARegion.value_of("<YOUR REGION>")) \ .build() try: request = BroadcastMessageRequest() request.body = DeviceBroadcastRequest( message="SGVsbG9Xb3JsZA==", topic_full_name="$oc/broadcast/test" ) response = client.broadcast_message(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
下发广播消息。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" iotda "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/iotda/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/iotda/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/iotda/v5/region" core_auth "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithDerivedPredicate(core_auth.GetDefaultDerivedPredicate()). // Used in derivative ak/sk authentication scenarios Build() client := iotda.NewIoTDAClient( iotda.IoTDAClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.BroadcastMessageRequest{} request.Body = &model.DeviceBroadcastRequest{ Message: "SGVsbG9Xb3JsZA==", TopicFullName: "$oc/broadcast/test", } response, err := client.BroadcastMessage(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
201 |
Created |
400 |
Bad Request |
403 |
Forbidden |
500 |
Internal Server Error |
错误码
请参见错误码。