Application Program Interface (API) Technical Information

Integrate with X-on's Call Handling and Messaging Systems

API Introduction

Purpose

The X-on Application Program Interface document is aimed at software developers and systems integrators who wish to integrate their products with X-on's call handling and messaging systems. It is concerned with real time events, either from X-on to client software or vice versa.

Protocols

Version 1.0 supports exchange of data through HTTP requests (GET or POST) to fixed URLs on X-on or Client servers.

A basic WINSOCK message exchange is supported for clients providing a connection at a fixed address.

In future versions, support will be added for a SOAP XML based protocol with encapsulation within Windows Services. A client based communications component will be released which will handle dynamic client addressing for use behind firewalls.

Regardless of which protocols are employed, a consistent event type and parameter list will be maintained.

Client to X-on Events (CTOX Events)

Generally speaking, these events are instructions to X-on's servers to provide some form of communication, such as to make a phone call or send an SMS message. The communication may involve a single target individual, sending a recorded message or text, or it maybe to connect two or more people into conversations. Applications are discussed under each event type. The shorthand 'CTOX' is used for these events in this document.

X-on to Client Events (XTOC Events)

X-on to client events inform the client of a particular activity that has occurred on Xon's platform. Examples maybe an inbound SMS message, or data regarding a phone call arriving on an X-on number.

There are two types of X-on to Client events. Real time events coincide with the activity, whereas Status events may be 'ordered' at regular intervals to show the current value of data held at X-on. Status events allow client software to refresh the status of displayed data, such as 'Messages Waiting' on startup without having to wait for the next real time event to occur.