onsip logo

API

Our APIs provide you with the ability to deeply integrate OnSIP into your business.


If you are building a server-side application, our APIs are most helpful to you. To expedite development of browser-based applications, we recommend using our JavaScript SDKs.

Osprey.js API

Osprey.js provides flexibility for integrating our web phone product just about anywhere. You can find a working example of the web phone in the My.OnSIP unified communications dashboard.

Docs | Download Code

XMPP API and OXJS JavaScript SDK

The OnSIP XMPP API is an XMPP/PubSub based API that allows developers to receive push notifications for various events inside the OnSIP system. Events include information regarding current call state and user agent state for SIP addresses inside of OnSIP.

OXJS is a JavaScript library that can expedite the development of custom applications when implementing against OnSIP's API. The SDK supports functionality for real-time call control event notifications. In other words, developers can implement web applications that setup phone calls and listen to call events like call created, call answered, and call terminated. Ready to get started? Take a look at our OXJS documentation.

Webservices API and Jnctn.js JavaScript SDK

The OnSIP Web services API is an HTTP/XML based API that allows developers to set and get configuration of the OnSIP system. Requests include: create a user, assign a voice mailbox to a user, add a phone number, retrieve information about a user, and more.

Jnctn.js is a simple, lightweight, cross-platform library for communicating with OnSIP's Web Service API. Jnctn.js is designed to be a tool to get started quickly with sending requests to the Web Services API, not a complete cover of it. Ready to get started? Take a look at our Jnctn.js documentation.