UCCX realtime stats API

[Aaron Fracht-Monroe]

We're developing a software module that needs to show real-time stats (#calls in queue, longest holding) for UCCX agents. Ideally there would be a web-based API like /finesse/api/Queue/{id}  in P/UCCE  as polling an Informix database or managing a socket connection to CTIServerProtocol is not ideal.

I see that a lot of developers have used the http://<UCCX>:9080/realtime and https://<UCCX>:9443/realtime/  'undocumented' APIs to get UCCX statistics.  Is anyone able to chime in with any caveats on using that? Have there been frequent breaking changes? Is there a 'good' polling interval to use? Have you gone through IVT certification using this API?

[Thomas G. Johannesen]

Hey Aaron.

I use it to alot of my customer.

I have made a service that pulls the data every 5 second and save these on a web server i json format, and then the other systems use these file (so i only have on connection pulling the data from the API)

I have used it for several years without any problems. All back to version 10.6 and forward.

I never breaks down (and realtime reports in CUIC/Finesse is using the same data)

[Thomas G. Johannesen]

Youn can get the schema file here:

http://{{uccxServer}}:9080/realtime/schema

[Aaron Fracht-Monroe]

Thanks for the detail @Thomas G. Johannesen .  Have you taken the app through IVT certification?

[Thomas G. Johannesen]

Hey

Not through IVT certification.

Because I only have 1 connection pulling the data every 5 seconds, i can't se what the problem should be. All realtime CUIC reports (Including finesse realtime reports) use the same API (so it is build for this)

I have talked with cisco a few times about this API, and the reason it is not supported, is they haven't testet it with a big load (this is the reason for only 1 connection from my side)

Finesse realtime reports update every 3 second.

But no IVT certification