Download
Share
Print this page
2N Indoor Touch 2.0 API Manual
  1. Manuals
  2. Brands
  3. 2N Manuals
  4. Touchscreen
  5. Indoor Touch 2.0 API
  6. Manual
2N Indoor Touch 2.0 API Manual

2N Indoor Touch 2.0 API Manual

Hide thumbs

Advertisement

Quick Links

Download this manual
 
 
2N® Indoor Touch 2.0 API
 
 
 
 
 
 
v.4.8.x
www.2n.com

Advertisement

loading
Need help?

Need help?

Do you have a question about the Indoor Touch 2.0 API and is the answer not in the manual?

Questions and answers

Related Manuals for 2N Indoor Touch 2.0 API

Summary of Contents for 2N Indoor Touch 2.0 API

  • Page 1     2N® Indoor Touch 2.0 API             v.4.8.x www.2n.com...
  • Page 2 2N® Indoor Touch 2.0 API Content: • 1. Purpose of Document • 2. HTTP API • 3. WEB API • 4. Supplementary Information 2 /  95...

  • Page 3: Purpose Of Document

     Indoor Touch 2.0 HTTP API provides third party applications a possibility to configure and ® control selected system parts and the 2N  IP Mobile calling application.  Caution • The HTTP API service is licensed under the 91378395 2N Indoor Touch HTTP API license. 3 /  95...

  • Page 4: Http Api

    2.2.3.3 Call Termination • 2.2.3.4 Call State • 2.2.3.5 2N IP Intercom List Getting • 2.2.3.6 Change of Items in Added 2N IP Intercom List • 2.2.3.7 Door Lock Activation • 2.2.3.8 2N® IP Mobile Minimization • 2.2.3.9 2N® IP Mobile State Info •...
  • Page 5 JSON data format, incorrect HTTP method, etc. ® • A 2N  IP Mobile command is entered but the application is not running. Therefore, make ® sure that the application has been started before sending a 2N  IP Mobile command. 5 /  95...
  • Page 6 2N® Indoor Touch 2.0 API The data container can include more items whose names and contents depend on the request to be sent. Our example includes an array of serial numbers. 2.1.4 Cautions Currently, API is used for both providing data to the web interface (REST) and user HTTP API requirements. Thus, the data that can be viewed and configured via the web can be available in...
  • Page 7 2N® Indoor Touch 2.0 API  Response code 403 in the case of default password and its necessary change. 2.2.1.2 Logout The logout helps you log out the currently logged-in session. URL: http://<IP>/api/v1/logout HTTP method: Response code: 200 if everything is OK, otherwise 401, 405,...
  • Page 8 2N® Indoor Touch 2.0 API Response data: "data": { "pins": [ "id": 0, "name": "In1", "value": "id": 1, "name": "In2", "value": "id": 2, "name": "Out1", "value": "id": 3, "name": "Out2", "value": "id": 4, "name": "IO1", "value": "id": 5, "name": "IO2", "value":...
  • Page 9 2N® Indoor Touch 2.0 API 2.2.2.2 GPIO Value Setting Set the output value, switchable IO direction or relay status change. Parameters Name – GPIO name, refer to 2.2.2.1 Getting List of GPIO Inputs and Outputs Value – can be {0, 1} ...
  • Page 10 2N® Indoor Touch 2.0 API Request body: "pins": [ "name": "In1", "id": 0, "value": "name": "In2", "id": 1, "value": "name": "Out1", "id": 2, "value": "name": "Out2", "id": 3, "value": "name": "IO1", "id": 4, "value": "name": "IO2", "id": 5, "value": "name": "Relay1", "id": 6,...
  • Page 11 2N® Indoor Touch 2.0 API Response data: "data": { "pins": [ "id": 0, "name": "In1", "value": "id": 1, "name": "In2", "value": "id": 2, "name": "Out1", "value": "id": 3, "name": "Out2", "value": "id": 4, "name": "IO1", "value": "id": 5, "name": "IO2", "value":...
  • Page 12 2.2.3.3 Call Termination • 2.2.3.4 Call State • 2.2.3.5 2N IP Intercom List Getting • 2.2.3.6 Change of Items in Added 2N IP Intercom List • 2.2.3.7 Door Lock Activation • 2.2.3.8 2N® IP Mobile Minimization • 2.2.3.9 2N® IP Mobile State Info •...
  • Page 13 2N® Indoor Touch 2.0 API 2.2.3.2 Call Accept Accepts currently ringing incoming call. URL: https://<IP>/api/v1/call/accept HTTP method: Request body: Response code: Standard HTTP response code, treating syntactic errors. Response data: {"data":{"success":true}} 2.2.3.3 Call Termination Terminates the active call. URL: https://{{ip_addr}}/api/v1/hipm/call/hangup...
  • Page 14 Response data: "data": { "state": "Released" 2.2.3.5 2N IP Intercom List Getting ®  Get the list of the 2N IP intercoms that are registered with 2N IP Mobile and can be displayed and edited in the device list. NNURL: https://{{ip_addr}}/api/v1/hipm/devices HTTP method: Response code: Standard HTTP response code, treating syntactic errors.
  • Page 15 2.2.3.6 Change of Items in Added 2N IP Intercom List Modify the list of added 2N IP intercoms.  Parameters  isActive – true or false id – get the 2N IP intercom ID from the list, refer to 2.2.3.5 Getting List of Available 2N IP Intercoms URL:...
  • Page 16 "id": 255, "isActive": true 2.2.3.7 Door Lock Activation Send a request to activate the door lock for a selected 2N IP intercom. Make sure that the 2N IP intercom serial number is in the list of added devices. URL: https://{{ip_addr}}/api/v1/hipm/devices/open HTTP method: Request body "switchId":1,...
  • Page 17 "string"  Caution • The 2N IP intercom, whose door lock switch is to be activated must be active according to request 2.2.3.5 Getting List of Available 2N IP Intercoms. Switch the 2N IP intercom into the active state using request 2.2.3.6 Change of Items in List of...
  • Page 18 2N® Indoor Touch 2.0 API 2.2.3.9 2N® IP Mobile State Info Returns the information that the application is running and capable of processing communication. URL: https://<IP>/api/v1/hipm HTTP method: Request body: Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": {...
  • Page 19 2N® Indoor Touch 2.0 API 2.2.4.1 System Info and Status As this is a WEB API function, the success value is not included in the response. Information on the system and its state is returned. URL: https://<IP>/api/v1/status HTTP method: Request body: Response code: Standard HTTP response code, treating syntactic errors.
  • Page 20 2N® Indoor Touch 2.0 API Response data: "data": { "device": { "fwVersion": "4.2.0", "hwVersion": 1, "isNfcCapable": false, "isWifiCapable": true, "lanMac": "7C:1E:B3:02:FC:12", "model": "2N Indoor Touch 2.0", "os": "Android OS 6.0.1", "sn": "52-2101-0129", "temperature": 53, "uptimeLife": 7898373, "uptimeRestart": 763111, "wifiMac": "7C:1E:B3:03:3F:6B"...
  • Page 21 2N® Indoor Touch 2.0 API • upTimeLife – gives the total device operation time  • upTimeRestart – gives the device operation time since the last restart  • wifiMac – wi-fi interface MAC address • memory • available – currently available device memory size •...
  • Page 22 2N® Indoor Touch 2.0 API 2.2.4.2 2N® Indoor Touch Restart ® Restart the 2N  Indoor Touch 2.0 unit. URL: https://<IP>/api/v1/maintenance/devicereset HTTP method: Request body: Response code: Standard HTTP response code, treating syntactic errors. 22 /  95...

  • Page 23: Web Api

    2N® Indoor Touch 2.0 API 3. WEB API ® WEB API incudes a set of endpoints that are used in the 2N Indoor Touch 2.0 web interface. • 3.10 Maintenance • 3.11 Network • 3.1 Device info • 3.2 Application •...
  • Page 24 2N® Indoor Touch 2.0 API HTTP method: Response code: Standard HTTP response code, treating syntactic errors. 24 /  95...
  • Page 25 2N® Indoor Touch 2.0 API Response data: "data": { "device": { "fwVersion": "4.2.0", "hwVersion": 1, "isNfcCapable": false, "isWifiCapable": true, "lanMac": "7C:1E:B3:02:FC:12", "model": "2N Indoor Touch 2.0", "os": "Android OS 6.0.1", "sn": "52-2101-0129", "temperature": 45, "uptimeLife": 8069000, "uptimeRestart": 8201, "wifiMac": "7C:1E:B3:03:3F:6B"...
  • Page 26 2N® Indoor Touch 2.0 API Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "isInstallationAllowed": false, "isReturnToApplicationOnCallEndAllowed": false Section configuration  Set the values in the Application section. URL: https://{{ip_addr}}/api/v1/application HTTP method: Response code: Standard HTTP response code, treating syntactic errors.
  • Page 27 2N® Indoor Touch 2.0 API Request body: "applicationToRunAtStart":{ "id":"", "installDate":"", "name":"None", "version":"" "isInstallationAllowed":false, "isReturnToApplicationOnCallEndAllowed":false, "urlToRunAtStart":"" Response data: "data": { "applicationToRunAtStart": { "id": "", "installDate": "", "name": "None", "version": "" "isInstallationAllowed": false, "isReturnToApplicationOnCallEndAllowed": false, "urlToRunAtStart": "" List of available applications Get a list of available applications.
  • Page 28 2N® Indoor Touch 2.0 API 28 /  95...
  • Page 29 2N® Indoor Touch 2.0 API Response data: "data": { "applications": [ "id": "", "installDate": "", "name": "None", "version": "" "id": "com.axis.acc", "installDate": "1/1/09", "name": "Companion 3", "version": "3.12.15 (167)" "id": "com.axis.acs", "installDate": "1/1/09", "name": "Camera Station", "version": "1.13.18 (144)" "id": "com.android.music", "installDate": "1/1/09",...
  • Page 30 2N® Indoor Touch 2.0 API "version": "6.0.1 (23)" "id": "com.adobe.reader", "installDate": "1/1/09", "name": "Adobe Acrobat", "version": "19.0.0.8512 (1900008512)" "id": "com.android.browser", "installDate": "1/1/09", "name": "Browser", "version": "6.0.1 (23)" "id": "cz.nn.helios_mobile", "installDate": "1/1/09", "name": "2N® IP Mobile", "version": "4.4.6 (474)" 3.3 Audio...
  • Page 31 2N® Indoor Touch 2.0 API Response data: "data": { "alarmsVolume": 86, "musicVolume": 73, "ringtoneVolume": Section setting URL: https://{{ip_addr}}/api/v1/audio HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Request body: "alarmsVolume":5, "musicVolume":15, "ringtoneVolume":10 31 /  95...
  • Page 32 2N® Indoor Touch 2.0 API Response data: "data": { "alarmsVolume": 0, "musicVolume": 13, "ringtoneVolume": 3.4 Display Getting current settings Get the current Display settings. URL: https://{{ip_addr}}/api/v1/display HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "brightness": 100,...
  • Page 33 2N® Indoor Touch 2.0 API Request body: "brightness": 37, "isBlueLedNotificationActive": true, "turnOffDisplayDelay": 33 /  95...
  • Page 34 2N® Indoor Touch 2.0 API Response data: "data": { "brightness": 37, "isBlueLedNotificationActive": true, "turnOffDisplayDelay": 3.5 IP Mobile Getting device state info URL: https://{{ip_addr}}/api/v1/hipmo/status HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "isDndEnabled": false, "isDoorButtonEnabled": false,...
  • Page 35 2N® Indoor Touch 2.0 API • 3.5.1 Device name • 3.5.2 General • 3.5.3 Call • 3.5.4 SIP • 3.5.5 Recorder • 3.5.6 Doorbutton • 3.5.7 Externalring • 3.5.8 DND • 3.5.9 My2N • 3.5.10 Devices 3.5.1 Device name Getting device name setting...
  • Page 36 2N® Indoor Touch 2.0 API Response data: "data": { "deviceName": "idt555" 3.5.2 General Getting current settings  Get the current General settings. URL: https://{{ip_addr}}/api/v1/hipmo/settings/general HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "autosnapshot": true, "customLanguage": false,...
  • Page 37 2N® Indoor Touch 2.0 API Request body: "hipGroupPassword": "<string>", "settingsPassword": "<string>", "autosnapshot": "<boolean>", "pushToTalk": "<boolean>", "logging": "<boolean>", "multicastDiscovery": "<boolean>", "customLanguage": "<boolean>", "isReceivingMulticastActive": "<boolean>", "deactivationTimeout": "<integer>" Response data: "data": { "autosnapshot": true, "customLanguage": false, "deactivationTimeout": 1, "hipGroupPassword": "", "isReceivingMulticastActive": false, "logging": false, "multicastDiscovery": true,...
  • Page 38 2N® Indoor Touch 2.0 API Response data: "data": { "autoCallPickup": false, "autoCallPickupDelay": 0, "customRingtone": false, "isEarlyMediaEnabled": true, "ringtone": { "name": "Flutey Phone", "uri": "content://media/internal/audio/ media/175" Section setting URL: https://{{ip_addr}}/api/v1/hipmo/settings/call HTTP method: Response code: Standard HTTP response code, treating syntactic errors.
  • Page 39 2N® Indoor Touch 2.0 API Response data: "data": { "autoCallPickup": false, "autoCallPickupDelay": 0, "customRingtone": false, "isEarlyMediaEnabled": true, "ringtone": { "name": "Flutey Phone", "uri": "content://media/internal/audio/ media/175" Getting list of ringtones URL: https://{{ip_addr}}/api/v1/hipmo/settings/call/ringtones HTTP method: Response Standard HTTP response code, treating syntactic errors.
  • Page 40 2N® Indoor Touch 2.0 API Response data: "data": { "ringtones": [ "name": "None", "uri": "NONE" "name": "Andromeda", "uri": "content://media/internal/audio/media/103" "name": "Zeta", "uri": "content://media/internal/audio/media/206" 40 /  95...
  • Page 41 2N® Indoor Touch 2.0 API 3.5.4 SIP Getting current settings  Get the current SIP Proxy server settings. URL: https://{{ip_addr}}/api/v1/hipmo/settings/sip HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "ipAddress": "", "isEnabled": false, "name": "IndoorTouch", "password": "",...
  • Page 42 2N® Indoor Touch 2.0 API Request body: "name": "<string>", "userName": "<string>", "password": "<string>", "ipAddress": "<string>", "port": "<integer>", "protocol": "<integer>", "isEnabled": "<boolean>", "sipPortRandomization": "<boolean>", "sipRandomPort": "<integer>", "registrar": { "ipAddress": "<string>", "isEnabled": "<boolean>", "expiry": "<integer>", "port": "<integer>" Response data: "data": { "ipAddress": "", "isEnabled": false,...
  • Page 43 2N® Indoor Touch 2.0 API HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "activationTimeout": 0, "announcementType": 0, "isEnabled": false Section setting URL: https://{{ip_addr}}/api/v1/hipmo/settings/recorder HTTP method: Response code: Standard HTTP response code, treating syntactic errors.
  • Page 44 2N® Indoor Touch 2.0 API URL: https://{{ip_addr}}/api/v1/hipmo/settings/doorbutton HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "bypassDnd": false, "invertInput": true, "isEnabled": false, "maxRingingTime": 30, "minRingingTime": 3, "usedInput": Section setting URL: https://{{ip_addr}}/api/v1/hipmo/settings/doorbutton HTTP method: Response code: Standard HTTP response code, treating syntactic errors.
  • Page 45 2N® Indoor Touch 2.0 API Response data: "data": { "bypassDnd": false, "invertInput": true, "isEnabled": false, "maxRingingTime": 30, "minRingingTime": 3, "usedInput": 3.5.7 Externalring Getting current settings Get the current external ringing notification settings. URL: https://{{ip_addr}}/api/v1/hipmo/settings/externalring HTTP method: Response code: Standard HTTP response code, treating syntactic errors.
  • Page 46 2N® Indoor Touch 2.0 API Request body: "isEnabled": "<boolean>", "invertOutput": "<boolean>", "bypassDnd": "<boolean>", "usedOutput": "<integer>", "minRingingTime": "<integer>", "maxRingingTime": "<integer>" Response data: "data": { "bypassDnd": false, "invertOutput": true, "isEnabled": false, "maxRingingTime": 30, "minRingingTime": 3, "usedOutput": 3.5.8 DND Getting current settings Get the current DND settings.
  • Page 47 2N® Indoor Touch 2.0 API Response data: "data": { "dnd": { "isEnabled": false, "time": "dndNight": { "days": [ "endTime": "00:00", "isEnabled": false, "startTime": "00:00" Section setting URL: https://{{ip_addr}}/api/v1/hipmo/settings/dnd HTTP method: Response code: Standard HTTP response code, treating syntactic errors. 47 /  95...
  • Page 48 2N® Indoor Touch 2.0 API Request body: "dnd": { "isEnabled": "<boolean>", "time": "<integer>" "dndNight": { "isEnabled": "<boolean>", "startTime": "<string>", "endTime": "<string>", "days": [ "<integer>", "<integer>" Response data: "data": { "dnd": { "isEnabled": false, "time": "dndNight": { "days": [ "endTime": "00:00", "isEnabled": false,...
  • Page 49 2N® Indoor Touch 2.0 API URL: https://{{ip_addr}}/api/v1/hipmo/settings/my2n HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "deviceId": "", "isEnabled": false, "password": "" Section setting URL: https://{{ip_addr}}/api/v1/hipmo/settings/my2n HTTP method: Response code: Standard HTTP response code, treating syntactic errors.
  • Page 50 2N® Indoor Touch 2.0 API 3.5.10 Devices Getting list of all devices URL: https://{{ip_addr}}/api/v1/hipmo/devices HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "actual": [], "lan": [ "id": 148, "ip": "10.27.6.213", "isActive": false, "name": "2NIndoorCompact-5223420153"...
  • Page 51 2N® Indoor Touch 2.0 API Response data: "data": { "devices": [] • 3.5.10.1 LAN • 3.5.10.2 SIP 3.5.10.1 LAN Getting list of LAN devices URL: https://{{ip_addr}}/api/v1/hipmo/devices/lan HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "devices": [...
  • Page 52 2N® Indoor Touch 2.0 API Section setting URL: https://{{ip_addr}}/api/v1/hipmo/devices/lan/{{id}} HTTP method: Path variable: id – device ID Response code: Standard HTTP response code, treating syntactic errors. Request body: "id": "<integer>", "name": "<string>", "isActive": "<boolean>", "ip": "<string>" Response data: "data": { "devices": [...
  • Page 53 2N® Indoor Touch 2.0 API 3.5.10.2 SIP Getting list of SIP devices URL: https://{{ip_addr}}/api/v1/hipmo/devices/sip HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "devices": [] Create SIP device URL: https://{{ip_addr}}/api/v1/hipmo/devices/sip HTTP method: Response code: Standard HTTP response code, treating syntactic errors.
  • Page 54 2N® Indoor Touch 2.0 API Response data: "data":{ "devices":[ "device": "id":"<integer>", "name":"<string>", "isActive":"<boolean>", "isMy2n":"<boolean>", "sipLine":"<string>", "dtmf1":"<string>", "dtmf2":"<string>", "dtmf3":"<string>", "dtmf4":"<string>"   SIP device update  URL: https://{{ip_addr}}/api/v1/hipmo/devices/sip/{{id}} HTTP method: Path variable: id – device ID Request body: "id": "<integer>", "name": "<string>", "isActive": "<boolean>", "isMy2n": "<boolean>",...
  • Page 55 2N® Indoor Touch 2.0 API Response data: "data":{ "devices":[ "device": "id":"<integer>", "name":"<string>", "isActive":"<boolean>", "isMy2n":"<boolean>", "sipLine":"<string>", "dtmf1":"<string>", "dtmf2":"<string>", "dtmf3":"<string>", "dtmf4":"<string>" Delete device URL: https://{{ip_addr}}/api/v1//hipmo/devices/sip/{{id}} HTTP method: DELETE Path variable: id – device ID Response code: Standard HTTP response code, treating syntactic errors.
  • Page 56 2N® Indoor Touch 2.0 API Get the current Homepage settings.  URL: https://{{ip_addr}}/api/v1/homescreen HTTP method: Response code: Standard HTTP response code, treating syntactic errors. 56 /  95...
  • Page 57 2N® Indoor Touch 2.0 API Response data: "data": { "buttons": [ "application": { "id": "com.android.documentsui", "name": "File Manager" "icon": 6, "id": 1, "label": "File Manager", "position": "application": { "id": "com.android.browser", "name": "Browser" "icon": 3, "id": 2, "label": "Browser", "position": "application": { "id": "cz.nn.helios_mobile",...
  • Page 58 2N® Indoor Touch 2.0 API "id": 5, "position": "isClockOnlyModeActive": false Section setting URL: https://{{ip_addr}}/api/v1/homescreen HTTP method: Request body: "isClockOnlyModeActive": "<boolean>" Response code: Standard HTTP response code, treating syntactic errors. 58 /  95...
  • Page 59 2N® Indoor Touch 2.0 API Response data: "data": { "isClockOnlyModeActive": false Get a list of applications available for the Homepage. URL: https://{{ip_addr}}/api/v1/homescreen/applications HTTP method: Response code: Standard HTTP response code, treating syntactic errors. 59 /  95...
  • Page 60 2N® Indoor Touch 2.0 API Response data: "data": { "applications": [ "id": "com.axis.acc", "installDate": "1/1/09", "name": "Companion 3", "version": "3.12.15 (167)" "id": "com.axis.acs", "installDate": "1/1/09", "name": "Camera Station", "version": "1.13.18 (144)" "id": "com.android.music", "installDate": "1/1/09", "name": "Music", "version": "6.0.1 (23)"...
  • Page 61 2N® Indoor Touch 2.0 API "version": "19.0.0.8512 (1900008512)" "id": "com.android.browser", "installDate": "1/1/09", "name": "Browser", "version": "6.0.1 (23)" "id": "cz.nn.helios_mobile", "installDate": "1/1/09", "name": "2N® IP Mobile", "version": "4.4.6 (474)" Restore the Homepage default setting URL: https://{{ip_addr}}/api/v1/homescreen/layoutreset HTTP method: Response code: Standard HTTP response code, treating syntactic errors.
  • Page 62 2N® Indoor Touch 2.0 API Response data: "data": { "buttons": [ "application": { "id": "com.android.documentsui", "name": "File Manager" "icon": 6, "id": 1, "label": "File Manager", "position": "application": { "id": "com.android.browser", "name": "Browser" "icon": 3, "id": 2, "label": "Browser", "position": "application": { "id": "cz.nn.helios_mobile",...
  • Page 63 2N® Indoor Touch 2.0 API 3.6.1 Buttons Getting button list Get the current list of available buttons (programmable positions for application start). URL: https://{{ip_addr}}/api/v1/homescreen/buttons HTTP method: Response code: Standard HTTP response code, treating syntactic errors. 63 /  95...
  • Page 64 2N® Indoor Touch 2.0 API Response data: "data": { "buttons": [ "application": { "id": "com.android.documentsui", "name": "File Manager" "icon": 6, "id": 1, "label": "File Manager", "position": "application": { "id": "com.android.browser", "name": "Browser" "icon": 3, "id": 2, "label": "Browser", "position": "application": { "id": "cz.nn.helios_mobile",...
  • Page 65 2N® Indoor Touch 2.0 API URL: https://{{ip_addr}}/api/v1/homescreen/buttons HTTP method: POST 65 /  95...
  • Page 66 2N® Indoor Touch 2.0 API Request body: "id": "<integer>", "position": "<integer>", "label": "<string>", "icon": "<integer>", "application": { "id": "<string>", "name": "<string>", "version": "<string>", "installDate": "<string>" Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "application": { "id": "com.android.gallery3d",...
  • Page 67 2N® Indoor Touch 2.0 API Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "application": { "id": "com.android.documentsui", "name": "File Manager" "icon": 6, "id": 1, "label": "File Manager", "position": Set the selected button URL: https://{{ip_addr}}/api/v1/homescreen/buttons/{{id}} HTTP method: Path variable: id –...
  • Page 68 2N® Indoor Touch 2.0 API Response data: "data": { "application": { "id": "com.android.gallery3d", "installDate": "1/1/09", "name": "Gallery", "version": "1.1.40030 (40030)" "icon": 7, "id": 4, "label": "test", "position": Remove button  URL: https://{{ip_addr}}/api/v1/homescreen/buttons/{{id}}   HTTP method: DELETE Path variable: id – button ID, refer to request 3.6.1...
  • Page 69 2N® Indoor Touch 2.0 API URL: https://{{ip_addr}}/api/v1/license HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "features": { "isAppInstalationAllowed": true, "isHttpApiAllowed": true, "isStockLauncherAllowed": false "key": "EJF3A-7SGBQ-UTGYC-VWV38-MKPGG", "remainingHours": 0, "state": Section setting URL: https://{{ip_addr}}/api/v1/license HTTP method:...
  • Page 70 2N® Indoor Touch 2.0 API Request body:  { "key": "<string>", "remainingHours": "<integer>", "state": "<integer>", "features": { "isHttpApiAllowed": "<boolean>", "isStockLauncherAllowed": "<boolean>", "isAppInstalationAllowed": "<boolean>" Response data:   "data": { "features": { "isAppInstalationAllowed": true, "isHttpApiAllowed": true, "isStockLauncherAllowed": false "key": "EJF3A-7SGBQ-UTGYC-VWV38-MKPGG", "remainingHours": 0, "state": 3.8 Localsettings...
  • Page 71 2N® Indoor Touch 2.0 API Response data: "data": { "language": { "id": "en-US", "name": "English (United States)" "time": { "dateTime": "10/11/19 8:46 AM", "is24hourFormatUsed": false, "isNetworkTimeUsed": true, "isoDateTime": "2019-10-11T08:46:27+0000", "timeZone": { "id": 27, "name": "GMT +00:00 Coordinated universal time (GMT)"...
  • Page 72 2N® Indoor Touch 2.0 API Request body:  { "language": { "id": "<string>", "name": "<string>" "time": { "timeZone": { "id": "<integer>", "name": "<string>" "isNetworkTimeUsed": "<boolean>", "dateTime": "<string>", "isoDateTime": "<string>", "is24hourFormatUsed": "<boolean>" "weather": { "location": "<string>", "source": "<string>", "unit": "<integer>", "updatePeriod": "<integer>"...
  • Page 73 2N® Indoor Touch 2.0 API Response data:  {{ "data": { "language": { "id": "en-US", "name": "English (United States)" "time": { "dateTime": "10/15/19 11:54 AM", "is24hourFormatUsed": false, "isNetworkTimeUsed": true, "isoDateTime": "2019-10-15T11:54:54+0000", "timeZone": { "id": 27, "name": "GMT +00:00 Coordinated universal time (GMT)"...
  • Page 74 2N® Indoor Touch 2.0 API Response data: "data": { "languages": [ "id": "af-ZA", "name": "Afrikaans" "id": "az-AZ", "name": "Azərbaycan" "id": "ja-JP", "name": "日本語" Getting list of available time zones URL: https://{{ip_addr}}/api/v1/localsettings/timezones HTTP method: Response code: Standard HTTP response code, treating syntactic errors.
  • Page 75 2N® Indoor Touch 2.0 API Response data: "data": { "timezones": [ "id": 0, "name": "GMT -11:00 Midway Island (Pacific/Midway)" "id": 1, "name": "GMT -10:00 Hawaii (Pacific/ Honolulu)" "id": 84, "name": "GMT +13:00 Tonga (Pacific/ Tongatapu)" 3.9 User and session control...
  • Page 76 2N® Indoor Touch 2.0 API HTTP method: Response code: Standard HTTP response code, treating syntactic errors. User settings URL: https://{{ip_addr}}/api/v1/user HTTP method: Request body: "oldPassword":"2n", "newPassword":"NewPass123" Response code: Standard HTTP response code, treating syntactic errors. 76 /  95...
  • Page 77 2N® Indoor Touch 2.0 API Request data: "data": { "newPassword": "NewPass123", "oldPassword": "2n" 3.10 Maintenance Getting current settings Get the current System management settings. URL: https://{{ip_addr}}/api/v1/maintenance HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "isRemoteEnabled": true,...
  • Page 78 2N® Indoor Touch 2.0 API Response data: "data": { "isRemoteEnabled": true, "isWelcomeScreenEnabled": false Factory default URL: https://{{ip_addr}}/api/v1/maintenance/factoryreset HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Device restart  URL: https://{{ip_addr}}/api/v1/maintenance/devicereset HTTP method: Response code: Standard HTTP response code, treating syntactic errors.
  • Page 79 2N® Indoor Touch 2.0 API 79 /  95...
  • Page 80 2N® Indoor Touch 2.0 API Response data: "application": { "applicationToRunAtStart": { "id": "", "installDate": "", "name": "None", "version": "" "isInstallationAllowed": false, "isReturnToApplicationOnCallEndAllowed": false, "urlToRunAtStart": "" "audio": { "alarmsVolume": 0, "musicVolume": 13, "ringtoneVolume": "display": { "brightness": 37, "isBlueLedNotificationActive": true, "turnOffDisplayDelay": "fwVersion": "4.2.0", "hipmo": {...
  • Page 81 2N® Indoor Touch 2.0 API "doorButton": { "bypassDnd": false, "invertInput": true, "isEnabled": false, "maxRingingTime": 30, "minRingingTime": 3, "usedInput": "externalRing": { "bypassDnd": false, "invertOutput": true, "isEnabled": false, "maxRingingTime": 30, "minRingingTime": 3, "usedOutput": "general": { "autosnapshot": true, "customLanguage": false, "deactivationTimeout": 1, "hipGroupPassword": "", "isReceivingMulticastActive": false,...
  • Page 82 2N® Indoor Touch 2.0 API "sipRandomPort": 5060, "userName": "111" "homescreen": { "buttons": [ "application": { "id": "com.android.documentsui", "name": "File Manager" "icon": 6, "id": 1, "label": "File Manager", "position": "application": { "id": "com.android.browser", "name": "Browser" "icon": 3, "id": 2, "label": "Browser", "position":...
  • Page 83 2N® Indoor Touch 2.0 API "localsettings": { "languageId": "en-US", "time": { "dateTime": "10/15/19 12:47 PM", "is24hourFormatUsed": false, "isNetworkTimeUsed": true, "isoDateTime": "2019-10-15T12:47:50+0000", "timeZoneId": "weather": { "location": "Prague,CZ", "unit": 0, "updatePeriod": "maintenance": { "isRemoteEnabled": true, "isWelcomeScreenEnabled": false "network": { "dns": "10.0.100.101", "gateway": "10.27.0.1", "ipAddress": "10.27.5.173",...
  • Page 84 2N® Indoor Touch 2.0 API URL: https://{{ip_addr}}/api/v1/maintenance/upgrade HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "fwVersion": "4.2.0", "isDowngrade": false, "status": 0, "wipeData": false Upload firmware URL: https://{{ip_addr}}/api/v1/maintenance/upgrade/upload HTTP method: Request body: form-data: •...
  • Page 85 2N® Indoor Touch 2.0 API Response data: "data": { "fwVersion": "4.2.0", "isDowngrade": false, "status": 1, "wipeData": false Start upgrade  URL: https://{{ip_addr}}/api/v1/maintenance/upgrade/start HTTP method: Request body: {"wipeData":true} Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "fwVersion": "4.2.0", "isDowngrade": false,...
  • Page 86 2N® Indoor Touch 2.0 API Response data: "data": { "fwVersion": "4.2.0", "isDowngrade": false, "status": 0, "wipeData": true 3.10.3 Logs Getting basic log archives URL: https://{{ip_addr}}/api/v1/maintenance/logs/simple HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Response data: Log archive file Getting all device log archives ...
  • Page 87 2N® Indoor Touch 2.0 API HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "useWebPassword": true Access setting Set different access passwords for the web interface and system settings. URL: https://{{ip_addr}}/api/v1/maintenance/security HTTP method: Request body: "useWebPassword":...
  • Page 88 2N® Indoor Touch 2.0 API Response code: Standard HTTP response code, treating syntactic errors. 88 /  95...
  • Page 89 2N® Indoor Touch 2.0 API Response data: "data": { "accessSettingsPasswordType": Set the System settings access URL: https://{{ip_addr}}/api/v1/maintenance/security/ settings/access HTTP method: Request body: "accessSettingsPasswordType": "<integer>", "password": "<string>" Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "accessSettingsPasswordType": 1, "password":...
  • Page 90 2N® Indoor Touch 2.0 API Request body: "password": "<string>"  Caution Make sure that the password meets the minimum password setting requirements, refer to Security. Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "password": "Test12345"...
  • Page 91 2N® Indoor Touch 2.0 API Change of current settings   Caution  You can only turn the lock screen off/on using this endpoint. The lock screen cannot be configured via a web interface. URL: https://{{ip_addr}}/api/v1/maintenance/security/ lockscreen HTTP method: Request body: "isEnabled": "<boolean>"...
  • Page 92 2N® Indoor Touch 2.0 API Response data: "data": { "dns": "8.8.8.8", "gateway": "192.168.1.1", "ipAddress": "192.168.1.173", "isDhcpEnabled": true, "isEthernetEnabled": true, "mask": "255.255.255.0" Section setting  URL: https://{{ip_addr}}/api/v1/network HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Request body:  { "isDhcpEnabled": "<boolean>", "isEthernetEnabled": "<boolean>",...

  • Page 93: Supplementary Information

    2N® Indoor Touch 2.0 API 4. Supplementary Information • 4.1 Directives, Laws and Regulations – General Instructions and Cautions 4.1 Directives, Laws and Regulations – General Instructions and Cautions Please read this User Manual carefully before using the product. Follow all instructions and recommendations included herein.
  • Page 94 2N® Indoor Touch 2.0 API The consumer shall, without delay, change the access password for the product after installation. The manufacturer shall not be held liable or responsible for any damage incurred by the consumer in connection with the use of the original password.
  • Page 95 2N® Indoor Touch 2.0 API 95 /  95...