Download
Share
Print this page
Axis 2N Indoor Touch 2.0 Api Manual
  1. Manuals
  2. Brands
  3. Axis Manuals
  4. Intercom System
  5. 2N Indoor Touch 2.0
  6. Api manual

Axis 2N Indoor Touch 2.0 Api Manual

Hide thumbs Also See for 2N Indoor Touch 2.0:

Advertisement

Quick Links

Download this manual
®
2N Indoor Touch 2.0
Firmware:
4.2.2
Version:
4.2.2
API guide
www.2n.cz

Advertisement

loading
Need help?

Need help?

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

Questions and answers

Related Manuals for Axis 2N Indoor Touch 2.0

Summary of Contents for Axis 2N Indoor Touch 2.0

  • Page 1 ® 2N Indoor Touch 2.0 API guide Firmware: 4.2.2 Version: 4.2.2 www.2n.cz...
  • Page 2 The 2N TELEKOMUNIKACE a.s. is a Czech manufacturer and supplier of telecommunications equipment. The product family developed by 2N TELEKOMUNIKACE a.s. includes GSM gateways, private branch exchanges (PBX), and door and lift communicators. 2N TELEKOMUNIKACE a.s. has been ranked among the Czech top companies for years and represented a symbol of stability and prosperity on the telecommunications market for almost two decades.
  • Page 3 Content: 1. Purpose of Document 2. HTTP API 3. WEB API 4. Supplementary Information 2N TELEKOMUNIKACE a.s., www.2n.cz 3/94...
  • Page 4 1. Purpose of Document ® Indoor Touch 2.0 HTTP API provides third party applications a possibility to ® configure and control selected system parts and the IP Mobile calling application. Caution The HTTP API service is licensed under the 91378395 2N Indoor Touch HTTP API license 2N TELEKOMUNIKACE a.s., www.2n.cz 4/94...
  • Page 5 2. HTTP API 2.1 Interface 2.1.1 Authentication 2.1.2 Requests 2.1.3 Responses to Requests 2.1.4 Cautions 2.2 Commands 2.2.1 Session Control 2.2.1.1 Login 2.2.1.2 Logout 2.2.2 GPIO 2.2.2.1 GPIO List Getting 2.2.2.2 GPIO Value Setting 2.2.3 2N® IP Mobile Control 2.2.3.1 Call Setup 2.2.3.2 Call Termination 2.2.3.3 Call State 2.2.3.4 2N IP Intercom List Getting...
  • Page 6 2.1 Interface Communication is made via the HTTPS protocol, which runs on standardized port 443. Authentication requires login and password data to be transmitted in the first connection. Subsequently, the server returns the client a cookie with a session key for further requests.
  • Page 7 If the data to be transferred is rather extensive, store the data in the JSON format in HTTP request body (Content-Type: application/json; charset=UTF-8). Refer to the list of command parameters for these exceptions. The HTTP method GET is used for the requests that do not transmit data. The PUT method is used for the requests that include data.
  • Page 8 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 API despite not being documented. API now supports just one web interface login at a time.
  • Page 9 2.2 Commands 2.2.1 Session Control 2.2.2 GPIO 2.2.3 2N® IP Mobile Control 2.2.4 System 2.2.1 Session Control 2.2.1.1 Login 2.2.1.2 Logout 2.2.1.1 Login The login helps you get access to the selected HTTPS session using a username and password. The login is Admin by default and the password is identical with the device web interface access password.
  • Page 10 2.2.2 GPIO 2.2.2.1 GPIO List Getting 2.2.2.2 GPIO Value Setting 2.2.2.1 GPIO List Getting The list of GPIOs stored in the array container is returned. Name {in1, in2, out1, out2, io1, io2, relay1, relay2} is the input identifier that is subsequently used for GPIO identification in the HTTP API communication too.
  • Page 11 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": "id": 6, "name": "Relay1", "value": "id": 7, "name": "Relay2",...
  • Page 12 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} Caution The request body must include valid json with one GPIO at least. URL: https:// {{ip_addr}}...
  • Page 13 "name": "Out2", "id": "value" "name": "IO1", "id": "value" "name": "IO2", "id": "value" "name": "Relay1", "id": "value" "name": "Relay2", "id": "value" Response code: Standard HTTP response. 2N TELEKOMUNIKACE a.s., www.2n.cz 13/94...
  • Page 14 Response data: "data": { "pins": [ "id": "name": "In1", "value" "id": "name": "In2", "value" "id": "name": "Out1", "value" "id": "name": "Out2", "value" "id": "name": "IO1", "value" "id": "name": "IO2", 2N TELEKOMUNIKACE a.s., www.2n.cz 14/94...
  • Page 15 "value" "id": "name": "Relay1", "value" "id": "name": "Relay2", "value" 2N TELEKOMUNIKACE a.s., www.2n.cz 15/94...
  • Page 16 2.2.3 2N® IP Mobile Control 2.2.3.1 Call Setup 2.2.3.2 Call Termination 2.2.3.3 Call State 2.2.3.4 2N IP Intercom List Getting 2.2.3.5 Change of Items in Added 2N IP Intercom List 2.2.3.6 2N® IP Mobile Minimization 2.2.3.7 2N® IP Mobile State Info 2.2.3.8 2N®...
  • Page 17 2.2.3.2 Call Termination Terminates the active call. URL: https:// {{ip_addr}} /api/v1/hipm/call/hangup HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "state": "IncomingReceived" 2.2.3.3 Call State Get the current state of the call processing layer as one of the strings below: {Idle, IncomingReceived, OutgoingInit, OutgoingProgress, OutgoingRinging, OutgoingEarlyMedia, Connected, StreamsRunning, Pausing, Paused, Resuming, Refered, Error, CallEnd, PausedByRemote,...
  • Page 18 2.2.3.4 2N IP Intercom List Getting ® Get the list of the 2N IP intercoms that are registered with 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. Response data: "data": { "devices": [...
  • Page 19 URL: https:// {{ip_addr}} /api/v1/hipm/devices HTTP method: PATCH Request body: "devices": [ "isActive": true, "id": Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "devices": [ "id": 255, "isActive": true 2.2.3.6 2N® IP Mobile Minimization ® ® Send the IP Mobile application to the background (displaying the...
  • Page 20 2.2.3.7 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": { "isRunning": true 2.2.3.8 2N®...
  • Page 21 URL: https://<IP>/api/ v1/status HTTP method: Request body: Response code: Standard HTTP response code, treating syntactic errors. 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,...
  • Page 22 Meaning of items: device fwVersion – device firmware version hwVersion – device hardware version isNfcCapable – true if NFC support is available isWifiCapable – true if a wi-fi interface is available lanMac – Ethernet interface MAC address model – device model os –...
  • Page 23 2.2.4.2 2N® Indoor Touch Restart ® Restart the 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. 2N TELEKOMUNIKACE a.s., www.2n.cz 23/94...
  • Page 24 3. WEB API ® WEB API incudes a set of endpoints that are used in the Indoor Touch 2.0 interface. 3.10 Maintenance 3.11 Network 3.1 Device info 3.2 Application 3.3 Audio 3.4 Display 3.5 IP Mobile 3.6 Homescreen 3.7 License 3.8 Localsettings 3.9 User and session control 2N TELEKOMUNIKACE a.s., www.2n.cz...
  • Page 25 3.1 Device info About Get basic information on the device. URL: https:// {{ip_addr}} /api/v1/about HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "buildDate": "9/30/19 2:44 AM", "fwVersion": "4.2.0", "hwVersion": 1, "incrementalVersion": "user. 28727", "model": "2N Indoor Touch 2.0",...
  • Page 26 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" "memory": { "available": 1208, "total": 1760 "sdCard": {...
  • Page 27 3.2 Application Getting current settings Get the Application settings. URL: https:// {{ip_addr}} /api/v1/application HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "isInstallationAllowed": false, "isReturnToApplicationOnCallEndAl lowed": false Section configuration Set the values in the Application section.
  • Page 28 Request body: "applicationToRunAtStart":{ "id":"", "installDate":"", "name":"None", "version":"" "isInstallationAllowed":false, "isReturnToApplicationOnCallEndAllowed ":false, "urlToRunAtStart":"" Response data: "data": { "applicationToRunAtStart": { "id": "", "installDate": "", "name": "None", "version": "" "isInstallationAllowed": false, "isReturnToApplicationOnCallEndAl lowed": false, "urlToRunAtStart": "" List of available applications Get a list of available applications. URL: https:// {{ip_addr}}...
  • Page 29 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", "name": "Music", "version":...
  • Page 30 "version": "1.1.40030 (40030)" "id": "com.android. calculator2", "installDate": "1/1/09", "name": "Calculator", "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)"...
  • Page 31 3.3 Audio Getting current settings Get the current Audio settings. URL: https:// {{ip_addr}} /api/v1/audio HTTP method: Response code: Standard HTTP response code, treating syntactic errors. 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.
  • Page 32 Response data: "data": { "alarmsVolume": 0, "musicVolume": 13, "ringtoneVolume": 2N TELEKOMUNIKACE a.s., www.2n.cz 32/94...
  • Page 33 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, "isBlueLedNotificationActive": "turnOffDisplayDelay": Section setting URL: https:// {{ip_addr}} /api/v1/display HTTP method: Response code: Standard HTTP response code, treating syntactic errors.
  • Page 34 Response data: "data": { "brightness": 37, "isBlueLedNotificationActive": "turnOffDisplayDelay": 2N TELEKOMUNIKACE a.s., www.2n.cz 34/94...
  • Page 35 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, "isExternalRingEnabled": false, "isMy2nProxyEnabled": false, "isRecorderEnabled": false, "isRunning": true, "isSipProxyEnabled": true, "proxyState": Application restart URL:...
  • Page 36 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 URL: https:// {{ip_addr}} /api/v1/hipmo HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "deviceName":...
  • Page 37 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, "deactivationTimeout": 1, "hipGroupPassword": "", "isReceivingMulticastActive":...
  • Page 38 Request body: "hipGroupPassword": "<string>", "settingsPassword": "<string>", "autosnapshot": "<boolean>", "pushToTalk": "<boolean>", "logging": "<boolean>", "multicastDiscovery": "<boolean>", "customLanguage": "<boolean>", "isReceivingMulticastActive": "<boole an>", "deactivationTimeout": "<integer>" Response data: "data": { "autosnapshot": true, "customLanguage": false, "deactivationTimeout": 1, "hipGroupPassword": "", "isReceivingMulticastActive": "logging": false, "multicastDiscovery": true, "pushToTalk": false, "settingsPassword": ""...
  • Page 39 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. Request body: "ringtone": { "uri": "<string>", "name":...
  • Page 40 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. code: 2N TELEKOMUNIKACE a.s., www.2n.cz 40/94...
  • Page 41 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" 2N TELEKOMUNIKACE a.s., www.2n.cz 41/94...
  • Page 42 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": "", "port": 5060, "protocol": 1, "registrar": {...
  • Page 43 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, "name": "IndoorTouch", "password": "", "port": 5060, "protocol": 1,...
  • Page 44 URL: https:// {{ip_addr}} /api/v1 /hipmo/settings/recorder 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. Request body: "activationTimeout":0, "announcementType":0,...
  • Page 45 3.5.6 Doorbutton Getting current settings Get the current doorbell button settings. 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:...
  • Page 46 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. Response data: "data": { "bypassDnd": false,...
  • Page 47 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. URL: https:// {{ip_addr}} /api/v1/ hipmo/settings/dnd...
  • Page 48 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. 2N TELEKOMUNIKACE a.s., www.2n.cz 48/94...
  • Page 49 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, "startTime": "00:00" 3.5.9 My2N Getting current settings Get the current My2N settings.
  • Page 50 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. Request body: "isEnabled": "<boolean>", "deviceId": "<string>",...
  • Page 51 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" "id": 242, "ip": "10.27.21.10", "isActive": false,...
  • Page 52 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": [ "id": 148, "ip": "10.27.6.213", "isActive": false, "name":...
  • Page 53 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": [ "id": 148, "ip": "10.27.6.213", "isActive": false,...
  • Page 54 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 55 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>", "sipLine": "<string>", "dtmf1": "<string>", "dtmf2": "<string>",...
  • Page 56 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. Request body: "id": "<integer>", "name": "<string>", "isActive": "<boolean>",...
  • Page 57 3.6 Homescreen Getting current settings Get the current Homepage settings. URL: https:// {{ip_addr}} /api/v1/homescreen HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "buttons": [ "application": { "id": "com.android. documentsui", "name": "File Manager" "icon": 6, "id": 1, "label": "File...
  • Page 58 "label": "Intercoms", "position": "application": { "id": "com.android. gallery3d", "name": "Gallery" "icon": 7, "id": 4, "label": "Gallery", "position": "application": { "id": "com.axis.acs", "name": "Camera Station" "icon": 0, "id": 5, "position": "isClockOnlyModeActive": false Section setting URL: https:// {{ip_addr}} /api/v1/homescreen HTTP method: Request body: "isClockOnlyModeActive":...
  • Page 59 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. 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...
  • Page 60 "id": "com.android. deskclock", "installDate": "1/1/09", "name": "Clock", "version": "4.1.0 (410)" "id": "com.android. gallery3d", "installDate": "1/1/09", "name": "Gallery", "version": "1.1.40030 (40030)" "id": "com.android. calculator2", "installDate": "1/1/09", "name": "Calculator", "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.
  • Page 61 HTTP method: Response code: Standard HTTP response code, treating syntactic errors. 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",...
  • Page 62 "id": 4, "label": "Gallery", "position": "isClockOnlyModeActive": false 3.6.1 Buttons 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. Response data: "data": { "buttons": [...
  • Page 63 "label": "Browser", "position": "application": { "id": "cz.nn. helios_mobile", "name": "2N® IP Mobile" "icon": 8, "id": 3, "label": "Intercoms", "position": "application": { "id": "com.android. gallery3d", "name": "Gallery" "icon": 7, "id": 4, "label": "Gallery", "position": Create a new button URL: https:// {{ip_addr}} /api/v1 /homescreen/buttons HTTP method: POST...
  • Page 64 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" "installDate": "1/1/09", "name": "Gallery", "version": "1.1.40030 (40030)"...
  • Page 65 Path variable: id – button ID, refer to request 3.6.1 Buttons 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://...
  • Page 66 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 Buttons Request body: "id": "<integer>", "position": "<integer>",...
  • Page 67 3.7 License Getting current settings Get the current license settings. URL: https:// {{ip_addr}} /api/v1/license HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "features": { "isAppInstalationAllowed": "isHttpApiAllowed": true, "isStockLauncherAllowed": "key": "EJF3A-7SGBQ-UTGYC-VWV38- MKPGG", "remainingHours": 0, "state": Section setting URL:...
  • Page 68 Request body: "key": "<string>", "remainingHours": "<integer>", "state": "<integer>", "features": { "isHttpApiAllowed": "<boolean>", "isStockLauncherAllowed": "<boole an>", "isAppInstalationAllowed": "<bool ean>" Response data: "data": { "features": { "isAppInstalationAllowed": "isHttpApiAllowed": true, "isStockLauncherAllowed": "key": "EJF3A-7SGBQ-UTGYC-VWV38- MKPGG", "remainingHours": 0, "state": 2N TELEKOMUNIKACE a.s., www.2n.cz 68/94...
  • Page 69 3.8 Localsettings Getting current settings Get the current Local settings values. URL: https:// {{ip_addr}} /api/v1/localsettings HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "language": { "id": "en-US", "name": "English (United States)" "time": { "dateTime": "10/11/19 8:46 AM",...
  • Page 70 HTTP method: Response code: Standard HTTP response code, treating syntactic errors. 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 71 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)" "weather": { "location": "Prague,CZ", "source": "www.openweathermap.
  • Page 72 Response data: "data": { "languages": [ "id": "af-ZA", "name": "Afrikaans" "id": "az-AZ", "name": "Azrbaycan" "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. 2N TELEKOMUNIKACE a.s., www.2n.cz 72/94...
  • Page 73 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)" 2N TELEKOMUNIKACE a.s., www.2n.cz 73/94...
  • Page 74 3.9 User and session control User login URL: https:// {{ip_addr}} /api/v1/login HTTP method: Response code: Standard HTTP response code, treating syntactic errors. Request body: "login":"admin", "password":"2n" User logout URL: https:// {{ip_addr}} /api/v1/logout HTTP method: Response code: Standard HTTP response code, treating syntactic errors. User settings URL: https://...
  • Page 75 Request data: "data": { "newPassword": "NewPass123", "oldPassword": "2n" 2N TELEKOMUNIKACE a.s., www.2n.cz 75/94...
  • Page 76 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, "isWelcomeScreenEnabled": false Section setting URL: https:// {{ip_addr}} /api/v1 /maintenance HTTP method: Request body:...
  • Page 77 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. 3.10.1 Config 3.10.2 Upgrade 3.10.3 Logs...
  • Page 78 Response data: "application": { "applicationToRunAtStart": { "id": "", "installDate": "", "name": "None", "version": "" "isInstallationAllowed": false, "isReturnToApplicationOnCallEndAll owed": false, "urlToRunAtStart": "" "audio": { "alarmsVolume": 0, "musicVolume": 13, "ringtoneVolume": "display": { "brightness": 37, "isBlueLedNotificationActive": "turnOffDisplayDelay": "fwVersion": "4.2.0", "hipmo": { "call": { "autoCallPickup": false, "autoCallPickupDelay": 0, "ringtoneUri":...
  • Page 79 "startTime": "00:00" "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, "logging": false, "multicastDiscovery": true, "pushToTalk": false,...
  • Page 80 "sipPortRandomization": false, "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": "application": { "id": "cz.nn.
  • Page 81 "isClockOnlyModeActive": false "licence": { "key": "EJF3A-7SGBQ-UTGYC-VWV38- MKPGG" "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 82 Response code: Standard HTTP response code, treating syntactic errors. 3.10.2 Upgrade Upgrade state info 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...
  • Page 83 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, "status": 2, "wipeData": true...
  • Page 84 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 URL: https:// {{ip_addr}}...
  • Page 85 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": true Response code: Standard HTTP response code, treating syntactic errors.
  • Page 86 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": "test" Set the administrator access password URL: https://...
  • Page 87 Request body: "password": "<string>" Caution Make sure that the password meets the minimum password setting requirements, refer to Security Response Standard HTTP response code, treating syntactic errors. code: Response data: "data": { "password": "Test12345" 3.10.4.1 Lockscreen 3.10.4.1 Lockscreen Getting current settings Getting information on screen lock settings URL: https://...
  • Page 88 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>" Response code: Standard HTTP response code, treating syntactic errors. Response data: "data": { "isEnabled":...
  • Page 89 3.11 Network Getting current settings Get the current Network settings. URL: https:// {{ip_addr}} /api/v1/network HTTP method: Response code: Standard HTTP response code, treating syntactic errors. 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"...
  • Page 90 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" 2N TELEKOMUNIKACE a.s., www.2n.cz 90/94...
  • Page 91 4. Supplementary Information 4.1 Directives, Laws and Regulations – General Instructions and Cautions 2N TELEKOMUNIKACE a.s., www.2n.cz 91/94...
  • Page 92 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. Any use of the product that is in contradiction with the instructions provided herein may result in malfunction, damage or destruction of the product.
  • Page 93 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. The manufacturer also assumes no responsibility for additional costs incurred by the consumer as a result of making calls using a line with an increased tariff.
  • Page 94 2N TELEKOMUNIKACE a.s. Modřanská 621, 143 01 Prague 4, Czech Republic Phone: +420 261 301 500, Fax: +420 261 301 599 E-mail: sales@2n.cz Web: www.2n.cz v4.2.2 2N TELEKOMUNIKACE a.s., www.2n.cz 94/94...