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 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 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 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 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 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 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.
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