Call Detail Record Access Service Part No R01

Transcription

1 Call Detail Record Access Service Part No R01 Summary Objective WSDL URL (Testing) WSDL URL (Hosting Production) Endpoint URL (Testing) Endpoint URL (Hosting Production) Namespace URI Service Name Port Provide secure access to Call Detail Records (CDRs) of calls to a particular application. CDRAccessService_v2?WSDL services/cdraccessservice_v2?wsdl CDRAccessService_v2 services/cdraccessservice_v2 CDRAccessService CDRAccessService_v2 Methods Note: For simplicity, this document describes methods as though you used a language such as Java or JavaScript to access the service. In particular, the parameter types are described as Java equivalents. See Using BeVocal Platform Services for the correspondence between Java types and XML Schema built-ins. int int getcalldetailrecordcount( String organizationid, String applicationid, Date starttime, Date endtime ) getcalldetailrecordcountbyfilter( String organizationid, String applicationid, Filter[] filterlist ) CallDetailRecord[] getcalldetailrecords ( String organizationid, String applicationid, Date starttime, Date endtime, boolean requestextendeddata )

2 CALL DETAIL RECORD ACCESS SERVICE CallDetailRecord[] CallDetailRecord[] getcalldetailrecordsbyfilter( String organizationid, String applicationid, Filter[] filterlist, OrderBy[] orderbylist, int startindex, int recordcount, boolean requestextendeddata ) getcalldetailrecordsbyindex( String organizationid, String applicationid, Date starttime, Date endtime, int startindex, int recordcount, boolean requestextendeddata boolean orderbytimeascending ) Data Types CallDetailRecord CallDetailRecord { String sessionid; String parentsessionid; Date startdatetime; Int calldurationseconds; String calledparty; String callingparty; String originalcallingparty; String organizationid; String applicationid; String initialurl; String calltype; // valid values are INBOUND, OUTBOUND, // TROMBONE_TRANSFER, BLIND_TRANSFER String callresult; // valid values are BUSY, RING_NO_ANSWER... String mediagatewayhostname; String mediagatewaychannel; boolean bevocalcalllogavailable; boolean speechvendorcalllogavailable; boolean utterancesavailable; int capturedutterancecount; NameValuePair[] extendeddata; } Filter Filter { EnumFilterField field; //such as EnumFilterField.ERROR_COUNT EnumFilterOperator op; //such as EnumFilterOperator.EQUALS Object operand; //such as 4; type Date, String, or Integer } 2 CALL DETAIL RECORD ACCESS SERVICE

3 Summary EnumFilterField EnumFilterOperat or Enumerated type; one of: EnumFilterField.APPLICATION_ID EnumFilterField.CALLED_PARTY EnumFilterField.CALLING_PARTY EnumFilterField.CALL_TYPE EnumFilterField.DURATION EnumFilterField.END_TIME EnumFilterField.ERROR_COUNT EnumFilterField.MEDIA_GATEWAY_HOST EnumFilterField.MISREC_COUNT EnumFilterField.ORGANIZATION_ID EnumFilterField.START_TIME Enumerated type; one of: EnumFilterOperator.EQUALS EnumFilterOperator.EQUALS_IGNORE_CASE EnumFilterOperator.GREATER_THAN EnumFilterOperator.GREATER_THAN_OR_EQUALS EnumFilterOperator.IS_NOT_NULL EnumFilterOperator.IS_NULL EnumFilterOperator.LESS_THAN EnumFilterOperator.LESS_THAN_OR_EQUALS EnumFilterOperator.NOT_EQUALS EnumFilterOperator.NOT_EQUALS_IGNORE_CASE NameValuePair NameValuePair { String name; String value; } OrderBy OrderBy { EnumOrderByField field; //such as EnumOrderByField.CALL_TYPE boolean ascending; [ascending or descending sort] } EnumOrderByField Enumerated type; one of: EnumOrderByField.APPLICATION_ID EnumOrderByField.CALLED_PARTY EnumOrderByField.CALLING_PARTY EnumOrderByField.CALL_TYPE EnumOrderByField.DURATION EnumOrderByField.END_TIME EnumOrderByField.MEDIA_GATEWAY_HOST EnumOrderByField.ORGANIZATION_ID EnumOrderByField.START_TIME CALL DETAIL RECORD ACCESS SERVICE 3

4 CALL DETAIL RECORD ACCESS SERVICE How to Use This Service The Call Detail Record Access Service provides access to the CDRs of calls made to a particular VoiceXML application. You can use this service, for example, to write a reporting application summarizing the high-level details of usage of your application. You can also use it in conjunction with other BeVocal Platform services to provide more detailed analysis of calls and to write custom tools. For example, the BeVocal Café Vocal Player tool uses this and other services to let you interactively walk through user calls. To use the service, your client application passes parameters describing the set of calls whose records are desired. For a simple request, the parameters specify the application and a start time and an end time for the calls of interest. Other methods allow more complex queries, filtering on various conditions, such as the caller s ANI. The service returns records describing each call to that application matching the criteria that ended during that time period. For example, assume you specify a start time of T08:00:00Z and an end time of T09:00:00Z. A call that started at T07:58:30Z and ended at T08:00:50Z would be included in the records returned, but a call that started at T08:58:30Z and ended at T09:00:50Z would not be included. Using call end times makes it easier for you to be certain that you get access to relevant CDRs in a timely fashion. Because certain information about a call is not available until the call ends, the system must wait until after the call ends to write the CDR for that call. Consequently, an ongoing call does not yet have a CDR you can access. It is fairly common to want your application to access CDRs shortly after they become available. Because there is no way to know when an ongoing call will end, there is no way to know when the CDRs for all calls started during a particular time period will be available and hence how long after that time period you must wait before accessing the CDRs. On the other hand, it is obviously possible to know when the CDRs for all calls that ended during that same time period are available (that is, almost immediately after the time period!). There is a separate CDR for every inbound call, outbound call, and transferred call to and from a VoiceXML application. Once you have an array of CDRs, you work with them directly. You can also use the session ID that identifies a particular call as your handle for other services, such as to use the Media Access Service to get the recordings of what a user said during a call. You use this service to retrieve a limited number of records at a time. The service may limit the maximum number of records returned. Access to this service is restricted by the use of a security key. Before you can use this service, you must first obtain a key from BeVocal. For general information on using BeVocal Platform services, see Using BeVocal Platform Services. For an example of using this service, see the VoiceXML Samples page. 4 CALL DETAIL RECORD ACCESS SERVICE

5 getcalldetailrecordcount getcalldetailrecordcount Syntax Parameters Returns the number of calls that ended during a certain time period. See How to Use This Service on page 4 for a discussion of why the method returns calls that end during the time period and not those that start during the time period. int getcalldetailrecordcount( String organizationid, String applicationid, Date starttime, Date endtime ) Returns Faults Parameter organizationid applicationid starttime endtime Description The number of matching call records. The organization identifier. This ID is assigned when the application is provisioned. For Café developers, the value is always BVCLDEV. The application identifier. This ID is assigned when the application is provisioned. For Café developers, the value is the Café user ID. The start of the time interval for which records are requested. The Date format is described in Data Types on page 3 in Using BeVocal Platform Services. The end of the time interval for which records are requested. The Date format is described in Data Types on page 3 in Using BeVocal Platform Services. For many faults, you can see the fault detail for additional information. Examples Fault Number Description 1002 Access denied. (Client does not have access to the requested data.) 1003 The requested data is not available. SOAP Request POST /CDRAccessService_v2/services/CDRAccessService_v2 HTTP/1.0 Content-Type: text/xml; charset=utf-8 Accept: application/soap+xml, application/dime, multipart/related, text/* User-Agent: Axis/1.0 Host: utopia Cache-Control: no-cache Pragma: no-cache SOAPAction: "" Content-Length: 863 CALL DETAIL RECORD ACCESS SERVICE 5

6 CALL DETAIL RECORD ACCESS SERVICE <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv=" xmlns:xsd=" xmlns:xsi=" <soapenv:header> <ns1:platformservicessessionid xsi:type="xsd:string" xmlns:ns1=" E3EB1B1D378CC147ED935EFF39B8C911 </ns1:platformservicessessionid> </soapenv:header> <soapenv:body> <ns2:getcalldetailrecordcount xmlns:ns2="cdraccessservice_v2"> <arg0 xsi:type="xsd:string">bvcldev</arg0> <arg1 xsi:type="xsd:string"> </arg1> <arg2 xsi:type="xsd:datetime"> t20:00:00.000z</arg2> <arg3 xsi:type="xsd:datetime"> t20:00:00.000z</arg3> </ns2:getcalldetailrecordcount> </soapenv:body> </soapenv:envelope> SOAP Response HTTP/ OK Server: Resin/2.1.4 Content-Type: text/xml; charset=utf-8 Date: Thu, 13 Mar :14:20 GMT <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv=" xmlns:xsd=" xmlns:xsi=" <soapenv:body> <ns1:getcalldetailrecordcountresponse xmlns:ns1="cdraccessservice_v2"> <getcalldetailrecordcountreturn xsi:type="xsd:int"> 11</getCallDetailRecordCountReturn> </ns1:getcalldetailrecordcountresponse> </soapenv:body> </soapenv:envelope> getcalldetailrecordcountbyfilter Syntax Returns the number of calls matching the specified criteria. int getcalldetailrecordcountbyfilter( String organizationid, String applicationid, Filter[] filterlist 6 CALL DETAIL RECORD ACCESS SERVICE

7 getcalldetailrecordcountbyfilter ) Parameters Parameter organizationid applicationid filterlist Description The organization identifier. This ID is assigned when the application is provisioned. For Café developers, the value is always BVCLDEV. The application identifier. This ID is assigned when the application is provisioned. For Café developers, the value is the Café user ID. An array of Filter objects to constrain the query. Each filter specifies: a field on which to filter, such as EnumFilterField.ERROR_COUNT. an operator, such as EnumFilterOperator.GREATER_THAN. if applicable, an operand, such as 4; at present, an operand must be of type Date, String, or Integer. Returns The number of matching call records. Faults For many faults, you can see the fault detail for additional information. Examples Fault Number Description 1002 Access denied. (Client does not have access to the requested data.) 1003 The requested data is not available. SOAP Request POST /CDRAccessService_v2/services/CDRAccessService_v2 HTTP/1.0 Content-Type: text/xml; charset=utf-8 Accept: application/soap+xml, application/dime, multipart/related, text/* User-Agent: Axis/1.0 Host: utopia Cache-Control: no-cache Pragma: no-cache SOAPAction: "" Content-Length: 2882 <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv=" xmlns:xsd=" xmlns:xsi=" <soapenv:header> <ns1:platformservicessessionid xsi:type="xsd:string" xmlns:ns1=" E3EB1B1D378CC147ED935EFF39B8C911 </ns1:platformservicessessionid> </soapenv:header> <soapenv:body> <ns2:getcalldetailrecordcountbyfilter xmlns:ns2="cdraccessservice_v2"> CALL DETAIL RECORD ACCESS SERVICE 7

8 CALL DETAIL RECORD ACCESS SERVICE <arg0 xsi:type="xsd:string">bvcldev</arg0> <arg1 xsi:type="xsd:string"> </arg1> <arg2 xsi:type="soapenc:array" soapenc:arraytype="ns3:filter[2]" xmlns:soapenc=" xmlns:ns3="urn:beanservice"> <item href="#id0"/> <item href="#id1"/> </arg2> </ns2:getcalldetailrecordcountbyfilter> <multiref id="id1" soapenc:root="0" xsi:type="ns4:filter" xmlns:soapenc=" xmlns:ns4="urn:beanservice"> <filterfield href="#id2"/> <filteroperator href="#id3"/> <filteroperand xsi:type="xsd:datetime"> T20:00:00.000Z</filterOperand> <multiref id="id0" soapenc:root="0" xsi:type="ns5:filter" xmlns:ns5="urn:beanservice" <filterfield href="#id4"/> <filteroperator href="#id5"/> <filteroperand xsi:type="xsd:datetime"> T20:00:00.000Z</filterOperand> <multiref id="id3" soapenc:root="0" xsi:type="ns6:enumfilteroperator" xmlns:ns6="urn:beanservice" <value xsi:type="xsd:string">less_than_or_equals</value> <multiref id="id4" soapenc:root="0" xsi:type="ns7:enumfilterfield" xmlns:ns7="urn:beanservice" <value xsi:type="xsd:string">start_time</value> <multiref id="id2" soapenc:root="0" xsi:type="ns8:enumfilterfield" xmlns:ns8="urn:beanservice" <value xsi:type="xsd:string">end_time</value> <multiref id="id5" soapenc:root="0" xsi:type="ns9:enumfilteroperator" xmlns:ns9="urn:beanservice" <value xsi:type="xsd:string">greater_than_or_equals</value> </soapenv:body> </soapenv:envelope> 8 CALL DETAIL RECORD ACCESS SERVICE

9 getcalldetailrecords SOAP Response HTTP/ OK Server: Resin/2.1.4 Content-Type: text/xml; charset=utf-8 Date: Wed, 19 Mar :11:55 GMT <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv=" xmlns:xsd=" xmlns:xsi=" <soapenv:body> <ns1:getcalldetailrecordcountbyfilterresponse xmlns:ns1="cdraccessservice_v2"> <getcalldetailrecordcountbyfilterreturn xsi:type="xsd:int"> 11 </getcalldetailrecordcountbyfilterreturn> </ns1:getcalldetailrecordcountbyfilterresponse> </soapenv:body> </soapenv:envelope> getcalldetailrecords Syntax Parameters Returns a list of call detail records for the set of calls that ended during a certain time period. See How to Use This Service on page 4 for a discussion of why the method returns calls that end during the time period and not those that start during the time period. CallDetailRecord[] getcalldetailrecords ( String organizationid, String applicationid, Date starttime, Date endtime, boolean requestextendeddata ) Parameter organizationid applicationid starttime Description The organization identifier. This ID is assigned when the application is provisioned. For Café developers, the value is always BVCLDEV. The application identifier. This ID is assigned when the application is provisioned. For Café developers, the value is the Café user ID. The start of the time interval for which records are requested. The Date format is described in Data Types on page 3 in Using BeVocal Platform Services. CALL DETAIL RECORD ACCESS SERVICE 9

10 CALL DETAIL RECORD ACCESS SERVICE Returns Faults Parameter endtime requestextendeddata Description The end of the time interval for which records are requested. The Date format is described in Data Types on page 3 in Using BeVocal Platform Services. Determines whether or not to include extended data with the records. In some cases, the platform may associate additional data with a CDR. If this parameter is true, that additional data is included with the returned records as a set of name-value pairs. For Café applications, the platform always associates extended data. Currently, the available extended data are: NUM_ERROR--the number of errors NUM_MISRECS--the number of rejections REQ_ID--outbound request ID associated with the session (for outbound notification calls) CONNECTED--the time the call was actually connected (for outbound notification calls) An array of CallDetailRecord objects describing a particular call. For many faults, you can see the fault detail for additional information. Examples Fault Number Description 1002 Access denied. (Client does not have access to the requested data.) 1003 The requested data is not available. SOAP Request POST /services/cdraccessservice_v2 HTTP/1.0 Content-Type: text/xml; charset=utf-8 Accept: application/soap+xml, application/dime, multipart/related, text/* User-Agent: Axis/1.0 Host: utopia Cache-Control: no-cache Pragma: no-cache SOAPAction: "" Content-Length: 896 <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv=" xmlns:xsd=" xmlns:xsi=" <soapenv:header> <ns1:platformservicessessionid xsi:type="xsd:string" xmlns:ns1=" E3EB1B1D378CC147ED935EFF39B8C911 </ns1:platformservicessessionid> </soapenv:header> <soapenv:body> <ns2:getcalldetailrecords xmlns:ns2="cdraccessservice"> <arg0 xsi:type="xsd:string">bvcldev</arg0> 10 CALL DETAIL RECORD ACCESS SERVICE

11 getcalldetailrecords <arg1 xsi:type="xsd:string"> </arg1> <arg2 xsi:type="xsd:datetime"> t19:36:17.327z</arg2> <arg3 xsi:type="xsd:datetime"> t19:36:17.327z</arg3> <arg4 xsi:type="xsd:boolean">true</arg4> </ns2:getcalldetailrecords> </soapenv:body> </soapenv:envelope> SOAP Response HTTP/ OK Server: Resin/2.1.4 Content-Type: text/xml; charset=utf-8 Date: Tue, 29 Oct :36:07 GMT <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv=" xmlns:xsd=" xmlns:xsi=" <soapenv:body> <ns1:getcalldetailrecordsresponse xmlns:ns1="cdraccessservice"> <getcalldetailrecordsreturn xsi:type="soapenc:array" soapenc:arraytype="ns2:calldetailrecord[4]" xmlns:soapenc=" xmlns:ns2="urn:beanservice"> <item href="#id0"/> <item href="#id1"/> <item href="#id2"/> <item href="#id3"/> </getcalldetailrecordsreturn> </ns1:getcalldetailrecordsresponse> <multiref id="id0" soapenc:root="0" xsi:type="ns3:calldetailrecord" xmlns:soapenc=" xmlns:ns3="urn:beanservice"> <applicationid xsi:type="xsd:string"> </applicationid> <bevocalcalllogavailable xsi:type="xsd:boolean"> true </bevocalcalllogavailable> <calldurationseconds xsi:type="xsd:int">28</calldurationseconds> <callresult xsi:type="xsd:string">completed</callresult> <calltype xsi:type="xsd:string">inbound</calltype> <calledparty xsi:type="xsd:string"> </calledparty> <callingparty xsi:type="xsd:string"> </callingparty> <extendeddata xsi:type="soapenc:array" soapenc:arraytype="ns3:namevaluepair[3]"> <item href="#id4"/> <item href="#id5"/> <item href="#id6"/> </extendeddata> <initialurl xsi:type="xsd:string"> </initialurl> <mediagatewaychannel xsi:type="xsd:string">ch001</mediagatewaychannel> <mediagatewayhostname xsi:type="xsd:string">engcm002 CALL DETAIL RECORD ACCESS SERVICE 11

12 CALL DETAIL RECORD ACCESS SERVICE </mediagatewayhostname> <organizationid xsi:type="xsd:string">bvcldev</organizationid> <originalcallingparty xsi:type="xsd:string" xsi:nil="true"/> <parentsessionid xsi:type="xsd:string">null</parentsessionid> <sessionid xsi:type="xsd:string">2002-engca002-ch001-fhk6w</sessionid> <speechvendorcalllogavailable xsi:type="xsd:boolean">true </speechvendorcalllogavailable> <startdatetime xsi:type="xsd:datetime"> t21:59:20.000z </startdatetime> <utterancesavailable xsi:type="xsd:boolean">false</utterancesavailable> <multiref id="id1" soapenc:root="0" xsi:type="ns4:calldetailrecord" xmlns:ns4="urn:beanservice" <applicationid xsi:type="xsd:string"> </applicationid> <bevocalcalllogavailable xsi:type="xsd:boolean">true </bevocalcalllogavailable> <calldurationseconds xsi:type="xsd:int">27</calldurationseconds> <callresult xsi:type="xsd:string">completed</callresult> <calltype xsi:type="xsd:string">inbound</calltype> <calledparty xsi:type="xsd:string"> </calledparty> <callingparty xsi:type="xsd:string"> </callingparty> <extendeddata xsi:type="soapenc:array" soapenc:arraytype="ns4:namevaluepair[3]"> <item href="#id7"/> <item href="#id8"/> <item href="#id9"/> </extendeddata> <initialurl xsi:type="xsd:string"> </initialurl> <mediagatewaychannel xsi:type="xsd:string">ch001</mediagatewaychannel> <mediagatewayhostname xsi:type="xsd:string">engcm002 </mediagatewayhostname> <organizationid xsi:type="xsd:string">bvcldev</organizationid> <originalcallingparty xsi:type="xsd:string" xsi:nil="true"/> <parentsessionid xsi:type="xsd:string">null</parentsessionid> <sessionid xsi:type="xsd:string">2002-engca002-ch001-fhk7x</sessionid> <speechvendorcalllogavailable xsi:type="xsd:boolean">true </speechvendorcalllogavailable> <startdatetime xsi:type="xsd:datetime"> t21:59:57.000z </startdatetime> <utterancesavailable xsi:type="xsd:boolean">false</utterancesavailable> <multiref id="id2" soapenc:root="0" xsi:type="ns5:calldetailrecord" xmlns:ns5="urn:beanservice" <applicationid xsi:type="xsd:string"> </applicationid> <bevocalcalllogavailable xsi:type="xsd:boolean">true </bevocalcalllogavailable> <calldurationseconds xsi:type="xsd:int">131</calldurationseconds> <callresult xsi:type="xsd:string">completed</callresult> <calltype xsi:type="xsd:string">inbound</calltype> <calledparty xsi:type="xsd:string"> </calledparty> 12 CALL DETAIL RECORD ACCESS SERVICE

13 getcalldetailrecords <callingparty xsi:type="xsd:string"> </callingparty> <extendeddata xsi:type="soapenc:array" soapenc:arraytype="ns5:namevaluepair[3]"> <item href="#id10"/> <item href="#id11"/> <item href="#id12"/> </extendeddata> <initialurl xsi:type="xsd:string"> </initialurl> <mediagatewaychannel xsi:type="xsd:string">ch001</mediagatewaychannel> <mediagatewayhostname xsi:type="xsd:string">engcm002 </mediagatewayhostname> <organizationid xsi:type="xsd:string">bvcldev</organizationid> <originalcallingparty xsi:type="xsd:string" xsi:nil="true"/> <parentsessionid xsi:type="xsd:string">null</parentsessionid> <sessionid xsi:type="xsd:string">2002-engca002-ch001-fgr8n</sessionid> <speechvendorcalllogavailable xsi:type="xsd:boolean">true </speechvendorcalllogavailable> <startdatetime xsi:type="xsd:datetime"> t23:33:59.000z </startdatetime> <utterancesavailable xsi:type="xsd:boolean">false</utterancesavailable> <multiref id="id3" soapenc:root="0" xsi:type="ns6:calldetailrecord" xmlns:ns6="urn:beanservice" <applicationid xsi:type="xsd:string"> </applicationid> <bevocalcalllogavailable xsi:type="xsd:boolean">true </bevocalcalllogavailable> <calldurationseconds xsi:type="xsd:int">57</calldurationseconds> <callresult xsi:type="xsd:string">completed</callresult> <calltype xsi:type="xsd:string">inbound</calltype> <calledparty xsi:type="xsd:string"> </calledparty> <callingparty xsi:type="xsd:string"> </callingparty> <extendeddata xsi:type="soapenc:array" soapenc:arraytype="ns6:namevaluepair[3]"> <item href="#id13"/> <item href="#id14"/> <item href="#id15"/> </extendeddata> <initialurl xsi:type="xsd:string"> </initialurl> <mediagatewaychannel xsi:type="xsd:string">ch001</mediagatewaychannel> <mediagatewayhostname xsi:type="xsd:string">engcm002 </mediagatewayhostname> <organizationid xsi:type="xsd:string">bvcldev</organizationid> <originalcallingparty xsi:type="xsd:string" xsi:nil="true"/> <parentsessionid xsi:type="xsd:string">null</parentsessionid> <sessionid xsi:type="xsd:string">2002-engca002-ch001-fj3a3</sessionid> <speechvendorcalllogavailable xsi:type="xsd:boolean">true </speechvendorcalllogavailable> <startdatetime xsi:type="xsd:datetime"> t17:49:15.000z </startdatetime> <utterancesavailable xsi:type="xsd:boolean">false </utterancesavailable> CALL DETAIL RECORD ACCESS SERVICE 13

14 CALL DETAIL RECORD ACCESS SERVICE <multiref id="id13" soapenc:root="0" xsi:type="ns7:namevaluepair" xmlns:ns7="urn:beanservice" <name xsi:type="xsd:string">num_error</name> <multiref id="id12" soapenc:root="0" xsi:type="ns8:namevaluepair" xmlns:ns8="urn:beanservice" <name xsi:type="xsd:string">log_version</name> <value xsi:type="xsd:string">1.0</value> <multiref id="id7" soapenc:root="0" xsi:type="ns9:namevaluepair" xmlns:ns9="urn:beanservice" <name xsi:type="xsd:string">num_error</name> <multiref id="id6" soapenc:root="0" xsi:type="ns10:namevaluepair" xmlns:ns10="urn:beanservice" <name xsi:type="xsd:string">log_version</name> <value xsi:type="xsd:string">1.0</value> <multiref id="id4" soapenc:root="0" xsi:type="ns11:namevaluepair" xmlns:ns11="urn:beanservice" <name xsi:type="xsd:string">num_error</name> <multiref id="id11" soapenc:root="0" xsi:type="ns12:namevaluepair" xmlns:ns12="urn:beanservice" <name xsi:type="xsd:string">num_mis_rec</name> <multiref id="id5" soapenc:root="0" xsi:type="ns13:namevaluepair" xmlns:ns13="urn:beanservice" <name xsi:type="xsd:string">num_mis_rec</name> <multiref id="id8" soapenc:root="0" xsi:type="ns14:namevaluepair" xmlns:ns14="urn:beanservice" <name xsi:type="xsd:string">num_mis_rec</name> 14 CALL DETAIL RECORD ACCESS SERVICE

15 getcalldetailrecordsbyfilter <multiref id="id15" soapenc:root="0" xsi:type="ns15:namevaluepair" xmlns:ns15="urn:beanservice" <name xsi:type="xsd:string">log_version</name> <value xsi:type="xsd:string">1.0</value> <multiref id="id10" soapenc:root="0" xsi:type="ns16:namevaluepair" xmlns:ns16="urn:beanservice" <name xsi:type="xsd:string">num_error</name> <multiref id="id14" soapenc:root="0" xsi:type="ns17:namevaluepair" xmlns:ns17="urn:beanservice" <name xsi:type="xsd:string">num_mis_rec</name> <multiref id="id9" soapenc:root="0" xsi:type="ns18:namevaluepair" xmlns:ns18="urn:beanservice" <name xsi:type="xsd:string">log_version</name> <value xsi:type="xsd:string">1.0</value> </soapenv:body> </soapenv:envelope> getcalldetailrecordsbyfilter Syntax Returns a list of call detail records for the set of calls that match the specified criteria. CallDetailRecord[] getcalldetailrecordsbyfilter( String organizationid, String applicationid, Filter[] filterlist, OrderBy[] orderbylist, int startindex, int recordcount, boolean requestextendeddata ) CALL DETAIL RECORD ACCESS SERVICE 15

16 CALL DETAIL RECORD ACCESS SERVICE Parameters Returns Faults Parameter organizationid applicationid filterlist orderbylist startindex recordcount requestextendeddata Description A list of CDRs matching the specified criteria. The organization identifier. This ID is assigned when the application is provisioned. For Café developers, the value is always BVCLDEV. The application identifier. This ID is assigned when the application is provisioned. For Café developers, the value is the Café user ID. An array of Filter objects to constrain the query. Each filter specifies: a field on which to filter, such as EnumFilterField.ERROR_COUNT. an operator, such as EnumFilterOperator.GREATER_THAN. if applicable, an operand, such as 4; at present, an operand must be of type Date, String, or Integer. An array of OrderBy objects specifying the columns on which to sort the results. Each object specifies a field to use for ordering (such as EnumOrderByField.CALLING_PARTY) and a boolean indicating whether to sort in ascending or descending order. The starting index of the subset of records matching the criteria that are actually wanted. If you first use getcalldetailrecordcountbyfilter to determine the number of records that match your filter, you can then get those records in batches, by specifying a startindex and recordcount to this method. The number of records to retrieve. Determines whether or not to include extended data with the records. In some cases, the platform may associate additional data with a CDR. If this parameter is true, that additional data is included with the returned records as a set of name-value pairs. For Café applications, the platform always associates extended data. Currently, the available extended data are: NUM_ERROR--the number of errors NUM_MISRECS--the number of rejections REQ_ID--outbound request ID associated with the session (for outbound notification calls) CONNECTED--the time the call was actually connected (for outbound notification calls) For many faults, you can see the fault detail for additional information. Fault Number Description 1002 Access denied. (Client does not have access to the requested data.) 1003 The requested data is not available. 16 CALL DETAIL RECORD ACCESS SERVICE

17 getcalldetailrecordsbyfilter Examples SOAP Request POST /CDRAccessService_v2/services/CDRAccessService_v2 HTTP/1.0 Content-Type: text/xml; charset=utf-8 Accept: application/soap+xml, application/dime, multipart/related, text/* User-Agent: Axis/1.0 Host: utopia Cache-Control: no-cache Pragma: no-cache SOAPAction: "" Content-Length: 4448 <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv=" xmlns:xsd=" xmlns:xsi=" <soapenv:header> <ns1:platformservicessessionid xsi:type="xsd:string" xmlns:ns1=" E3EB1B1D378CC147ED935EFF39B8C911 </ns1:platformservicessessionid> </soapenv:header> <soapenv:body> <ns2:getcalldetailrecordsbyfilter xmlns:ns2="cdraccessservice_v2"> <arg0 xsi:type="xsd:string">bvcldev</arg0> <arg1 xsi:type="xsd:string"> </arg1> <arg2 xsi:type="soapenc:array" soapenc:arraytype="ns3:filter[2]" xmlns:soapenc=" xmlns:ns3="urn:beanservice"> <item href="#id0"/> <item href="#id1"/> </arg2> <arg3 xsi:type="soapenc:array" soapenc:arraytype="ns4:orderby[2]" xmlns:soapenc=" xmlns:ns4="urn:beanservice"> <item href="#id2"/> <item href="#id3"/> </arg3> <arg4 xsi:type="xsd:int">1</arg4> <arg5 xsi:type="xsd:int">33</arg5> <arg6 xsi:type="xsd:boolean">false</arg6> </ns2:getcalldetailrecordsbyfilter> <multiref id="id1" soapenc:root="0" xsi:type="ns5:filter" xmlns:soapenc=" xmlns:ns5="urn:beanservice"> <filterfield href="#id4"/> <filteroperator href="#id5"/> <filteroperand xsi:type="xsd:datetime"> T20:00:00.000Z</filterOperand> CALL DETAIL RECORD ACCESS SERVICE 17

18 CALL DETAIL RECORD ACCESS SERVICE <multiref id="id3" soapenc:root="0" xsi:type="ns6:orderby" xmlns:ns6="urn:beanservice" <orderbyascending xsi:type="xsd:boolean">false</orderbyascending> <orderbyfield href="#id6"/> <multiref id="id0" soapenc:root="0" xsi:type="ns7:filter" xmlns:ns7="urn:beanservice" <filterfield href="#id7"/> <filteroperator href="#id8"/> <filteroperand xsi:type="xsd:datetime"> T20:00:00.000Z</filterOperand> <multiref id="id2" soapenc:root="0" xsi:type="ns8:orderby" xmlns:ns8="urn:beanservice" <orderbyascending xsi:type="xsd:boolean">true</orderbyascending> <orderbyfield href="#id9"/> <multiref id="id5" soapenc:root="0" xsi:type="ns9:enumfilteroperator" xmlns:ns9="urn:beanservice" <value xsi:type="xsd:string">less_than_or_equals</value> <multiref id="id7" soapenc:root="0" xsi:type="ns10:enumfilterfield" xmlns:ns10="urn:beanservice" <value xsi:type="xsd:string">start_time</value> <multiref id="id4" soapenc:root="0" xsi:type="ns11:enumfilterfield" xmlns:ns11="urn:beanservice" <value xsi:type="xsd:string">end_time</value> <multiref id="id9" soapenc:root="0" xsi:type="ns12:enumorderbyfield" xmlns:ns12="urn:beanservice" <value xsi:type="xsd:string">start_time</value> <multiref id="id6" soapenc:root="0" xsi:type="ns13:enumorderbyfield" xmlns:ns13="urn:beanservice" <value xsi:type="xsd:string">end_time</value> <multiref id="id8" soapenc:root="0" 18 CALL DETAIL RECORD ACCESS SERVICE

19 getcalldetailrecordsbyfilter xsi:type="ns14:enumfilteroperator" xmlns:ns14="urn:beanservice" <value xsi:type="xsd:string">greater_than_or_equals</value> </soapenv:body> </soapenv:envelope> SOAP Response HTTP/ OK Server: Resin/2.1.4 Content-Type: text/xml; charset=utf-8 Date: Wed, 19 Mar :16:14 GMT <?xml version="1.0" encoding="utf-8"?> <soapenv:envelope xmlns:soapenv=" xmlns:xsd=" xmlns:xsi=" <soapenv:body> <ns1:getcalldetailrecordsbyfilterresponse xmlns:ns1="cdraccessservice_v2"> <getcalldetailrecordsbyfilterreturn xsi:type="soapenc:array" soapenc:arraytype="ns2:calldetailrecord[33]" xmlns:soapenc=" xmlns:ns2="urn:beanservice"> <item href="#id0"/> <item href="#id1"/> <item href="#id2"/>... <item href="#id32"/> </getcalldetailrecordsbyfilterreturn> </ns1:getcalldetailrecordsbyfilterresponse> <multiref id="id2" soapenc:root="0" xsi:type="ns12:calldetailrecord" xmlns:ns12="urn:beanservice" <calldurationseconds xsi:type="xsd:int">77</calldurationseconds> <capturedutterancecount xsi:type="xsd:int">0</capturedutterancecount> <utterancesavailable xsi:type="xsd:boolean">false</utterancesavailable> <parentsessionid xsi:type="xsd:string" xsi:nil="true"/> <applicationid xsi:type="xsd:string"> </applicationid> <calledparty xsi:type="xsd:string"> </calledparty> <bevocalcalllogavailable xsi:type="xsd:boolean">true</bevocalcalllogavailable> <sessionid xsi:type="xsd:string">2002-engca002-ch001-fw6bz</sessionid> <callresult xsi:type="xsd:string">completed</callresult> <mediagatewayhostname xsi:type="xsd:string">engcm002</mediagatewayhostname> <extendeddata xsi:type="soapenc:array" xsi:nil="true"/> <callingparty xsi:type="xsd:string"> </callingparty> <mediagatewaychannel xsi:type="xsd:string">ch001</mediagatewaychannel> <speechvendorcalllogavailable xsi:type="xsd:boolean">true</speechvendorcalllogavailable> <originalcallingparty xsi:type="xsd:string" xsi:nil="true"/> <startdatetime xsi:type="xsd:datetime"> T11:23:59.000Z</startDateTime> <organizationid xsi:type="xsd:string">bvcldev</organizationid> CALL DETAIL RECORD ACCESS SERVICE 19

20 CALL DETAIL RECORD ACCESS SERVICE <initialurl xsi:type="xsd:string"> <calltype xsi:type="xsd:string">inbound</calltype> <multiref id="id1" soapenc:root="0" xsi:type="ns16:calldetailrecord" xmlns:ns16="urn:beanservice" <calldurationseconds xsi:type="xsd:int">24</calldurationseconds> <capturedutterancecount xsi:type="xsd:int">0</capturedutterancecount> <utterancesavailable xsi:type="xsd:boolean">false</utterancesavailable> <parentsessionid xsi:type="xsd:string" xsi:nil="true"/> <applicationid xsi:type="xsd:string"> </applicationid> <calledparty xsi:type="xsd:string"> </calledparty> <bevocalcalllogavailable xsi:type="xsd:boolean">true</bevocalcalllogavailable> <sessionid xsi:type="xsd:string">2002-engca002-ch001-ftmm3</sessionid> <callresult xsi:type="xsd:string">completed</callresult> <mediagatewayhostname xsi:type="xsd:string">engcm002</mediagatewayhostname> <extendeddata xsi:type="soapenc:array" xsi:nil="true"/> <callingparty xsi:type="xsd:string"> </callingparty> <mediagatewaychannel xsi:type="xsd:string">ch001</mediagatewaychannel> <speechvendorcalllogavailable xsi:type="xsd:boolean"> true</speechvendorcalllogavailable> <originalcallingparty xsi:type="xsd:string" xsi:nil="true"/> <startdatetime xsi:type="xsd:datetime"> T14:22:51.000Z</startDateTime> <organizationid xsi:type="xsd:string">bvcldev</organizationid> <initialurl xsi:type="xsd:string"> <calltype xsi:type="xsd:string">inbound</calltype> <multiref id="id0" soapenc:root="0" xsi:type="ns19:calldetailrecord" xmlns:ns19="urn:beanservice" <calldurationseconds xsi:type="xsd:int">40</calldurationseconds> <capturedutterancecount xsi:type="xsd:int">0</capturedutterancecount> <utterancesavailable xsi:type="xsd:boolean">false</utterancesavailable> <parentsessionid xsi:type="xsd:string" xsi:nil="true"/> <applicationid xsi:type="xsd:string"> </applicationid> <calledparty xsi:type="xsd:string"> </calledparty> <bevocalcalllogavailable xsi:type="xsd:boolean">true</bevocalcalllogavailable> <sessionid xsi:type="xsd:string">2002-engca002-ch001-fo9dr</sessionid> <callresult xsi:type="xsd:string">completed</callresult> <mediagatewayhostname xsi:type="xsd:string">engcm002</mediagatewayhostname> <extendeddata xsi:type="soapenc:array" xsi:nil="true"/> <callingparty xsi:type="xsd:string"> </callingparty> <mediagatewaychannel xsi:type="xsd:string">ch001</mediagatewaychannel> <speechvendorcalllogavailable xsi:type="xsd:boolean"> true</speechvendorcalllogavailable> <originalcallingparty xsi:type="xsd:string" xsi:nil="true"/> <startdatetime xsi:type="xsd:datetime"> T16:49:03.000Z</startDateTime> <organizationid xsi:type="xsd:string">bvcldev</organizationid> <initialurl xsi:type="xsd:string"> 20 CALL DETAIL RECORD ACCESS SERVICE