Call Query

 

A Call Query is a inquiry that your application makes to VoiceShot regarding one or more phone calls.  Call Querys are formatted in XML.  A Call Query is sent from your application over HTTP/HTTPS to VoiceShot.

 

The following attributes can be included in a Call Query:

 

Attribute

Required

action

callid

Optional

menuid

Table 1: Call Query results

 

 

Leaving callid blank retrieves all information for calls for a specific menuid.  Including a callid retrieves all information for calls for a combination of menuid and callid.  Callid is set when making calls.  Each call can have a unique callid, or multiple calls can have the same called creating a group.  Call Query can retrieve information about a specific call or groups of calls.

 

Call Querys return the following results:

 

Attribute

callid

comment

dateandtime

duration

keypress

menuid

phonenumber

promptid

status

Table 2: Call Query results

 

 

In general, Call Summary should be used instead of Call Query.  Call Summary contains more information, is faster and more efficient than Call Query.  Call Query generally requires your application to implement a polling techique as it looks for call results.  Every Call Query that does not return a result or ones that return the same result over and over are a waste of system resources.  Call Summary on the other hand, pushes the call information to your application quickly and efficiently and only when there is call data.  There are no wasted resources with Call Summary.

 

Example 1: Call Query Request

<campaign action="3" menuid="1-1234">

   <phonenumbers>

      <phonenumber callid="" />

   </phonenumbers>

</campaign>

 

Example 2: Call Query Results

<campaign menuid="1-1234">

   <phonenumbers>

       <phonenumber number="8182238964" dateandtime="5/22/2004 4:15:15 PM" callid="123" duration="15" status="Successful" comment="Human Answer">

         <prompts>

            <prompt promptid="1" keypress="" />

            <prompt promptid="2" keypress="" />

            <prompt promptid="3" keypress="#" />

         </prompts>

      </phonenumber>

   </phonenumbers>

</campaign>