Accessing QueueMetrics through its XML-RPC interface

Loway

Revision History
Revision $Revision: 1.29 $ - covers QueueMetrics 12.05$Date: 2012/05/15 09:44:18 $L

Table of Contents

1. Document contents
1.1. Revision history
2. What is XML RPC?
2.1. Which functions does QueueMetrics export as XML-RPC?
2.2. Example: accessing QueueMetrics from Python
2.3. Example: Accessing QueueMetrics from Java
2.4. Example: Accessing QueueMetrics from PHP
2.5. Example: Accessing QueueMetrics from JavaScript
3. Understanding call parameters
3.1. The method QM.stats
3.2. The method QM.realtime
3.3. The method QM.qareport
3.4. The method QM.qaformreport
3.5. The method QM.qaformsummary
3.6. The method QM.qaformgrading
3.7. The method QM.qacallstograde
3.8. The method QM.auth
3.9. The method QM.authenticate
3.10. The method QM.findAudio
3.11. The method QM.insertRecordTag
3.12. The method QM.tskAddNote
3.13. The method QM.tskAddTraining
3.14. The method QM.tskAddMeeting
3.15. The method QM.setActivationKey
3.16. The method QM.broadcastMessage
3.17. The method QM.getQueuesForAgent
3.18. The method QM.getPauseCodesForAgent
4. Understanding results
5. Using an external auth source for QueueMetrics
5.1. Log on procedure
5.2. XML-RPC call parameters
A. Response block names
A.1. Response block names for QM.stats
A.2. Response block names for QM.realtime
A.2.1. DataObject: RealtimeDO
A.3. Response block names for QM.qareport
A.3.1. DataObject: QualAssDO
A.4. Response block names for QM.qaformreport and QM.qaformgrading
A.4.1. DataObject: QualAssFormDO
A.5. Response block names for QM.qaformsummary
A.5.1. DataObject: QualAssDO
A.6. Response block names for QM.qacallstograde
A.6.1. DataObject: QAGradingDO
A.7. Response block names for QM.auth
A.8. Response block names for QM.findAudio
A.9. Response block names for QM.insertRecordTag
6. Appendix II: A short list of XML-RPC libraries

1. Document contents

This document details how to access and use the XML-RPC access functionality in Loway QueueMetrics. This makes it possible for your programs to leverage the power of QueueMetrics by calling a very simple API, with bindings available in nearly every programming language.

1.1. Revision history

  • Nov 13, 2006: First draft
  • March 22, 2007: Added PHP example
  • April 13, 2007: "raw" blocks available
  • May 11, 2007: real-time blocks and auth server
  • Jun 11, 2007: multi-stint calls
  • Nov 11, 2007: enter-queue position and schedule adherence
  • Nov 10, 2008: Added Outcomes data blocks and external XML-RPC Authentication description
  • Jan 14, 2009: Added support for JavaScript
  • Feb 11, 2009: Moved to AsciiDoc format for ease of updating
  • Feb 17, 2009: Added QM.findAudio methods
  • Aug 07, 2009: Added QM.qareport and QM.qaformreport reports
  • Aug 10, 2009: Added AgentsDO.AnsCallsCG for "Answered calls by custom group" reporting
  • Dec 2, 2009: Added QM.qaformsummary report
  • Jul 8, 2010: Added new blocks "Call Overview", "Traffic analysis", "Agent performance"
  • Jul 21, 2010: Added QM.qaformgrading method
  • Aug 20, 2010: Added new block "Inclusive Answered SLA"
  • Oct 1, 2010: Referenced QM manual for possible data blocks.
  • Dec 2, 2010: Added new QA related optional parameter, Added new QM.tskAddNote and QM.qacallstograde methods
  • May 16, 2011: New method setActivationKey()
  • Oct 6, 2011: Added new QM.tskAddTraining methods. Modified QM.tskAddNote in order to receive the processField
  • Oct 7, 2011: Added new QM.broadcastMessage method.
  • Oct 24, 2011: Added new QM.tskAddMeeting method.
  • Nov 14, 2011: New method QM.authenticate()
  • Nov 23, 2011: New method QM.insertRecordTag()
  • March 6, 2012: New methods QM.getQueuesForAgent() and QM.getPauseCodesForAgent()