Overview

Sample Code

Web Hooks

IVR Web Hook SurVo NetGet Custom Audio Prompts Post Call Action Agent Panel Lookup Distributor Form

Call Initiation API

Click-to-Call Click-to-Find Me Click-to-Find Me List Click-to-Virtual Receptionist Click-to-Voice Mail Click-to-SurVo Click-to-IVR Click-to-Agent

Administration API

addonsbroadcastclicktoconferencecostfindmegeneralgrouplocatornumbersrecordingregisterednumbersreportroutingsmssurvoverifymenowvmail

report.call_detail

Fully customizable Call Detail Report that allows you to choose which data (columns) you want returned in the report.

Arguments

access_key (required)
Your Access Key.
secret_access_key (required)
Your Secret Access Key.
start_date (required)
Start date for the report in YYYYMMDD format (20090503).
end_date (required)
End date for the report in YYYYMMDD format (20090504).
gclid (optional)
A Google generated unique ID for each click that comes to your website from an Adwords ad.
google_client_id (optional)
An ID generated by Google Universal Analytics that is unique to a particular visitor.
findme_number_label (optional)
The label associated with a Find Me transfer number
format (optional)
Output format. Values can be xml for XML, csv for comma-separated values and text for semi-colon delimited values. Default is csv.
start_time (optional)
Daily start time. Must be used with end_time to create a daily time range. Time is in hh:mm:ss 24-hour format. Example: 1:30pm would be written as 13:30:00.
end_time (optional)
Daily end time. Must be used with start_time to create a daily time range. Time is in hh:mm:ss 24-hour format. Example: 1:30pm would be written as 13:30:00.
date_added (optional)
Date/Time the call was made.
call_type_filter (optional)
Filter report by type of call. Valid values are: Inbound, Outbound or Click-To.
phone_label (optional)
The label you assigned to the phone number in phone routing.
dnis (optional)
The number dialed.
ani (optional)
Caller ID.
first_activity (optional)
First action taken when the call came in such as routing to a Virtual Receptionist, SurVo, etc.
last_activity (optional)
The last action taken during the call.
activity_info (optional)
All actions taken during the call.
click_description (optional)
If the call was initiated using a Click-to-Call this will show the description you assigned to that Click-to-Call.
switch_minutes (optional)
The duration, in tenths of a minute, a call is on the system while not connected to a 2nd leg. For example when a caller is going through a Virtual Receptionist or SurVo and is not connected to another person.
network_minutes (optional)
The duration, in tenths of a minute, that two parties are connected together.
enhanced_minutes (optional)
The duration, in tenths of a minute, when a caller is being recorded. This includes a recorded Find-Me, recordings made in a SurVo, etc. These do not include minutes used when you record your prompts for Voice Mail, Find Me, etc.
adj_switch (optional)
Intelligent Minutes rounded up to the next minute.
adj_network (optional)
Talk Minutes rounded up to the next minute.
adj_enhanced (optional)
Enhanced Minutes rounded up to the next minute.
call_duration (optional)
Total call duration rounded up to the next minute. This is the sum of Intelligent, Talk and Enhanced minutes.
transfer_type (optional)
When a call is transferred what initiated the transfer such as SurVo Transfer or Find Me Transfer.
transfer_to_number (optional)
The number the call was transferred to.
last_name (optional)
Last name of caller if reverse-lookup is enabled and data was found.
first_name (optional)
First name of caller if reverse-lookup is enabled and data was found.
street_address (optional)
Address of caller if reverse-lookup is enabled and data was found.
city (optional)
City of caller if reverse-lookup is enabled and data was found.
state (optional)
State of caller if reverse-lookup is enabled and data was found.
zipcode (optional)
Zip code of caller if reverse-lookup is enabled and data was found.
call_type_value (optional)
If Call Type is set to Inbound then set Call Type Value to one of your inbound numbers to filter the report by that number. If Call Type is set to Click-To then Call Type Value needs to be the building block ID of one of your Click-To's. The Outbound Call Type does not need a value.
call_type (optional)
Display the Call Type column
sid (optional)
Display the Session ID (SID) column. This is the unique identifier for each phone call.

Example URL

https://secure.ifbyphone.com/ibp_api.php
?access_key=ACCESS_KEY
&secret_access_key=SECRET_ACCESS_KEY
&action=report.call_detail
&start_date=20100101
&end_date=20100131
&date_added=1
&phone_label=1
&dnis=1
&ani=1
&call_duration=1

Example Response

"date_added","dnis","ani","phone_label","call_duration"
"2010-01-12 11:16:37","8479833207","3124362454","",1
"2010-01-12 11:18:17","8479833207","3124362454","",1
"2010-01-12 11:19:02","8479833207","3124362454","",1
"2010-01-12 16:37:27","8479833207","6302025723","",1
"2010-01-12 16:53:34","8476766553","3124362454","",1
"2010-01-12 16:56:58","8479833207","3124362454","",1

API Test Panel

NOTE: The API Test Panel can be used to try out the various API methods
using the actual data from your account. You must be logged
into your account to make any API calls using the test panel.

  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
     
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
 

URL:

XML Result: