Get started
  • English
  • 简体中文
Official Site
Get started
  • English
  • 简体中文
Official Site
  • Get started
  • Concepts
  • Guides
  • Device capabilities & events
    • Browse by device type
    • Device capabilities
      • Common methods
      • Detection and alarms
      • Image
      • PTZ
      • Light
      • Recording
      • Audio
      • Media
      • Network
      • Power
      • Privacy
      • Call
      • Storage
      • System
      • Algorithm
      • Maintenance
      • Control
        • Infrared remote
          • control.ir.studyFailed (IR learning failed)
          • control.ir.send (Get IR transmit property)
          • control.ir.studyCode (Get learned IR code property)
          • control.ir.studyEnabled (Get IR learning switch property)
          • control.ir.send (Set IR transmit property)
          • control.ir.studyEnabled (Set IR learning switch property)
        • Outlet and switching
        • Travel motor
        • Lock actuator
    • Events overview
    • Permission codes
    • Capability error codes
    • Alarm and capability messages
    • Capability FAQ
    • Legacy ability and push types
  • API reference
  • SDK and tools
  • Solutions
  • Platform and support
On this page
What it does
Request URL
Minimum permission
Request parameters
Request example
Response data fields
Response example
Error codes

control.ir.send (Get IR transmit property)

control.ir.send: Get IR transmit property

control.ir.send · device scope · permission Config

What it does

Reads the IR transmit payload.

Request URL

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.property.get

Minimum permission

The administrator does not need an extra permission on a device they bound. A shared device needs the basic configuration permission. A bound sub-user does not. A sub-account needs Config. Do not send channelId on device-scope capabilities. Mixing device and channel properties in one request returns DV2008.

Request parameters

NameTypeRequiredDescription
tokenStringyesAccess token for an administrator, sub-user, or sub-account
deviceIdStringyesDevice serial number
productIdStringnoOptional. If sent and it does not match the device model → DV2009
propertiesArrayyes["control.ir.send"]

For common request fields and signing, see Signing conventions and Common request payload.

Request example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system": {
 "ver": "1.0",
 "appId": "lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time": 1706511734,
 "nonce": "f5a1ae2d-c09c-4d39-a744-83a5c2c653c2"
 },
 "params": {
 "token": "<yourAccessToken>",
 "deviceId": "TESTIPC000012345",
 "properties": [
 "control.ir.send"
 ]
 }
}

Response data fields

The value is in result.data.properties["control.ir.send"].

NameDescriptionTypeRequiredValues
typeCode formatenumyes0 raw; 1 compressed; 2 custom
ircodeIR codetextyesString
paramsRemote control parameterstextyesString
verifyCodeVerification codetextyesString

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "properties": {
 "control.ir.send": {
 "type": "0",
 "ircode": "example",
 "params": "example",
 "verifyCode": "example"
 }
 }
 }
 }
}

Error codes

CodeMeaningNext step
SN1001Signature errorCheck sign per Development specification
TK1002Token invalid or expiredRefresh accessToken
OP1002Missing required parameterAdd required fields
OP1003Invalid parameterMatch this page’s parameter table
OP1009Permission deniedCheck token and device bind/share grants
OP1013Total call limit exceededReduce call rate
OP1014Daily per-interface limit exceededSee Interface call limits
DV1007Device offlineWait until the device is online

See Return codes · OP/SN/TK for the full catalog.

CodeMeaningNext step
DV2003Property not on deviceUse device.capability.list
DV2004Value out of rangeCheck properties values
DV2007channelId vs scope mismatchRequired for channel scope; omit for device scope
DV2008Mixed device and channel propertiesSplit the request
DV2009productId mismatchOmit or set actual model id

See Capability errors.

Set IR transmit property · Infrared remote

control.ir.studyFailed (IR learning failed)
control.ir.studyCode (Get learned IR code property)