queryDeviceOsd: Get device OSD configuration
queryDeviceOsd: Get device OSD configuration
Function details
Obtain the OSD watermark configuration of the device.
Note: To configure the device watermark, the device must have an OSD capability set
Request address
https://openapi-[DataCenter].easy4ip.com/openapi/queryDeviceOsd
Minimum permissions required for sub-account token request
"Permission":"Config" "Resource":"cam:serial number:channel number"
Incoming parameter description
| Parameter name | Parameter type | Required or not | Default value | Legal value | Parameter description |
|---|---|---|---|---|---|
| token | String | Yes | Administrator or sub-account accessToken | ||
| deviceId | String | Yes | Device serial number | ||
| channelId | String | Yes | Channel ID |
Sample input
{
"id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"system":{
"ver":"1.0",
"appId":"lcdxxxxxxxxx",
"sign":"74bc756ebd53e9eef2836f8cf1730c10",
"time":1599031074,
"nonce":"8ec8a7bd1d1c95420de20d92422d457d"
},
"params":{
"token":"At_00006acr3456d12312d3grf60147de7ec",
"deviceId":"TESTQWERXXXX",
"channelId":"0"
}
}
Return data field description
| Field name | Field type | Field description | |
|---|---|---|---|
| enable | String | Motion check switch, on: enable open, off: enable close | |
| osd | String | OSD characters, corresponding to the channelTitle on the device side, line breaks are not supported | |
Sample output
{
"result":{
"msg":"The operation was successful.",
"code":"0",
"data":{
"enable":"on",
"osd":"channelTitle"
}
},
"id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af"
}
