getCallData

Request Method: GET

Description: Collects all call data

URL: https://api.iovox.com:444/Calls?v=3&method=getCallData

The following parameters can be sent in the querystring

ParameterDescriptionDefault ValueData TypeMandatory
vAPI version to use
INTEGERYES
pageThe page number to return. Use together with limit to achieve paginated results1INTEGERNO
limitDetermines how many results to return. Use together with page to achieve paginated results. Maximum here is 2000020000INTEGERNO
order

Determines which field to order the output result by. Use a field name from the req_fields list (exclusive of cat_v, cat_lbl and cat_id) and suffix with ASC or DESC for ascending or descending respectively. For example, "cs_DESC" will return results ordered by call_start with the most recent first.

cs_DESCSTRINGNO
sdtReturns all calls received since a given date. Start date format is YYYY-MM-DD HH:MM:SS with hours, minutes and seconds being optional. Hours, minutes and seconds defaults to 00:00:001st day of current month at 00:00:00DATETIMENO
edtReturns all calls received before a given date. End date format is YYYY-MM-DD HH:MM:SS with hours, minutes and seconds being optional. Hours, minutes and seconds defaults to 23:59:59Current day at 23:59:59DATETIMENO
dconstShortcut to request calls received on a particular date
YESTERDAY : Return yesterday's calls, from 00:00:00 to 23:59:59

STRINGNO
idReturns the Call with the specified Call ID
STRINGNO
node_idReturns all calls for the specified Node ID
STRINGNO
node_typeReturns all calls for the specified Node Type
STRINGNO
link_idReturns all calls for the specified Link ID
STRINGNO
link_typeReturns all calls for the specified Link Type
STRINGNO
ctypeReturns all data under the given call type, e.g. DIRECT or API
STRINGNO
call_resReturns all data under the given call result, e.g. ANSWERED
STRINGNO
rule_resReturns all data under the given rule result, e.g. Call to an Operator
STRINGNO
call_originReturns all data under the given call origin, e.g. 447966111222
STRINGNO
call_origin_encodedReturns all data under the given call origin encoded, the 4 first digits are not encoded (country code and area code)
e.g. 44798833057321

STRINGNO
voxnumberReturns all data under the given VoxNumber, e.g. 448456111222
INTEGERNO

call_dest

Returns all data under the given call destination, e.g. 447966123456
STRINGNO
directionReturns all data under the given direction e.g. IN
ENUM ['IN,'OUT','INTERNAL']NO
detailReturns all data for the given detail. This includes IP Address (for makeTwoWayCall) and conference room number
STRINGNO
cat_idsReturns all data for the given category IDs. To produce an AND based search separate each by a comma and to produce an OR based, separate as array elements. For example, cat_ids[]=1,2&cat_ids[]=3,4 would search where category ID is (1 AND 2) OR (3 AND 4). Note: if a search is made for Category ID 5, potentially Location = London, results will include any items further down the tree, such as Notting Hill
ARRAYNO
req_fields

Comma separated list of abbreviated fields to return in response.
id=id
cs=Call Start
ce=Call End
co=Call Origin
coe=Call Origin Encoded
col= Call Origin Location
vn=VoxNumber
cd=Call Destination
detail=IP Address/Conference ID
ct=Formatted Call Time (00:00:00)
cts=Call Time in Seconds
tt=Formated Talk Time (00:00:00)
tts=Talk Time in Seconds
ctype=Call Type
call_res=Call Result
rule_res=Rule Result
nid=Node ID
nname=Node Name
ntype=Node Type
lid=Link ID
lname=Link Name
ltype=Link Type
has_rec=Has Recording
es=Email Sent
cat_id=Link Category ID
cat_lbl=Link Category Label
cat_v=Link Category Value
call_cat_id=Call Category ID
call_cat_lbl=Call Category Label
call_cat_v=Call Category Value
node_cat_id=Node Category ID
node_cat_lbl=Node Category Label
node_cat_v=Node Category Value
contact_cat_id=Contact Category ID
contact_cat_lbl=Contact Category ID
contact_cat_v=Contact Category ID
direction=Direction

id,cs,ce,co,
vn,cd,tt,
call_res,nid,
lid,has_rec
STRINGNO
outputSpecifying XML or JSON returns data in XML or JSON format XMLSTRINGNO

Result

Error Result

HTTP CodeError StringResolution
400API Version EmptyAdd a value for the v parameter in the query string
400API Version InvalidCorrect v parameter
400Request Method must be GET. x attemptedSwitch request method x to GET
400Order Field InvalidCheck the allowed abbreviation fields in the documentation
400Order Direction InvalidCorrect the direction in the order
400Page number not an integerRemove non-numerics from page
400Limit not an integerRemove non-numerics from limit
400Limit must be between 1 and 20000Correct the limit parameter
400Start Date InvalidCorrect sdt parameter
400End Date InvalidCorrect edt parameter
400VoxNumber not an integerCorrect VoxNumber parameter
400Required Fields Invalid: fieldone, fieldtwoCorrect or remove fieldone and fieldtwo
400Output Type InvalidCorrect output parameter
500Internal Server ErrorRetry later

Success Result

<?xml version="1.0" encoding="utf-8"?>
<response>
  <current_page>1</current_page>
  <total_pages>4</total_pages>
  <total_results>100</total_results>
  <results>
    <result>
      <id>3604</id>
      <call_start>2008-11-19 14:10:46</call_start>
      <call_end>2008-11-19 14:11:40</call_end>
      <call_origin>441454112233</call_origin>
      <call_origin_encoded>44118933157160</call_origin_encoded>
      <call_origin_location>Orange</call_origin_location>
      <voxnumber>448452650000</voxnumber>
      <call_destination>441454612234</call_destination>
      <detail>none</detail>
      <call_time>00:00:54</call_time>
      <call_time_sec>54</call_time_sec>
      <talk_time>00:00:30</talk_time>
      <talk_time_sec>30</talk_time_sec>
      <call_result>ANSWERED</call_result>
      <rule_result>Call to an Operator</rule_result>
      <node_id>1234</node_id>
      <node_name>153 Westbourne Grove</node_name>
      <node_type>Property</node_type>
      <link_id>5678</link_id>
      <link_name>Clear Signs</link_name>
      <link_type>Street Sign</link_type>
      <has_recording>1</has_recording>
      <categories>
        <category>
          <label>Location</label>
          <value>London</value>
          <category_id>1</category_id>
        </category>
        <category>
          <label>UserType</label>
          <value>Premium</value>
          <category_id>2</category_id>
        </category>
      </categories>
      <contact_categories>
        <contact_category>
          <label>AgentLanguage</label>
          <value>English</value>
          <category_id>3</category_id>
        </contact_category>
      </contact_categories>
      <call_categories>
        <call_category>
          ...
        </call_category>
      </call_categories>
      <node_categories>
        <node_category>
          ...
        </node_category>
      </node_categories>
    </result>
    <result>
      ...
    </result>
  </results>
</response>