Skip to content

Send Downlink Transparent Transmission Data

API Address:/v2/deviceshadow/r3/openapi/raw/sendData

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

API Description:Send downlink transparent transmission data to device. data is the specific content of the downlink data.

Request Example:

javascript
{
  "cacheTime": {},
  "data": {},
  "devices": [
    {
      "deviceKey": {},
      "productKey": {}
    }
  ],
  "encode": {},
  "isCache": {},
  "isCover": {},
  "qos": {}
}

Request Parameters:

Parameter NameParameter DescriptionRequest TypeRequiredData TypeSchema
sendDataDTOR3sendDataDTOR3bodytrueOpenApiSendDataDTOR3OpenApiSendDataDTOR3
  cacheTimeCache time in seconds. When isCache is true, if empty defaults to 10 minutesfalseobject
  dataSpecific content of the downlink data being senttrueobject
  devicesDevice listtruearrayDevicePrimaryKeyR2
    deviceKeyDevice deviceKeytrueobject
    productKeyProduct productKeytrueobject
  encodeMust specify data format Hex or Text (Hex: converts data or byte array to hexadecimal characters; (Example: binary content 0x1234AB (3 bytes) converted to string "1234AB" (6 bytes); string "1234AB" (6 bytes) converted to binary content 0x1234AB (3 bytes)😉 Text: will be sent in a certain encoding format, default UTF-8 encoding;) When Hex, data content consists of 0-9, A-F, a-f, length not exceeding 4096 characters, and character length must be even. When Text, does not exceed 4096 charactersfalseobject
  isCacheWhether to enable caching, default is false if not providedfalseobject
  isCoverWhether to overwrite previously sent data, default is false if not providedfalseobject
  qosQoS level setting (default is 1 if not provided)falseobject
languageLanguage: CN/EN (default: CN)queryfalsestring

Response Status:

Status CodeDescriptionSchema
200OKActionResult
201Created
401Unauthorized
403Forbidden
404Not Found
50000Service exception
50005Parameter check error
50007The deviceID, productKey or deviceKey is empty
61001PROTOCOL_NOT_SUPPORT
61002Device offline
61005Unauthorized device
61006Device message upper limit
61007Device message frequency is limited
70000Hub service unavailable
70026The sub-device is not connected to the gateway device
70051Failed data sending
70083Product category and parameter type are unmatched
70089You have limited permission to operate this project or product or device
70090The number is out of range or step size
70091The value is not a member of the enumeration
70092The text is too long
70093Incorrect time stamp character
70094The TSL model is unable to analyze and identify data
70095Failed to call cloudBridgeService
70096Failed to issue command from DMP to AEP
71008TSL data format verification error
71027TSL model downlink data format is not JSON
71028TSL model downlink data format verification error
71029Illegal downlink data setting for TSL model
71035Parameter verification error
71036TSL model data verification error
71038Failed communication. Read-only attributes can't send commands
71039The length of message array has exceeded the defined size
71047Downstream TSL data format check error
71048The fetch instruction cannot only contain write-only data
80005OpenAPI does not support setting AEP products
91001Token does not exist
91004Token incorrect
91005Doesn't have permission
91006User not in IP white list
91007Please enable API permission

Response Parameters:

Parameter NameParameter DescriptionTypeSchema
codeReturn codeobject
dataObjectobject
exp1string
msgPrompt messageobject
pageNumCurrent page numberobject
pageSizeItems per pageobject
pagesTotal pagesobject
totalTotal countobject

Response Example:

javascript
{
	"code": {},
	"data": {},
	"exp1": "",
	"msg": {},
	"pageNum": {},
	"pageSize": {},
	"pages": {},
	"total": {}
}