Callisto Knowledge Base

This page is optimized for desktop computers and tablets. To access it, try one of the following points:

  • Access this page from a different device.
  • If you’re on a tablet, rotate it.
  • Check the “Desktop site” option in your browser settings.
Return to CTModule homepage
Knowledge Base

ESPA-X Server interface description

Overview

The Alarming application handles alarms (i.e., configuring alarm groups and activating alarms) from different sources:

  • ESPA 4.4.4 via COM ports
  • via ESPA-X clients
  • manually via the web GUI
  • via REST web service

Services button

These alarms are sent as push messages to the configured groups of phones set as alarm destinations. The phone displays the most recent alarm message; the five most recent alarms can be viewed by pressing the Services button on the phone.

For more information on configuring an ESPA-X server, refer to the chapter ESPA configuration in the administration manual.

ESPA-X supported messages

LOGIN

To start a session, an ESPA-X client needs to send a REQ.LOGIN message immediately after the connection to the server is established. Every request coming before the REQ.LOGIN request will be refused with the response code 407 (authentication required).

If the login is successful, the server will send a RSP.LOGIN response with response code 200 (OK) and a sessionID will be provided.

Important: During a session, the sessionID provided in the RSP.LOGIN response must be used in every request by the client.

LOGOUT

When the server receives a REQ.LOGOUT message from the client, the Callisto ESPA-X server will disconnect the client and terminate the connection.

HEARTBEAT

A HEARTBEAT message needs to be sent from the client constantly within the defined interval. If an interval passes without Callisto receiving a HEARTBEAT message, the client is disconnected and the session will be terminated.

P-START

When call/alarm is triggered from a client, a P-START message is sent. The most important fields in the P-START message recognized by the Callisto ESPA-X server are:

CP-GROUPID: The group number (address) which identifies the group of destinations which will be notified. See chapter Alarm groups in the administration manual.
CP-TEXTMSG: A text message which will be sent to all destinations of the alarm group.

When the P-START message is received, Callisto immediately notifies the alarm group via push notifications.Also, a response (RSP.P-START) is sent including the following fields:

RSP.P-START

RSP-CODE

A 3-digit response code. Callisto responds with either of these codes:

  • 200: request processed successfully
  • 407: authentication required
RSP-REASON A text relating to the RSP-CODE (either “OK” or “Authentication required”)
CP-PR-REF The process reference received from client in the P-START request
SP-PR-TAN The process transaction number of the server

Immediately after RSP.P-START, Callisto sends the following indications to the client: P-STARTED and P-ENDED (on server side, the process is ended immediately after the push notifications have been sent).

P-STARTED

SP-STATUS Always returns “Active
SP-CREATED The time when the process started
CP-PR-REF The process reference received from client in the P-START request
SP-PR-TAN The process transaction number of the server

P-ENDED

SP-RESULT None
SP-ENDREASON Always returns “Finished
SP-CREATED The time when the process ended
CP-PR-REF The process reference received from client in the P-START request
SP-PR-TAN The process transaction number of the server
CP-GROUPID The group number (address) which identifies the group of destinations which will be notified. See chapter Alarm groups in the administration manual.
CP-PHONENO The phone number to which call is addressed

P-STOP

The Process Stop request message (REQ.P-STOP) is supported by Callisto but doesn’t have any effect on the process control because Callisto sends push notifications to a group of endpoints. Currently, this request is reserved for future use. Callisto always responds with 200 "OK" upon receiving a RSP.P-STOP message.