Beschreibung der XML-RPC-Schnittstelle der iQueue

Die Klingelstrategie "iQueue" (siehe auch "iQueue auf der STARFACE konfigurieren" und "Auswertung für die iQueue konfigurieren") bietet für externe Anwendungen einen Zugriff auf die Live-Daten, wie auch auf History-Daten. Für die beiden Schnittstellen wird die XML-RPC Technologie genutzt. Die Live-Daten einer iQueue werden über die XML-RPC-Funktion "Queue.getLiveData" aufgerufen, welche einen Eingabeparameter erwartet:

<name>queueName</name> <string>…</string>

Diese Funktion liefert folgende Rückgabewerte:

callersLiveData (LIST) - Dieser Rückgabewert ist eine Liste, die wiederum Maps als Elemente enthält. Jede Map enthält Informationen (Schlüssel -> Wert) über genau einen Anrufer, der sich zu dieser Zeit in der Warteschlange befindet. Die Liste ist nach der Position des Anrufers in der Queue sortiert. Jede Map enthält die folgenden Schlüssel:

agentsLiveData (MAP) - Dieser Rückgabeparameter ist eine Map, die wiederum Maps als Elemente enthält. Schlüssel der Map ist die Login-ID des Agenten. Jede Element-Map enthält Informationen (Schlüssel -> Wert) über einen Agenten:

History Schnittstelle

Die historischen Daten einer iQueue werden über die XML-RPC-Funktion "Queue.getHistoryData" aufgerufen. Der Eingabeparameter hierfür ist ein "struct" mit drei Wertangaben:

Diese Funktion hat einen Rückgabewert:

queueHistoryData (LIST) - Die Elemente der Liste sind Maps und jede Map enthält Informationen über genau einen Anruf. Die Liste ist nach dem Timestamp der Anrufe sortiert. Jedes Element der Liste enthält die folgenden Schlüssel:

Beispiel

Per Post Methode:

http://IP-ADRESSE/xml-rpc?de.vertico.starface.auth=$LoginID:SHA512($LoginID*SHA512($Passwort))

Das Passwort wird im ersten Schritt mit SHA512 gehasht. Danach wird dieser Hash nochmals mit der LoginID als Präfix und dem Trennzeichen * erneut gehasht. Für einen Benutzer mit den folgenden Eckdaten:

LoginID = 0001
Passwort = starface
IP-Adresse der Starface = 192.168.0.100

ergibt sich als Aufruf-URL für XML-RPC:

http://192.168.0.100/xml-rpc?de.vertico.starface.auth=0001:5273503e607e5b24eeb48a3f71c53eb50df6b6622839ecd7149e248893f627d05d8d4af88cf36b3d7d5cd5d1d559dfa1c10404067d8c0f37a138c6546dad7ef7

Der Body würde dann z.B. so aussehen:

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
   <methodName>Queue.getHistoryData</methodName>
   <params>
      <param>
         <value>
            <struct>
               <member>
                  <name>queueName</name>
                  <value>
                     <string>testIq</string>
                  </value>
               </member>
               <member>
                  <name>from</name>
                  <value>
                     <dateTime.iso8601>20150701T12:59:05</dateTime.iso8601>
                  </value>
               </member>
               <member>
                  <name>to</name>
                  <value>
                     <dateTime.iso8601>20160701T12:59:05</dateTime.iso8601>
                  </value>
               </member>
            </struct>
         </value>
      </param>
   </params>
</methodCall>