World-class support

How can we help you today?

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. This is useful in multi-tenanted environments where receptionists need on the fly information on how to handle a call.

Parameters:

  • ā€˜dā€™ domain, required
  • ā€˜sā€™ status, required for setstatus

https://www.babblevoice.com/api/domain/groups

Returns a list of groups the domain has.

https://www.babblevoice.com/api/domain/mystuff/number

Returns a list of phone numbers the domain has.

https://www.babblevoice.com/api/domain/mystuff/number/stats

Returns statistics for the phone number in question.

  • 's' the stat we are interested in

inbound (default if left blank) includes the following data:

  • bill seconds - the time after any ringing (including time on auto attendant)
  • duration - the total duration of the call including ringing
  • ringtime - the duration of ringing which ends when either an auto attendant answers the call or a person
  • inboundanswered (only the answered calls - by a device, this includes the billing duration(even if it is at zero - what the network thinks in the talk time)) includes the following data:
  • bill seconds - the time after any ringing (including time on auto attendant)
  • duration - the total duration of the call including ringing
  • ringtime - the duration of ringing which ends when either an auto attendant answers the call or a person
  • actualringtime - the duration of ringing which ends when a device (phone) is actually answered
  • 'x' xform (transformation (i.e. average (mean) over 1 hour), if left it will return the raw data - sumbillday, sumbillhour, sumdurationday, sumdurationhour, countday, counthour, avhourbillsec, avdaybillsec, avhourduration, avdayduration
  • 't' timespan
  • 'n' the telephone number in question (can be comma delimited list of phone numbers, urlencoded)