Table of Contents

API for Enjay Synapse OS (AESO)

Read Time: 2 minutes

Enjay Synapse Server & Mini-Server is a customised IP_PBX Solution. It is powered by Enjay Synapse OS. Which is a hardened version of Linux and all the drivers and utilities required to manage state of the art telephony infrastructure. It also includes a very user friendly browser based UI.

Telephony, if it can be combined with your business software, makes fantastic sense and value for money. The most beautiful part is that ESS / ESM can talk to your software.

Enjay provides API (application programing interface) so that you can make your software talk to ESS / ESM easily. We provide API for two platforms:

  1. JAVA API for Enjay Synapse OS    (JAESO)

  2. DOTNET API for Enjay Synapse OS   (DAESO)

eg: JAESO package consists of following:

  1. JAESO.API  –  Actual API jar file

  2. JAESO.PDF  – Documentation / instructions on how to use JAESO.

  3. JAESOexample.jar – Sample application to demonstrate the usage of API

Similarly – other APIs will consist of contents applicable accordingly.

Technical Documentation / Explanation

This API helps other programs to communicate with Enjay Synapse Servers, for all kinds of REAL-TIME Events. In general following types of events are covered by this API.

If you analyze properly, All the things that you want to do can be done using these API functions (or a combination of them)

  1. What is offered by API?

    1. Properties

    2. Methods / functions

    3. Event triggers

  1. Login and registration of session with Enjay Synapse Server.

  2. can be used for creating single sign-on apps.

  3. Status of extensions – registered, unregistered or busy & DND Status (as set by IP phone or software phone) (also gives IP address) – DND means – don’t receive calls but allow outgoing calls.

  4. Incoming call Alert (Events)

    1. Unique ID

    2. CallerID Number (source)

    3. Name (if its in Asterisk Database)

    4. Time or receive (originate)

    5. The extension (destination)

  5. Generating (Outgoing) Calls

  1. Outgoing Phone no (destination)

  2. Source Extension (source)

  3. Thread priority

  4. Get result – whether the call is answered or not (OR whatever result is possible)

  5. Immediate – Real-time.

  1. Log Events:

    1. Get a complete Log of Server

    2. you can trap events that don’t form standard Functions which are not covered here.

  2. Event Calls

    1. Play a media file (for IVR)

    2. Get DTMF Codes (keys pressed by the party on another side of the call)

    3. Do action based on that inputs. (like:)

      1. Play another file.

      2. Transfer the call

      3. Dial another number

      4. Bridge the call (generally called conferencing in common language)

    4. Change the action after the call has started.

      1. Since you get the Caller ID (& dialed number), (from the events)

      2. Based on that information – you can decide what you want to do with this Call.

        1. eg: Play a file.

        2. Change the landing extension of the call

        3. Call some other number

        4. Or any other thing – like making an ENTRY in CRM (like Auto Support Case locking)

    5. Bridge Calls (conferencing)

  3. Once API gives you all the above events & actions, you can even store them in a database for any further action or future reference.

User Review
3 (1 vote)

Leave a Reply

Subscribe to Our Blog

Get free insights on how to make your business more efficient and effective.