audio.mic.enabled: Read microphone capture switch

audio.mic.enabled · Channel scope · Permission Config

Feature details

Read the microphone acquisition switch for this channel. 0 off, 1 on. If the list has this leaf but get does not have a return key, it is mostly that the device is not reported or not supported, not that the gateway is missing parameters.

Request address

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. Omitting channelId on a channel-scope capability returns DV2007. Mixing device and channel in one request returns DV2008.

Request parameters

Common request fields and the signature are in Development specification.

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",
 "channelId": "0",
 "properties": [
 "audio.mic.enabled"
 ]
 }
}

# # # Returns a description of the data field

The value is in result.data.properties["audio.mic.enabled"].

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "properties": {
 "audio.mic.enabled": 1
 }
 }
 }
}

Error Code

Gateway and device error codes are in Global return codes.

Set microphone acquisition switch properties · Microphone acquisition