record.file.alarmList (Get local recordings (by message time))
record.file.alarmList: Get local recordings (by message time)
record.file.alarmList · channel scope · permission RecordReplay
What it does
Local recordings: fetches local recordings for this channel by message time (not playback control). Input info.beginTime; returns recInfos. Each call runs once.
Routing: v2 invoke; on the platform maps to Open-OPS and shares device-side record/list with record.file.list. Do not mix with queryLocalRecords.
Request URL
POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.service.invoke
Minimum permission
The administrator does not need an extra permission on a device they bound. A shared device needs the local recording view permission. A bound sub-user does not. A sub-account needs RecordReplay. Omitting channelId on channel-scope capabilities returns DV2007. Mixing device and channel properties in one request returns DV2008. A timeout does not mean the invoke failed.
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
token | String | yes | Access token for an administrator, sub-user, or sub-account |
deviceId | String | yes | Device serial number |
productId | String | no | Optional. If sent and it does not match the device model → DV2009 |
channelId | String | yes | Channel ID; "0" is common for IPC |
serviceId | String | yes | record.file.alarmList |
inputData | Object | yes | See table below |
| Name | Description | Type | Required | Values |
|---|---|---|---|---|
info | Info. Includes beginTime. | struct | yes | Includes beginTime |
info.beginTime | Message start time. Wall-clock, format YYYY-MM-DD HH:mm:ss. | text | yes | Format YYYY-MM-DD HH:mm:ss |
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",
"channelId": "0",
"serviceId": "record.file.alarmList",
"inputData": {
"info": {
"beginTime": "2026-09-19 12:00:00"
}
}
}
}
Response data fields
Output is in result.data.outputData.
| Name | Description | Type | Required | Values |
|---|---|---|---|---|
recInfos | Recording info. Includes recBeginTime, recEndTime, streamType, fileLength. | struct | no | Includes recBeginTime, recEndTime, streamType, fileLength |
recInfos.recBeginTime | Recording start time. Wall-clock, format YYYY-MM-DD HH:mm:ss. | text | no | Format YYYY-MM-DD HH:mm:ss |
recInfos.recEndTime | Recording end time. Wall-clock, format YYYY-MM-DD HH:mm:ss. | text | no | Format YYYY-MM-DD HH:mm:ss |
recInfos.streamType | Stream type. | enum | no | 0 main stream; 1 sub stream 1; 2 sub stream 2; 3 sub stream 3 |
recInfos.fileLength | Recording length. Range 0–999999, step 1. | int | no | 0–999999, step 1 |
Response example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {
"outputData": {
"recInfos": {
"recBeginTime": "2026-09-19 12:00:00",
"recEndTime": "2026-09-19 12:10:00",
"streamType": "0",
"fileLength": 1024
}
}
}
}
}
Error codes
| Code | Meaning | Next step |
|---|---|---|
SN1001 | Signature error | Check sign per Development specification |
TK1002 | Token invalid or expired | Refresh accessToken |
OP1002 | Missing required parameter | Add required fields |
OP1003 | Invalid parameter | Match this page’s parameter table |
OP1009 | Permission denied | Check token and device bind/share grants |
OP1013 | Total call limit exceeded | Reduce call rate |
OP1014 | Daily per-interface limit exceeded | See Interface call limits |
DV1007 | Device offline | Wait until the device is online |
See Return codes · OP/SN/TK for the full catalog.
| Code | Meaning | Next step |
|---|---|---|
DV2003 | Capability not on device | Use device.capability.list |
DV2007 | channelId vs scope mismatch | Required for channel scope; omit for device scope |
DV2008 | Mixed device and channel in one call | Split the request |
DV2009 | productId mismatch | Omit or set actual model id |
DV2011 | No capability permission | See Permission codes |
See Capability errors.