Jump to: navigation, search

RM Real-time Summary CDR Reporting Services

This report describes a summary of the calls that are currently in-progress in the GVP Resource Manager. Instead of listing the individual calls, this reporting service makes a summary of these calls in this report. Each report contains a manifest section.

Web Service Endpoint

This report is available at the web service endpoint /ems-rs/RT/CDRs/RM/summary.

Input Parameters

This report accepts the following Request URI parameters:

Parameter Description
started-from This describes the starting point of the "call start" field of the CDR. It takes the DateTime format as described in the Common Input Parameter Types page. This will cause the report to return only calls started after the specified value.
started-to This describes the ending point of the "call start" field of the CDR. It takes the DateTime format as described in the Common Input Parameter Types page. This will cause the report to return only calls started before the specified value.
app-id This describes the target IVR Profile Config Server DBID. This may be specified zero or more times. All the CDRs returned in the report must belong to one of the specified IVR Profiles. This cannot be specified together with either the tenant-id or the dn parameter.
tenant-id This describes the target Tenant Config Server DBID. This may be specified zero or more times. All the CDRs returned in the report must belong to one of the specified tenants. This cannot be specified together with either the app-id or the dn parameter.
dn This describes the target DN of the CDR. This may be specified zero or more times. All the CDRs returned in the report must belong to one of the specified DNs. This cannot be specified together with either the app-id or the tenant-id parameter.

The format of the dn parameter may be one of the following:

  • a single integer n - the result contains records that exactly matche the value n
  • a single integer n followed by a ‘*’ - the result contains records that has the prefix n

a range in the format m-n - the result contains results with DN that is greater than or equal to m and less than or equal to n.

comp-id This describes the target component’s Config Server DBID. This may be specified one or zero times. All the CDRs returned in the report must have been processed on the specified component.
remote-uri This may be specified zero or more times. All the CDRs returned in the report must have a matching remote-uri. A trailing asterisk (*) may be specified in the remote-uri query to indicate a prefix-match.
local-uri This may be specified zero or more times. All the CDRs returned in the report must have a matching local-uri. A trailing asterisk (*) may be specified in the local-uri query to indicate a prefix-match.
session-id This causes the report to return a single call with a matching session-id. This must be accompanied by a comp-id parameter. If session-id is specified, no other parameters other than these two should be specified.
genesys-uuid This causes the report to return all calls with a matching Genesys Framework session id. If this is specified, no other parameters should be specified.
vtag This causes the report to contain only calls with matching virtual reporting tags. This parameter can appear more than once in a query. The vtag parameter takes on a format of

<tag-name>,<tag-value> which returns all the calls having been tagged with <tag-name>=<tag-value>

call-type This causes the report to contain only calls with matching call-type to be returned. Valid values are:
  • INBOUND
  • OUTBOUND

Output Format

The output for this report consists of two lists:

  • items where each represent the summary for an IVR profiles
  • items where each represent the summary for a components

It conforms to the RelaxNG schema CDR_summary.rng. Download the GVP RNG Schemas An example report body for this report is as follows:

  <cdr-list count="3">
    <applications>
      <application href="/applications/132" /> 
    </applications>
  </cdr-list>
  <cdr-list count="5">
    <applications>
      <application href="/applications/133" /> 
    </applications>
  </cdr-list>
  <cdr-list count="4">
    <components>
      <component href="/components/223" /> 
    </components>
  </cdr-list>
  <cdr-list count="4">
    <components>
      <component href="/components/224" /> 
    </components>
  </cdr-list>
This page was last edited on July 17, 2020, at 16:12.
Comments or questions about this documentation? Contact us for support!