Reolink Camera API User Guide_V8 (Updated in April 2023)

[Reolink Fiona]

Hi all，
 
We know that the demand for home automation is vast. Our goal is to develop a Reolink ecosystem that incorporates home automation in the long run.
 
We provide you with the camera API user guide, and we also would like to know about your project! Please feel free to tell us where you plan to use them. Let us hear your ideas
 
Link to the latest Reolink Camera API User Guide: http://bit.ly/3nF4mB5.
 
This guide contains instructions on how to use and integrate the API effectively. This is also a simple and straightforward reference manual. It has all the information needed to use the API and detailed information about functions, return types, parameters, etc. It also provides tutorials and sample support.
 
What‘s New

1. Improve the description of the example
2. Add the description of video preview
3. Delete the abandoned command (rtmp start/rtmp stop/rtmp auth)
4. Add the version field to the login command
5. Add GetSysCfg/SetSysCfg/GetStitch/SetStitch commands
6. ISP adds multi-level frame drop and soft light sensitivity
7. NVR cut and download video file optional stream type
8. Increase the ptz guard parameter
9. Increase the white light setting parameters
10. Add description for ftp command
11. Improve the capability set
12. Improve the error code

 
Hooray! Here also comes the good news. Many users have requested Webhook support for AI detection of third-party integration. Our tech team is working on this project. If you have any requests, please share them with us to make our work better.
----------------------------------------
Updated: We have added some privacy terms in v8. The link above is updated.

[Jonas_3602]

@reolink-fiona Will the webhooks be available for doorbells and trackmix cameras? Great news btw!

[ExTrEmE_590650728796222]

@reolink-fiona I'm looking with interest the new doorbell, but webhooks will be available in doorbell too?
It's mandatory for me to get a doorbell that can be integrated with home assistant!

[MAWH_588865576947807]

I want to trigger the White light with an API command, just turn it on and off! I can trigger the White Light when my house alarm is triggered.

Same for the alarm/sirene.

[user_629911810629744_629911810629744]

Would be nice also to have 2-Way Audio via API if possible. Thanks!

[user_600178489868304_600178489868304]

Any chance they will implement MQTT?

[user_635300470997033_635300470997033]

Hello,

would it‘s be possible to get an output about the ‚smart detection‘ via the API?
It seems that at the moment just a motion are going over the API

Thanks

[pierregir69_564052711067883]

hi @Reolink-Fiona, i deeply regret that in the v8 version of the API guide of April 2023, there some newer commands are still missing from some cameras :

DOORBELL

• GetPowerLed > new field : eDoorbellLightState
• GetAudioFileList
• SetAudioFileList
• GetAutoReply
• SetAutoReply
• DeleteAudioFile

from newer Doorbell firmware ( v3.0.0.1859 ) :

• GetEvents

TRACKMIX

• GetAiCfg > new fields (bSmartTrack, aiStopBackTime, aiDisappearBackTime and trackTask)
• GetAiDenoise
• SetAiDenoise
• ExportImg
• ImportImg
• DeleteImg
• GetPtzTraceSection
• SetPtzTraceSection
• GetPtzCurPos

RLC-823A_16X :

• Get3DPos
• Set3DPos

Can we have a new update of the guide with these commands.
Thanks in advance
Regards

EDIT : add new commands

• GetAudioCfg > new field (visitorLoudspeaker) -for Doorbell-
• ExportAudioFile
• GetFishEye
• SetFishEye

FYI, i contribute (aka mnpg or mnpg_fr -on reddit-) in the development of the Reolink plugin, with jezza34000 -his author-, for the french home automation called Jeedom. This plugin is free and right now -april 2023-, we have more than 800 installs. i bring my modest contribution to starkillerOG for the official Reolink HA plugin and also i have a github repo, as mnpg, that contains official documentations and unofficial detailled documentations of the reolink cameras for sharing my knowledge with other reolinkers since 2020.

[clintjohnson_615769083773304]

Request adding the Reolink Floodlight to the HTTP API.

[terrydrogo_667906978209966]

@clintjohnson_615769083773304 @small world cup this is a great update for you.

[rory carroll_619168034447646]

hi, I have the 820A dome - I'd love to be able to hook into its vehicle detection.

[jakub exner_670128680321649]

Hello, I would like to integrate my Reolink cameras to smart home. The problem is, that Reolink API works via POST method only and my smart home (Loxone - one of biggest in segment in Europe) supports only GET method for input. Do you think, it would be possible to use GET method too for getting states in future? Thank you!

[lars_455575943418087]

Is there a way of getting the times for each type of alarm (human/vehicle) on a specific date, using the API? - the info that is shown as lines at the bottom of the screen i Playback mode.

/Lars

[joseph_1979]

@lars_455575943418087 There is no function in the API_v8 doc which allows you to list the alarms generated on a particular date. Maybe you can make a request to Reolink support to include it in the future releases of their API.

[terrydrogo_667906978209966]

@ a small world cup thank for your share.

[esthersherryworld_585790787826247]

I just wanted to say thank you for the updated Reolink Camera API User Guide. I've been using your cameras for a few years now, and I've always been impressed with the quality of your products and the level of support you provide.
The new API guide is very comprehensive and easy to follow. I was able to quickly find the information I needed to integrate my Reolink cameras with my home automation system.
I'm particularly excited about the new Webhook support for AI detection. This will allow me to trigger automations based on events like motion detection or person detection.
I'm looking forward to seeing what other great features you'll add to the API in the future.
Thanks again for a great product and a great API!

[user_734401640206535_734401640206535]

My goal is to create a notification system that will alert me when the USPS truck stops at my mailbox is which is currently monitored by a RLC-810A camera. I'm hoping to somehow tie into the Survellance system that identifies when a vehicle passes (or ideally stops) next to my mailbox and then using perhaps Google's Vision API (or something similar) to identify the USPS truck by its logo. Then once the USPS truck has been identified as being next to my mailbox, to send an email alert that there might be snail mail in my mailbox.

Any help would be appreciated.

Here's a result of using Google Vision with a snapshot of a USPS truck next to my mailbox:

[joseph_1979]

@user_734401640206535_734401640206535 Bro, I have been thinking of this for a long time. To load a picture of the object and once this object matches the one being analysed by the camera, a specific high priority message is forwarded to the user. I think we are asking too much at this point in time and hope one day it shall be implemented. Today on Reolink cameras we don't have facial detection and recognition and neither number plate recognition. However, this may be implemented by forwarding the stream to an AI cloud service which can offer such a service as per your article.

[rui godinho lopes_709100408737905]

@Reolink-Fiona, Thank you for posting the API Guide!


I'm trying to see the video stream for the first time from the firefox web browser.


Using the mpegts.js video player (see TODO) to load the video stream as:

// see https://
const player = mpegts.createPlayer({
 type: 'flv',
 isLive: true,
 url: 'MY_CAMERA_URL'
});
player.attachMediaElement(document.getElementById("video-stream"));
player.load();
player.play();


Firefox fails with a CORS error:


Cross-Origin Request Blocked: The Same Origin Policy disallows reading the remote resource at
MY_CAMERA_URL.

(Reason: CORS header Access-Control-Allow-Origin missing). Status code: 200.


How can I configure the camera CORS?

[joseph_1979]

@rui-godinho-lopes_709100408737905 Is there any specific reason for using Firefox browser to stream from cam? Can you enter with https (assuming you enabled https on camera) and check whether you can watch live and playback?

[rui godinho lopes_709100408737905]

@joseph_1979 using the web application built-in in the camera firmware works fine in Firefox.

What I want to build is my own web application, where I can directly see the video from the camera (and also invoke the API directly from the web browser). Everything should work as-is if the camera firmware had a way to configure CORS. So what I'm asking is whether that feature is already built-in in the firmware, and how can I configure it? If that feature does not exist, I want to make a plea to have it

[gutkowski_761732894875799]

Thank you for sharing your goals for home automation and the Reolink Camera API User Guide. I am excited to see and how you continue to develop this ecosystem and provide users with more options for integrating their Reolink cameras into their smart homes.
I am also interested in learning more about your users' projects and how they are using the Reolink Camera API. Please encourage your users to share their ideas and projects with you so that you can continue to improve the API and make it even more useful for them.

[user_762573796765860_762573796765860]

Hi, I'm trying to build a home camera network to manage with the API.

I have been looking in your website but I can't get a clear idea of which models are compatible with the API.

Can you provide a list of models or categories, please?

Thank you

[user_767343257399498_767343257399498]

Is it possible to expand the API to allow toggling the Detection Type buttons (Any Motion, Person, Vehicle, Animal) on and off? See attached image. This would allow the possibility to have more complicated schedules through home automation systems. For examples: I want person detection enabled if nobody is home, or person detection enabled only at night.

[joseph_1979]

@user_767343257399498_767343257399498 From the API doc issued in 2023, there is no API which enables/disables particular detection type. Only recording can be disabled/enabled as illustrated below.

curl -s -k -X POST -H "Content-Type : application/json" -d "[{\"cmd\":\"SetRecV20\",\"action\":0,\"param\":{\"Rec\":{\"channel\":0,\"enable\":#SWITCH#}}}]" "https://#IP#/cgi-bin/api.cgi?user=#username#&password=#password#"

In the command, Change #SWITCH# by 0 to disable (or 1 to enable) the Record surveillance mode

[user_806105018958032_806105018958032]

Any news about the webhook? I'm interested in the POE doorbell, but I don't want to use the chime.. I want to add it to my smart home..

[joseph_1979]

@user_806105018958032_806105018958032 Not yet. I suggest you to submit your request to support on support(@)reolink(dot)com

[user_800108234940650_800108234940650]

HI,

I'm acutally adding my both new ReoLinks to my HomeAssistant installation. Doing that I spend a lot of afford in investing on API/Rest call from latest API documentation. I tried to setup disabling alarm by an extended Detection Zone. Nevertheless I can't make it work using the "SetMdAlarm" function.

That raises the question how actual is the version 8 documentation of the API.

I did also some investigation with devtools from google. and found out that the SetAlarmArea is not only working for AI types. It also seems to work with MD typ.

Is that correct?

Is there a newer version of the api documention with some more explanations?

Or will it come soon?

I attache the SetAlarmArea payload that is send from webinterface. May be helpfull for other useres.

[
    {
        "cmd": "SetAlarmArea",
        "action": 0,
        "param": {
            "people": {
                "area": "111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
                "cols": 60,
                "rows": 33
            },
            "vehicle": {
                "area": "111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
                "cols": 60,
                "rows": 33
            },
            "dog_cat": {
                "area": "111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
                "cols": 60,
                "rows": 33
            },
            "md": {
                "area": "111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
                "cols": 60,
                "rows": 33
            },
            "channel": 0
        }
    }
]

[user_813893451849875_813893451849875]

This post is deleted!

[user_873013521223874_873013521223874]

Which cameras support API?