1. DL manuals
  2. 2N
  3. Speaker System
  4. Helios IP
  5. Configuration Manual

2N Helios IP Configuration Manual

Manual is about: IP INTERCOM

Summary of Helios IP

  • Page 1

    Www.2n.Cz version firmware 2n ® helios ip http api door access intercom configuration manual 2.6 2.6.0

  • Page 2: Content

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

  • Page 3: Content

    Content 1. Terms and symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 2. Http api general description . . . . . . . . . . . . . . . . . . . . . . . 5 3. Event logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 4. Http api message list . . . ....

  • Page 4: 1. Terms and Symbols

    4 2n telekomunikace a.S., www.2n.Cz ® 1. Terms and symbols symbols used in manual safety always abide by this information to prevent injury of persons. Warning always abide by this information to prevent damage to the device. Caution important information for system functionality. Tip useful advice ...

  • Page 5: 2. Http Api General

    5 2n telekomunikace a.S., www.2n.Cz ® 2. Http api general description 2n® helios ip http api (application programming interface) is an interface designed for 2n® helios ip remote control, configuration and data retrieval via third party applications. 2n® helios ip api enables 2n intercoms to be inte...

  • Page 6

    6 2n telekomunikace a.S., www.2n.Cz ® post /… http/1.1 host: … content-type: application/soap+xml content-length: … additional control information of request request parameters if the request is processed successfully, 2n® helios ip sends the following http response: http/1.1 200 ok content-type: ap...

  • Page 7

    7 2n telekomunikace a.S., www.2n.Cz ® http/1.1 400 bad request content-length: … content-type: application/soap+xml xmlns:s="http://www.W3.Org/2003/05/soap-envelope" xmlns:ter="http://www.Onvif.Org/ver10/error"> error code error subcode error cause details additional error details xmlns:s="http://ww...

  • Page 8: 3. Event Logging

    8 2n telekomunikace a.S., www.2n.Cz ® 3. Event logging 2n® helios ip implements an internal event log, which records events arising in the device – such as keypressed, codeentered, cardentered, callstatechanged and so on. The log capacity is 500 events. When the log fills up, any new event deletes t...

  • Page 9

    9 2n telekomunikace a.S., www.2n.Cz ® in the mode, 2n helios ip sends events to the subscriber in the form of subscription ® notify messages. In the mode, the client sends the getmessages request to retrieve the log pullpoint data. Data retrieval in subscription mode to retrieve events from 2n® heli...

  • Page 10

    10 2n telekomunikace a.S., www.2n.Cz ® data retrieval in pullpoint mode to retrieve events from 2n® helios ip in the pullpoint mode, create the pullpoint via the request, specifying the type of events to be retrieved and the createpullpoint subscription time. If the subscription is successful, 2n® h...

  • Page 11

    11 2n telekomunikace a.S., www.2n.Cz ®.

  • Page 12: 4. Http Api Message List

    12 2n telekomunikace a.S., www.2n.Cz ® 4. Http api message list 2n helios http api ® defines the following types of messages: subscribe subscriberesponse createpullpoint createpullpointresponse renew renewresponse unsubscribe unsubscriberesponse getmessages getmessagesresponse notify see below for d...

  • Page 13: Message Parameters

    13 2n telekomunikace a.S., www.2n.Cz ® xmlns:wsnt="http://docs.Oasis-open.Org/wsn/b-2" xmlns:a="http://www.W3.Org/2005/08/addressing" xmlns:event2n="http://www.2n.Cz/2013/event"> {http_consumer_address} "http://www.2n.Cz/2013/topicexpression/multiple"> {events_list} {datetime_or_duration} {max_numbe...

  • Page 14: Subscriberesponse

    14 2n telekomunikace a.S., www.2n.Cz ® datetime_or_duration set the subscription time. Subscription will be cancelled automatically by when this time period expires. Send the renew request before expiry to extend the subscription time. Enter the absolute time (datetime) or relative duration (duratio...

  • Page 15: Message Parameters

    15 2n telekomunikace a.S., www.2n.Cz ® xmlns:s="http://www.W3.Org/2003/05/soap-envelope" xmlns:wsa5="http://www.W3.Org/2005/08/addressing" xmlns:wsnt="http://docs.Oasis-open.Org/wsn/b-2" xmlns:event2n="http://www.2n.Cz/2013/event"> http://docs.Oasis-open.Org/wsn/bw-2/notificationproducer/subscribere...

  • Page 16: Createpullpoint

    16 2n telekomunikace a.S., www.2n.Cz ® expire_time specify the subscription date and time. Use the renew request to extend the subscription time before expiry. Refer to the format of selected parameters for format details. Createpullpoint the createpullpoint request helps you subscribe to 2n helios ...

  • Page 17: Createpullpointresponse

    17 2n telekomunikace a.S., www.2n.Cz ® createpullpointresponse 2n helios ip sends the createpullpointresponse in reply to the createpullpoint ® request to inform the client that the client’s subscription has been completed successfully. Xmlns:s="http://www.W3.Org/2003/05/soap-envelope" xmlns:wsa5="h...

  • Page 18: Renew

    18 2n telekomunikace a.S., www.2n.Cz ® current_time subscription date and time from the viewpoint of 2n helios ip. Refer to the format of ® selected parameters for format details. Expire_time specify the subscription date and time. Use the renew request to extend the subscription time before expiry....

  • Page 19: Renewresponse

    19 2n telekomunikace a.S., www.2n.Cz ® datetime_or_duration extend the subscription time. Subscription will be cancelled automatically by 2n helio ® s ip when this time period expires. Send another renew request before expiry to extend the subscription time. Enter the absolute time (datetime) or rel...

  • Page 20: Unsubscribe

    20 2n telekomunikace a.S., www.2n.Cz ® unsubscribe the unsubscribe request helps you terminate your subscription. Send this request to the address included in the subscriberesponse message. 2n helios ip replies with the ® unsubscriberesponse. Xmlns:s="http://www.W3.Org/2003/05/soap-envelope" xmlns:w...

  • Page 21: Getmessages

    21 2n telekomunikace a.S., www.2n.Cz ® getmessages the getmessages request helps you read out events actively from 2n helios ip. Send ® the request to the address included in the createpullpointresponse. 2n helios ip ® replies with the getmessageresponse. Xmlns:s="http://www.W3.Org/2003/05/soap-enve...

  • Page 22: Message Parameters

    22 2n telekomunikace a.S., www.2n.Cz ® xmlns:s="http://www.W3.Org/2003/05/soap-envelope" xmlns:topic2n="http://www.2n.Cz/2013/event/topics" xmlns:wsa5="http://www.W3.Org/2005/08/addressing" xmlns:wsnt="http://docs.Oasis-open.Org/wsn/b-2" xmlns:event2n="http://www.2n.Cz/2013/event"> http://docs.Oasis...

  • Page 23: Message Parameters

    23 2n telekomunikace a.S., www.2n.Cz ® message parameters event_list refer to the logged events subsection for the list of events. The message always includes one event at least. Specify the maximum count of events in the subscribe request..

  • Page 24: 5. Logged Events

    24 2n telekomunikace a.S., www.2n.Cz ® 5. Logged events this subsection includes a list of events to be stored in the 2n® helios ip log and specifies the transfer format via the notify and getmessagesresponse messages. Keypressed callstatechanged cardentered codeentered devicestate see below for det...

  • Page 25: Callstatechanged

    25 2n telekomunikace a.S., www.2n.Cz ® keycode code of the key pressed. Applicable values: 0, 1, …, 9, *, # – numerical keypad buttons %1..%54 – call buttons callstatechanged the callstatechanged event is generated whenever a change of the currently made call occurs. {timestamp} event2n:callstatecha...

  • Page 26: Event Parameters

    26 2n telekomunikace a.S., www.2n.Cz ® {timestamp} event2n:cardentered {card} {valid_flag} event parameters timestamp event date and time; refer to the format of selected parameters. Card detected card identification with a 24-64-bit number in the hexadecimal format, e.G. 54a86b87c5. Valid_flag if t...

  • Page 27: Devicestate

    27 2n telekomunikace a.S., www.2n.Cz ® code numerical code entered, e.G. 1234. Valid_flag if the entered code is valid (matches the 2n ® helios ip valid codes), the parameter value is . If not, the parameter is set to . True false devicestate the devicestate event is generated whenever any of the se...

  • Page 28: 6. Format of Selected

    28 2n telekomunikace a.S., www.2n.Cz ® 6. Format of selected parameters timestamp – absolute time the absolute time parameter obeys the iso8601 subset standard: it is set as a string of characters in the ccyy-mm-ddthh:mm:ss format, where cc stands for the century, yy for the year, mm for the month a...

  • Page 29

    29 2n telekomunikace a.S., www.2n.Cz ® 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 2043v1.