manualshive.com logo in svg

Axis 2N Indoor Touch 2.0, Api Manual

Share
Download
Axis 2N Indoor Touch 2.0 Api Manual Download Page 4

2N TELEKOMUNIKACE a.s., www.2n.cz

4/94

1. Purpose of Document

HTTP  API 

2N   Indoor  Touch  2.0 

®

provides  third  party  applications  a  possibility  to 

configure and control selected system parts and the 

 calling application.

2N  IP Mobile

®

Caution

The  HTTP  API  service  is  licensed  under  the 

 

91378395 2N  Indoor  Touch 

.

HTTP API license

Summary of Contents for 2N Indoor Touch 2.0

Page 1: ...www 2n cz 2N Indoor Touch 2 0 API guide Firmware 4 2 2 Version 4 2 2...

Page 2: ...ademarks and or trademarks or brands protected by law 2N TELEKOMUNIKACE a s administers the FAQ database to help you quickly find information and to answer your questions about 2N products and service...

Page 3: ...2N TELEKOMUNIKACE a s www 2n cz 3 94 Content 1 Purpose of Document 2 HTTP API 3 WEB API 4 Supplementary Information...

Page 4: ...HTTP API 2N Indoor Touch 2 0 provides third party applications a possibility to configure and control selected system parts and the calling application 2N IP Mobile Caution The HTTP API service is li...

Page 5: ...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 2 2 3 5 Change...

Page 6: ...2 1 1 Authentication 2N Indoor Touch 2 0 supports the following two types of authentication Basic Basic authentication is required according to The service RFC 2617 requires a password which however i...

Page 7: ...ommands For example there may be no information on successful execution of the commands that 2N IP Mobile resends to the 2N IP intercoms and so the value cannot be reported Such commands include the P...

Page 8: ...web interface login at a time Hence if a web interface is open and the user logs into another one API will log the user out of the first one This will become obvious when the user enters another requ...

Page 9: ...by default and the password is identical with the device web interface access password URL https IP api v1 login HTTP method PUT Request body login username password password Response code 200 if eve...

Page 10: ...Os 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 Di...

Page 11: ...ww 2n cz 11 94 Response data data pins id 0 name In1 value 1 id 1 name In2 value 1 id 2 name Out1 value 7 id 3 name Out2 value 7 id 4 name IO1 value 1 id 5 name IO2 value 1 id 6 name Relay1 value 0 id...

Page 12: ...status change Parameters Name GPIO name refer to 2 2 2 1 Getting List of GPIO Inputs and Outputs can be 0 1 Value Caution The request body must include valid json with one GPIO at least URL ip_addr ht...

Page 13: ...2N TELEKOMUNIKACE a s www 2n cz 13 94 name Out2 id 3 value 7 name IO1 id 4 value 1 name IO2 id 5 value 1 name Relay1 id 6 value 0 name Relay2 id 7 value 0 Response code Standard HTTP response...

Page 14: ...2N TELEKOMUNIKACE a s www 2n cz 14 94 Response data data pins id 0 name In1 value 1 id 1 name In2 value 1 id 2 name Out1 value 7 id 3 name Out2 value 7 id 4 name IO1 value 1 id 5 name IO2...

Page 15: ...2N TELEKOMUNIKACE a s www 2n cz 15 94 value 1 id 6 name Relay1 value 0 id 7 name Relay2 value 0...

Page 16: ...ing 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 IP Mobile Restart 2 2 3 1 Call Setup Set up a call URL ip_addr sip...

Page 17: ...processing layer as one of the strings below Idle IncomingReceived OutgoingInit OutgoingProgress OutgoingRinging OutgoingEarlyMedia Connected StreamsRunning Pausing Paused Resuming Refered Error CallE...

Page 18: ...Standard HTTP response code treating syntactic errors Response data data devices id 255 ip 10 0 24 55 isActive false name 2N IP Verso serialNumber 54 0776 0059 id 256 ip 10 0 24 135 isActive false nam...

Page 19: ...HTTP response code treating syntactic errors Response data data devices id 255 isActive true 2 2 3 6 2N IP Mobile Minimization Send the application to the background displaying the 2N IP Mobile 2N In...

Page 20: ...se data data isRunning true 2 2 3 8 2N IP Mobile Restart Restart if running and start if not running 2N IP Mobile 2N IP Mobile URL https IP api v1 hipm reset HTTP method PUT Request body N A Response...

Page 21: ...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 uptim...

Page 22: ...mperature device temperature 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...

Page 23: ...2n cz 23 94 2 2 4 2 2N Indoor Touch Restart Restart the unit 2N Indoor Touch 2 0 URL https IP api v1 maintenance devicereset HTTP method PUT Request body N A Response code Standard HTTP response code...

Page 24: ...incudes a set of endpoints that are used in the web 2N 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...

Page 25: ...ard 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 serialNumber 52 2101 0...

Page 26: ...pable 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 t...

Page 27: ...hod GET Response code Standard HTTP response code treating syntactic errors Response data data isInstallationAllowed false isReturnToApplicationOnCallEndAl lowed false Section configuration Set the va...

Page 28: ...rlToRunAtStart Response data data applicationToRunAtStart id installDate name None version isInstallationAllowed false isReturnToApplicationOnCallEndAl lowed false urlToRunAtStart List of available ap...

Page 29: ...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 id com android documentsui installDate 1 1 09...

Page 30: ...nstallDate 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 versi...

Page 31: ...method GET Response code Standard HTTP response code treating syntactic errors Response data data alarmsVolume 86 musicVolume 73 ringtoneVolume 71 Section setting URL ip_addr https api v1 audio HTTP...

Page 32: ...2N TELEKOMUNIKACE a s www 2n cz 32 94 Response data data alarmsVolume 0 musicVolume 13 ringtoneVolume 14...

Page 33: ...code Standard HTTP response code treating syntactic errors Response data data brightness 100 isBlueLedNotificationActive tr ue turnOffDisplayDelay 2 Section setting URL ip_addr https api v1 display H...

Page 34: ...2N TELEKOMUNIKACE a s www 2n cz 34 94 Response data data brightness 37 isBlueLedNotificationActive tr ue turnOffDisplayDelay 1...

Page 35: ...se code treating syntactic errors Response data data isDndEnabled false isDoorButtonEnabled false isExternalRingEnabled false isMy2nProxyEnabled false isRecorderEnabled false isRunning true isSipProxy...

Page 36: ...evices 3 5 1 Device name Getting device name setting URL ip_addr https api v1 hipmo HTTP method GET Response code Standard HTTP response code treating syntactic errors Response data data deviceName id...

Page 37: ...onse code Standard HTTP response code treating syntactic errors Response data data autosnapshot true customLanguage false deactivationTimeout 1 hipGroupPassword isReceivingMulticastActive fal se loggi...

Page 38: ...castActive boole an deactivationTimeout integer Response data data autosnapshot true customLanguage false deactivationTimeout 1 hipGroupPassword isReceivingMulticastActive fal se logging false multica...

Page 39: ...name Flutey Phone uri content media internal audio media 175 Section setting URL ip_addr https api v1 hipmo settings call HTTP method PUT Response code Standard HTTP response code treating syntactic e...

Page 40: ...upDelay 0 customRingtone false isEarlyMediaEnabled true ringtone name Flutey Phone uri content media internal audio media 175 Getting list of ringtones URL ip_addr https api v1 hipmo settings call rin...

Page 41: ...2N TELEKOMUNIKACE a s www 2n cz 41 94 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...

Page 42: ...rd HTTP response code treating syntactic errors Response data data ipAddress isEnabled false name IndoorTouch password port 5060 protocol 1 registrar expiry 120 ipAddress isEnabled false port 5060 sip...

Page 43: ...ean sipRandomPort integer registrar ipAddress string isEnabled boolean expiry integer port integer Response data data ipAddress isEnabled false name IndoorTouch password port 5060 protocol 1 registrar...

Page 44: ...ors Response data data activationTimeout 0 announcementType 0 isEnabled false Section setting URL ip_addr https api v1 hipmo settings recorder HTTP method PUT Response code Standard HTTP response code...

Page 45: ...de treating syntactic errors Response data data bypassDnd false invertInput true isEnabled false maxRingingTime 30 minRingingTime 3 usedInput 0 Section setting URL ip_addr https api v1 hipmo settings...

Page 46: ...notification settings URL ip_addr https api v1 hipmo settings externalring HTTP method GET Response code Standard HTTP response code treating syntactic errors Response data data bypassDnd false inver...

Page 47: ...integer maxRingingTime integer Response data data bypassDnd false invertOutput true isEnabled false maxRingingTime 30 minRingingTime 3 usedOutput 0 3 5 8 DND Getting current settings Get the current...

Page 48: ...data dnd isEnabled false time 0 dndNight days 5 1 4 2 3 0 6 endTime 00 00 isEnabled false startTime 00 00 Section setting URL ip_addr https api v1 hipmo settings dnd HTTP method PUT Response code Sta...

Page 49: ...e integer dndNight isEnabled boolean startTime string endTime string days integer integer Response data data dnd isEnabled false time 0 dndNight days 5 1 4 2 3 0 6 endTime 00 00 isEnabled false startT...

Page 50: ...treating syntactic errors Response data data deviceId isEnabled false password Section setting URL ip_addr https api v1 hipmo settings my2n HTTP method PUT Response code Standard HTTP response code t...

Page 51: ...TP 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 name 2N IP Force sip...

Page 52: ...Getting list of LAN devices URL ip_addr https api v1 hipmo devices lan HTTP method GET Response code Standard HTTP response code treating syntactic errors Response data data devices id 148 ip 10 27 6...

Page 53: ...PUT 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 1...

Page 54: ...dard HTTP response code treating syntactic errors Response data data devices Create SIP device URL ip_addr https api v1 hipmo devices sip HTTP method PUT Response code Standard HTTP response code trea...

Page 55: ...ng dtmf2 string dtmf3 string dtmf4 string SIP device update URL ip_addr https api v1 hipmo devices sip id HTTP method PUT Path variable id device ID Request body id integer name string isActive boolea...

Page 56: ...ing dtmf2 string dtmf3 string dtmf4 string Delete device URL ip_addr https api v1 hipmo devices sip id HTTP method DELETE Path variable id device ID Response code Standard HTTP response code treating...

Page 57: ...ethod GET 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 positio...

Page 58: ...icon 7 id 4 label Gallery position 4 application id com axis acs name Camera Station icon 0 id 5 position 5 isClockOnlyModeActive false Section setting URL ip_addr https api v1 homescreen HTTP method...

Page 59: ...d GET 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 instal...

Page 60: ...m 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...

Page 61: ...buttons application id com android documentsui name File Manager icon 6 id 1 label File Manager position 1 application id com android browser name Browser icon 3 id 2 label Browser position 2 applicat...

Page 62: ...lable buttons programmable positions for application start URL ip_addr https api v1 homescreen buttons HTTP method GET Response code Standard HTTP response code treating syntactic errors Response data...

Page 63: ...2 application id cz nn helios_mobile name 2N IP Mobile icon 8 id 3 label Intercoms position 3 application id com android gallery3d name Gallery icon 7 id 4 label Gallery position 4 Create a new button...

Page 64: ...stallDate 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 ico...

Page 65: ...entsui name File Manager icon 6 id 1 label File Manager position 1 Set the selected button URL ip_addr https api v1 homescreen buttons id HTTP method PUT Path variable id button ID refer to request 3...

Page 66: ...label test position 5 Remove button URL ip_addr https 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: ...e code Standard HTTP response code treating syntactic errors Response data data features isAppInstalationAllowed tr ue isHttpApiAllowed true isStockLauncherAllowed fal se key EJF3A 7SGBQ UTGYC VWV38 M...

Page 68: ...r state integer features isHttpApiAllowed boolean isStockLauncherAllowed boole an isAppInstalationAllowed bool ean Response data data features isAppInstalationAllowed tr ue isHttpApiAllowed true isSto...

Page 69: ...se code treating syntactic errors 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 11T...

Page 70: ...response code treating syntactic errors Request body language id string name string time timeZone id integer name string isNetworkTimeUsed boolean dateTime string isoDateTime string is24hourFormatUse...

Page 71: ...workTimeUsed 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 org unit 0 updatePeriod 0 Getti...

Page 72: ...ta data languages id af ZA name Afrikaans id az AZ name Azrbaycan id ja JP name Getting list of available time zones URL ip_addr https api v1 localsettings timezones HTTP method GET Response code Stan...

Page 73: ...TELEKOMUNIKACE a s www 2n cz 73 94 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 Tongata...

Page 74: ...reating syntactic errors Request body login admin password 2n User logout URL ip_addr https api v1 logout HTTP method PUT Response code Standard HTTP response code treating syntactic errors User setti...

Page 75: ...2N TELEKOMUNIKACE a s www 2n cz 75 94 Request data data newPassword NewPass123 oldPassword 2n...

Page 76: ...HTTP method GET Response code Standard HTTP response code treating syntactic errors Response data data isRemoteEnabled true isWelcomeScreenEnabled false Section setting URL ip_addr https api v1 maint...

Page 77: ...yntactic errors Device restart URL ip_addr https api v1 maintenance devicereset HTTP method PUT Response code Standard HTTP response code treating syntactic errors 3 10 1 Config 3 10 2 Upgrade 3 10 3...

Page 78: ...dAll owed false urlToRunAtStart audio alarmsVolume 0 musicVolume 13 ringtoneVolume 14 display brightness 37 isBlueLedNotificationActive tru e turnOffDisplayDelay 1 fwVersion 4 2 0 hipmo call autoCallP...

Page 79: ...Time 3 usedOutput 0 general autosnapshot true customLanguage false deactivationTimeout 1 hipGroupPassword isReceivingMulticastActive false logging false multicastDiscovery true pushToTalk false settin...

Page 80: ...roid documentsui name File Manager icon 6 id 1 label File Manager position 1 application id com android browser name Browser icon 3 id 2 label Browser position 2 application id cz nn helios_mobile nam...

Page 81: ...2019 10 15T12 47 50 0000 timeZoneId 27 weather location Prague CZ unit 0 updatePeriod 0 maintenance isRemoteEnabled true isWelcomeScreenEnabled false network dns 10 0 100 101 gateway 10 27 0 1 ipAddre...

Page 82: ...aintenance upgrade HTTP method GET 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...

Page 83: ...enance upgrade start HTTP method PUT Request body wipeData true Response code Standard HTTP response code treating syntactic errors Response data data fwVersion 4 2 0 isDowngrade false status 2 wipeDa...

Page 84: ...dard HTTP response code treating syntactic errors Response data Log archive file Getting all device log archives URL ip_addr https api v1 maintenance logs full HTTP method GET Response code Standard H...

Page 85: ...ce and system settings URL ip_addr https api v1 maintenance security HTTP method PUT Request body useWebPassword true Response code Standard HTTP response code treating syntactic errors Response data...

Page 86: ...e security settings access HTTP method PUT Request body accessSettingsPasswordType integer password string Response code Standard HTTP response code treating syntactic errors Response data data access...

Page 87: ...de Standard HTTP response code treating syntactic errors Response data data password Test12345 3 10 4 1 Lockscreen 3 10 4 1 Lockscreen Getting current settings Getting information on screen lock setti...

Page 88: ...screen off on using this endpoint The lock screen cannot be configured via a web interface URL ip_addr https api v1 maintenance security lockscreen HTTP method PUT Request body isEnabled boolean Resp...

Page 89: ...ing 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 Section setting URL ip_addr https api v1 ne...

Page 90: ...2N TELEKOMUNIKACE a s www 2n cz 90 94 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: ...2N TELEKOMUNIKACE a s www 2n cz 91 94 4 Supplementary Information 4 1 Directives Laws and Regulations General Instructions and Cautions...

Page 92: ...ge or destruction of the product caused by incompetent replacement of parts or due to the use of reproduction parts or components The manufacturer shall not be liable and responsible for any loss or d...

Page 93: ...c Waste and Used Battery Pack Handling Do not place used electric devices and battery packs into municipal waste containers An undue disposal thereof might impair the environment Deliver your expired...

Page 94: ...2N TELEKOMUNIKACE a s www 2n cz 94 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...

Reviews:

No comments

Brands by name

Popular brands

Load more brands