Skip to end of metadata
Go to start of metadata

2N® IP Intercom HTTP API is an application interface designed for control of selected 2N® IP Intercom functions via the HTTP. It enables 2N® IP Intercoms to be integrated easily with third party products, such as home automation, security and monitoring systems, etc.

You can find a complete description of this on the 2N® IP Intercom HTTP API  online manual:

2N® IP Intercom HTTP API manual

Here is an example how you can change a parameters of the HIP device (framerate/ resolution)  and upload them into 2N® IP Intercom via HTTP API.

 

Once you download the config backup you can find out in the xml file-use for example Notepad++ for easier view to change those parameters, here is an example:

 

In the picture you can see the section for the RTSP-where for codec, for example H.264 you can see Framerate - 2, Resolution - 2, and Bitrate - 4, These numbers fits to the setting of the HIP-the number means always the position of the parameter - second picture Setting.

So, for H.264 is

Video resolution CIF - which is the number 2 in xml database

Video Frame rate 30 fps -  which is the number 2 in xml database

Video Bit Rate 512 kbps - which is the number 4 in xml database


The logic for those numbers are always the same, it starts from 0


The /api/config function helps you upload or download device configuration. The function is part of the System service and the user must be assigned the System Control privilege for authentication if required. The function is available with the Enhanced Integration licence key only.

Use the  PUT method for configuration upload. For configuration upload, the reply is in the application/json format and includes no other parameters.

Example:

PUT /api/config
{
  "success" : true
}


The put request can look like this https://192.168.50.163/api/config where the 192.168.50.163 is the IP address of the intercom. You can try this by using the HTTP API test tool available on  https://2N®_IP_Intercom_ip_address/apitest.html

The example is in the attached picture, the xml file with the config would be yours changed config file