PhoneGnome API >> phonegnome.getContact

phonegnome.getContact

Query PhoneBook (Contact List).

This operation retrieves PhoneBook entries. The results are returned as an array of data structures. Each element of the array represents one PhoneBook entry given as a structure with members as follows:

• key - (string): Record key
• name - (string): Name of Contact
• phone - (string): phone number (or SIP URI) of Contact
• email - (string): email address of Contact

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. pattern (string): Pattern to match (case-insensitive). Pattern is a simple regular expression. Use '*' to select all records.

Examples

Example XML-RPC request

<?xml version="1.0"?>
<methodCall>
 <methodName>phonegnome.getContact</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>john</string></value>
   </param>
  </params>
</methodCall>

Successful Response

<methodResponse>
 <params>
  <param>
   <value>
    <array>
     <data>
      <value>
       <struct>
        <member>
         <name>key</name>
         <value><string>16</string></value>
        </member>
        <member>
         <name>email</name>
         <value><string>john@smith.org</string></value>
        </member>
        <member>
         <name>name</name>
         <value><string>John Smith</string></value>
        </member>
        <member>
         <name>phone</name>
         <value><string>1-212-444-5656</string></value>
        </member>
       </struct>
      </value>

      <value>
       <struct>
        <member>
         <name>email</name>
         <value><string>johnk@yahoo.com</string></value>
        </member>
        <member>
         <name>name</name>
         <value><string>John Kellerman</string></value>
        </member>
        <member>
         <name>phone</name>
         <value><string>5558000</string></value>
        </member>
       </struct>
      </value>

      <value>
       <struct>
        <member>
         <name>email</name>
         <value><string>jjjsh@smith.org</string></value>
        </member>
        <member>
         <name>name</name>
         <value><string>John Jacob Jingleheimer Smith</string></value>
        </member>
        <member>
         <name>phone</name>
         <value><string>1800-555-1234</string></value>
        </member>
       </struct>
      </value>

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

  </param>
 </params>

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