PhoneGnome API >> phonegnome.cdrQuery

phonegnome.cdrQuery

Query Call Detail Records (CDR).

This operation retrieves call log data. There are three types of records that can be retrieved, Answered calls, Missed calls, and Placed calls. The results are returned as an array of data structures. Each element of the array represents one CDR record of the requested type. The data for a given CDR record is given as a structure with members varying slightly by the type of record as follows:

• Answered
  • date - (dateTime.iso8601): event date
  • phone - (string): phone number of caller
  • name - (string): name of caller
  • duration - (string): duration of call as HH:MM:SS
  • type - (string): type of call, PSTN or NET
• Missed
  • date - (dateTime.iso8601): event date
  • phone - (string): phone number of caller
  • name - (string): name of caller
  • type - (string): type of call, PSTN or NET
• Placed
  • date - (dateTime.iso8601): event date
  • phone - (string): phone number of caller
  • duration - (string): duration of call as HH:MM:SS
  • type - (string): type of call, PSTN, ITSP, or NET

URI

All XML-RPC requests should go to the following URI: http://my.phonegnome.com/RPC2

Parameters

1. country_code (string): Country code of the PhoneGnome
2. phone_number (string): Telephone number of the PhoneGnome
3. md5_pin (string): MD5 hash of the PIN of the PhoneGnome account (PIN is same as that of the my.phonegnome.com dashboard)
4. query type (string): Class of result desired: literal Answered, Missed, or Placed
5. direction (string): Sort order: literal increasing or decreasing
6. startdate (dateTime.iso8601): Beginning of date range, specified in dateTime.iso8601 format
7. enddate (dateTime.iso8601): Ending of date range, specified in dateTime.iso8601 format

Examples

Example XML-RPC request

<?xml version="1.0"?>
<methodCall>
 <methodName>phonegnome.cdrQuery</methodName>
  <params>
   <param>
    <value><string>1</string></value>
   </param>
   <param>
    <value><string>3605551212</string></value>
   </param>
   <param>
    <value><string>3d5196996ac581a0b8c43a94cbaa586a</string></value>
   </param>
   <param>
    <value><string>Missed</string></value>
   </param>
   <param>
    <value><string>decreasing</string></value>
   </param>
   <param>
    <value><dateTime.iso8601>20050420T08:49:32</dateTime.iso8601></value>
   </param>
   <param>
    <value><dateTime.iso8601>20051017T08:49:32</dateTime.iso8601></value>
   </param>
  </params>
</methodCall>

Successful Response

<?xml version="1.0"?>
<methodResponse>
 <params>
  <param>
   <value>
    <array>
     <data>
      <value>
       <struct>
        <member>
         <name>name</name>
         <value><string></string></value>
        </member>
        <member>
         <name>type</name>
         <value><string>PSTN</string></value>
        </member>
        <member>
         <name>phone</name>
         <value><string>UNKNOWN</string></value>
        </member>
        <member>
         <name>date</name>
         <value><dateTime.iso8601>20050730T10:11:04</dateTime.iso8601></value>
        </member>
       </struct>
      </value>

      <value>
       <struct>
        <member>
         <name>name</name>
         <value><string>INTER RES CORP</string></value>
        </member>
        <member>
         <name>type</name>
         <value><string>PSTN</string></value>
        </member>
        <member>
         <name>phone</name>
         <value><string>6504542989</string></value>
        </member>
        <member>
         <name>date</name>
         <value><dateTime.iso8601>20050516T11:25:49</dateTime.iso8601></value>
        </member>
       </struct>
      </value>

      <value>
       <struct>
        <member>
         <name>name</name>
         <value><string>BRETONS SCHL FO</string></value>
        </member>
        <member>
         <name>type</name>
         <value><string>PSTN</string></value>
        </member>
        <member>
         <name>phone</name>
         <value><string>9256623134</string></value>
        </member>
        <member>
         <name>date</name>
         <value><dateTime.iso8601>20050510T13:27:47</dateTime.iso8601></value>
        </member>
       </struct>
      </value>

     </data>
    </array>
   </value>

  </param>
 </params>
</methodResponse>

Error Response

<?xml version="1.0"?>
<methodResponse>
 <fault>
  <value>
   <struct>
    <member>
     <name>faultString</name>
     <value><string>invalid date</string></value>
    </member>
    <member>
     <name>faultCode</name>
     <value><int>603</int></value>
    </member>
   </struct>
  </value>
 </fault>
</methodResponse>

© TelEvolution 2006