API

babblevoice API The API is intended for developers who wish to develop client applications to extend the core functionality of babblevoice. This is the same API we develop our own Netvibes Gadgets (amongst other things). The API feed is all delivered through a REST methodology found at https://www.babblevoice.com/api. Authentication is all done through OAuth and results are returned as JSON. Oauth OAuth is the only method for getting authorized access to a user’s babblevoice data.

CDR API

Note the q parameter is new and we are planning on releasing it soon. For now it is for reference and maybe subject to change - please check back for more information https://www.babblevoice.com/api/cdr This URL on its own will return a table of CDR data. It has some search parameters. ‘p’ page the page index, default 0 ‘ps’ page size (the number of records to be returned), default 10, maximum 200 ’d’ domain, required ‘f’ date format, ‘dateasepoch’ or nothing.

Device API

The device API gives access to devices. A device is typically a phone on the network, but also can represent a SIP server. https://www.babblevoice.com/api/device Returns a table of devices (phones or servers) the authenticated user has access to. https://www.babblevoice.com/api/device/simplecall ‘f’ device full address, for example 1000@omniis.babblevoice.com ’d’ destination, the number you wish the phone to call Example https://www.babblevoice.com/api/device/simplecall?f=1000@omniis.babblevoice.com&d=somephonenumber https://www.babblevoice.com/api/device/stats Returns statistics for the specified device. ‘f’ device full address, for example 1000@omniis.

Domain API

The domain API carries access to parameters around the domain. https://www.babblevoice.com/api/domain The base URL will return a table of domains the user who is authenticated has access to. This includes the unique id, name and bank value. https://www.babblevoice.com/api/domain/getstatus https://www.babblevoice.com/api/domain/setstatus A get/set pair. The status string is a string stored against a domain. It can be used in call rules to send to a phone as a message or even decide on how a call is answered.

Money API

The money API gives access to the financial part of babblevoice. https://www.babblevoice.com/api/money/invoices Returns a table of invoice items. Parameters: ‘p’ page, default 0 ‘ps’ page size, default 10 ‘u’ only after unique id (returns a table of entries after the id provided) ’d’ domain, required ‘f’ date format, ‘dateasepoch’ or nothing. Example: https://www.babblevoice.com/api/money/invoices?p=0&ps=10&d=omniis.babblevoice.com&f=dateasepoch https://www.babblevoice.com/api/money/xfer Transfer money from one domain to another. Parameters: * ’s’ source domain name * ’d’ destination domain name * ‘de’ description, optional but recommended * ‘a’ amount to transfer, required

Prefs API

The prefs (preferences) API allows an authenticated user to store preference information against a OAuth session (token). This is useful for storing user preferences so that the only thing the client is required to store locally is OAuth information. https://www.babblevoice.com/api/prefs/set https://www.babblevoice.com/api/prefs/get Get/Set pair. The get returns the document as json encoded. Parameters: ’d’ data, required for get

Presence API

Overview This API is in Alpha. Unless you work for babblevoice there will be zero support (well buy us a beer, tickle us under the chin and we may start talking - we are easily bought!). This part of the API offers live information. It is designed to work in browsers inside Javascript applications amongst other applications. There is a 2 stages to get access to the information Register your interest in information Make a call to the presence server to wait for the information

Voicemail API

Access to voicemail stored in voicemail boxes (devices). https://www.babblevoice.com/api/voicemail The root URL will return a table of voicemails available in a voicemail box. Parameters: ‘p’ page, default 0 ‘ps’ page size, default 10 ’d’ device (which includes the username and domain), required ‘f’ format, nothing or ‘dateasepoch’ Example: https://www.babblevoice.com/api/voicemail?p=0&ps=10&d=1000@omniis.babblevoice.com&f=dateasepoch https://www.babblevoice.com/api/voicemail/getauthenticatedurl Returns a URL which is authenticated and available for 4 hours. Parameters: ‘u’ unique id, required https://www.

babblevoice Auto Attendant XML API

Intro babblevoice Auto Attendant XML is a language designed to allow developers of web applications to integrate their systems, such as CRM with live auto attendants, allowing them to pass real information in and out of phone calls. This is where an Auto Attendant becomes Interactive Voice Response (IVR). The process is, babblevoice downloads a small, simple, chunk of XML for every step of the auto attendant. This small chunk of XML will contain simple instructions which when combined create powerful Auto Attendant applications (well technically IVR).

babblevoice Desktop API

Intro While working on the babblevoice desktop we realised that we had a powerful platform for integration and there were a lot of points where personalised functionality could be useful. We also liked the idea of moving some of the functionality found in our desktop applications to this more user friendly platform with better web integration. To this end we decided to create the babblevoice desktop plugin framework. If you are interested in creating a plugin please use the api documented below to help along with the examples here.