調用該接口向指定設備發送請求消息,并同步返回響應。
使用說明
調用該接口后,如果設備端未在設置的超時時間(Timeout)內做出反饋,即使設備收到了消息,云端也視消息為發送失敗。
QPS限制
單個阿里云賬號調用該接口的每秒請求數(QPS)最大限制為1000。
單個阿里云賬號下的所有RAM用戶共享該阿里云賬號的配額。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | RRpc | 系統規定參數。取值:RRpc。 |
ProductKey | String | 是 | aldfeSe**** | 要發送消息產品的ProductKey。 |
DeviceName | String | 是 | device1 | 要接收消息的設備名稱。 |
RequestBase64Byte | String | 是 | dGhpcyBpcyBhbiBleGFtcGxl | 要發送的消息內容。 您需要將消息原文轉換成二進制數據,并進行Base64編碼,從而生成消息內容。 說明
物聯網平臺會先對消息內容進行Base64解碼,再將解碼后的對應消息發送給設備。設備端無需進行Base64解碼。 |
Timeout | Integer | 是 | 1000 | 等待設備回復消息的時間,單位是毫秒,取值范圍是1,000 ~8,000。 |
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** | 實例ID。您可在物聯網平臺控制臺的實例概覽頁面,查看當前實例的ID。 重要
實例的更多信息,請參見實例概述。 |
Topic | String | 否 | /a1uZfYb****/A_Vol****/user/update | 使用自定義的RRPC相關Topic。需要設備端配合使用,請參見設備端開發自定義Topic。 不傳入此參數,則使用系統默認的RRPC Topic。 |
ContentType | String | 否 | 240 | 使用JT/T 808協議通信時,服務端向指定設備發送消息的類型。可取值:
物聯網平臺支持的JT/T 808協議詳細使用說明,請參見JT/T 808協議云網關概述。 |
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公共請求參數。公共請求參數說明,請參見公共參數文檔。
返回數據
名稱 |
類型 |
示例值 |
描述 |
Code | String | iot.system.SystemException | 調用失敗時,返回的錯誤碼。更多信息,請參見錯誤碼。 |
ErrorMessage | String | 系統異常 | 調用失敗時,返回的出錯信息。 |
MessageId | Long | 889455942124347392 | 成功發送請求消息后,云端生成的消息ID,用于標識該消息。 |
PayloadBase64Byte | String | d29ybGQgaGVsbG8= | 設備返回結果Base64編碼后的值。 |
RequestId | String | 41C4265E-F05D-4E2E-AB09-E031F501AF7F | 阿里云為該請求生成的唯一標識符。 |
RrpcCode | String | SUCCESS | 調用成功時,生成的調用返回碼,標識請求狀態。取值:
|
Success | Boolean | true | 是否調用成功。
|
示例
請求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=RRpc
&ProductKey=aldfeSe****
&DeviceName=device1
&RequestBase64Byte=dGhpcyBpcyBhbiBleGFtcGxl
&Timeout=1000
&<公共請求參數>
正常返回示例
XML
格式
<?xml version='1.0' encoding='UTF-8'?>
<RRpcResponse>
<RequestId>41C4265E-F05D-4E2E-AB09-E031F501AF7F<RequestId/>
<Success>true</Success>
<RrpcCode>SUCCESS</RrpcCode>
<PayloadBase64Byte>d29ybGQgaGVsbG8=</PayloadBase64Byte>
<MessageId>889455942124347392</MessageId>
</RRpcResponse>
JSON
格式
{
"RrpcCode":"SUCCESS",
"PayloadBase64Byte":"d29ybGQgaGVsbG8=",
"MessageId":889455942124347392,
"RequestId":"41C4265E-F05D-4E2E-AB09-E031F501AF7F",
"Success":true
}