A Ruby interface to the 8x8 phone system reporting API
This is the ruby gem encapsulate the 8x8 phone system reporting API, and it makes people easier to intergate 8x8 phone system into their Ruby projects.
Installation
Add this line to your application's Gemfile:
gem 'ApiWrapperFor8x8'
And then execute:
$ bundle
Or install it yourself as:
$ gem install ApiWrapperFor8x8
Usage
###Setup
@api_connection = ApiWrapperFor8x8::Connection.new({
:username => 'foo', # your username for 8x8
:password => 'bar' # your password for 8x8
})
###Params for each call Date range: it has to be a iso8601 format and a string with comma separated, Ex "#{(Time.now-3600*24).iso8601,Time.now.iso8601}" Timezone: it need to be following: list_of_timezone[http://en.wikipedia.org/wiki/List_of_zoneinfo_time_zones], Ex. America/Los_Angeles It has more params, which can be seen on 8x8 site[http://www.8x8.com/Support/BusinessSupport/Documentation/VirtualContactCenterDocumentation/VirtualContactCenterStats.aspx]
###Channel
Get a list of channels
@api_coonection.channel_list
Get a list of agnets
@api_coonection.agent_list
Get a list of agnet details
@api_coonection.agents_details({:d => 'YOUR DATE RANGE', :tz => 'YOUR TIMEZONE'}, {FILTER OPTIONS})
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request