queryLocalRecords (queryLocalRecords：Query local video clips of the device)

queryLocalRecords: queryLocalRecords：Query local video clips of the device

Deprecated: Use Local recording list (record.file.list). This legacy HTTP page is retained for existing integrations.

Function details

Query the local video clips of the specified type of the device / channel within the specified time period, and return the clips of the specified range.

Request address

https://openapi-[DataCenter].easy4ip.com/openapi/queryLocalRecords

Request format

HTTP POST. JSON body layout: Request conventions. Sign with Signature.

Minimum permissions required for sub-account token request

"Permission":"RecordReplay" "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
beginTime	String	Yes		Format: yyyy-MM-dd HH:mm:ss	Start Time
endTime	String	Yes		Format: yyyy-MM-dd HH:mm:ss	End time
type	String	No	"All", that is, query all videos		Type
queryRange	String	No		e.g. `1-100`; closed interval `start-end`, difference ≤ 99 (at most 100 records). Mutually exclusive with count; at least one of queryRange or count is required.	Query range
count	Long	No		1–100	Number of records to return; mutually exclusive with queryRange.

Sample input

{
 "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system":{
 "ver":"1.0",
 "appId":"lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time":1599031074,
 "nonce":"8ec8a7bd1d1c95420de20d92422d457d"
 },
 "params":{
 "token":"At_00006acr3456d12312d3grf60147de7ec",
 "deviceId":"TESTQWERXXXX",
 "channelId":"0",
 "beginTime":"2020-05-19 00:00:00",
 "endTime":"2020-05-19 23:59:59",
 "type":"All",
 "queryRange":"1-30"
 }
}

Return data field description

Field	Type	Description
records.recordId	String	Video file name
records.fileLength	Long	Video file length
records.channelID	String	Channel number
records.beginTime	String	Video begin time
records.endTime	String	Video end time
records.type	String	Video type

Sample output

{
 "result":{
 "msg":"The operation was successful.",
 "code":"0",
 "data":{
 "records":[{
 "recordId":"/mnt/sd/2020-05-19/001/dav/00/00.30.59-00.31.36[M][0@0][0].mp4",
 "fileLength":713883,
 "channelID":"0",
 "beginTime":"2020-05-19 00:30:59",
 "endTime":"2020-05-19 00:31:36",
 "type":"Event"
 }]
 }
 },
 "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af"
}

Error codes

This method may return the codes below. See Return codes and Capability errors for the full catalog.

Gateway and auth (SN / TK / OP)

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.

Sub-accounts (SUB)

Code	Meaning	Next step
`SUB1001`–`SUB1002`	Sub-account lacks API permission	Update policy via addPolicy
`SUB1005`	Sub-account token expired	Refresh subAccountToken
`SUB1006`	No device grant for sub-account	Check `Resource` and device serial
`SUB1008`	Sub-account not bound to app	Create and bind the sub-account first

See Return codes · SUB.

Device access and channels (DV10xx)

Code	Meaning	Next step
`DV1007`	Device offline or timeout	Wait for the device to come online
`DV1009`	Device busy	Retry later
`DV1012`	Insufficient share/grant permission	Check sub-account `Permission` / `Resource`
`DV1019`	Capability not supported	Confirm model and capability list
`DV1020`	Channel offline	Check channel status
`DV1026`	Function not supported	Use another API or upgrade firmware
`DV1028`	Not bound or channel missing	Verify `deviceId` / `channelId`

See Return codes · DV.