RM Real-time Detailed CDR Reporting Services

Real-time Detailed CDR Reporting Services for RM

This report describes the calls that are currently in-progress in the GVP Resource Manager. Each report contains a manifest section.

Web Service Endpoint

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

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 match 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 the matching call-type to be returned. Valid values are: INBOUND OUTBOUND
sort-order	This can take on the value of either asc or dsc, and it affects the way the CDRs in the report are sorted. If set to "asc" the CDRs are returned in ascending by time. If set to "desc" the CDRs are returned in descending order by time. The default value is asc.
page-size	This specifies the per-page maximum number of items to be returned in a single CDR report. If this is greater than some maximum configured on the Reporting Server, this is silently ignored.
page	This specifies the page number to be returned. Together with sort-order and page-size, it determines the set of CDRs to be returned in the query. If this page exceeds some maximum value configured on the reporting server, or if the product of page×page-size is greater than the result set, an error is returned.
call-state	This causes the report to contain only calls currently in the specified state. Valid values are: IVR TRANSFERRING ACCEPTED TRANSFERRED

Output Format

The output for this report consists of a list of CDRs, where each CDR describes the information about the call on the RM which generated this CDR. It conforms to the RelaxNG schema RM_CDR.rng. Download the GVP RNG Schemas An example report body for this report is as follows:

  <cdr-list>
    <cdr comp-type="RM" gvp-guid="BD6E4C04-8B66-4A28-00B4-1F9BD4B0199A" session-id="BD6E4C04-8B66-4A28-00B4-1F9BD4B0199A" app-id="210" comp-id="223" start="2010-02-02T11:07:33.872Z" call-status="IN_PROGRESS" call-type="INBOUND" local-uri="sip:356@138.120.84.153;aai=N/A" remote-uri="sip:111@10.0.0.97" tenant-id="1" dn="356" usage-profile="1" burst-profile="1" usage-tenant="2" burst-tenant="1">
      <usage-tenants>
        <usage-tenant>2</usage-tenant> 
      </usage-tenants>
      <burst-tenants>
        <burst-tenant>1</burst-tenant> 
      </burst-tenants>
    </cdr>
  </cdr-list>