Reporting : REST API

VoiceGuide's REST API can be used to retrieve current and historical data for IVR and ACD systems.
Generation of PDF reports is also supported through the REST API.

VoiceGuide's REST API can be accessed at this location:

http://localhost:7131/v1/

"localhost" is replaced with system's IP address if REST API is accessed remotely.

REST API for IVR data:

http://localhost:7131/v1/ivr/calls/[direction]/[range]/[bin]/[port]/[data_or_labels]

[direction] : in | out | all

[range] : today | yesterday | YYYYMMDD | YYMMDD | MMDD | last24hr | last1hr | last30min | 24hr | 1hr | 30min

[bin_size] : day | 24hr | 1hr | 30min

[port] : all | X

[data_or_labels] : count | labels | detail | pdf

Examples of use:

http://localhost:7131/v1/ivr/calls
http://localhost:7131/v1/ivr/calls/group/live
http://localhost:7131/v1/ivr/calls/group/historical
http://localhost:7131/v1/ivr/calls/in/24hr/1hr/all/count
http://localhost:7131/v1/ivr/calls/in/24hr/1hr/all/labels
http://localhost:7131/v1/ivr/calls/in/24hr/1hr/all/pdf

"localhost" would need to be replaced with Voiceguide system's IP address if dashboard is viewed remotely.

REST API for ACD data:

http://localhost:7131/v1/acd/agent/[agent_id]/[range]

http://localhost:7131/v1/acd/queue/[queue_name]/[range]

[agent_id] : all | list | X

[range] : today | yesterday | YYYYMMDD | YYMMDD | MMDD

[queue_name] : all | list | X

Examples of use:

http://localhost:7131/v1/acd/agent/list
http://localhost:7131/v1/acd/queue/list