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.broadcast

Get a report of all Voice Broadcast in a given date range.

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).
broadcast_id (optional)
Optional Broadcast ID. Default is all Broadcasts
type (optional)
Type of Broadcast to search for. Valid values are survo, basic (for Basic Audio Broadcast) and all. Value is ignored if you specify a broadcast_id.
format (optional)
Values can be xml for XML, csv for comma-separated values and text for semi-colon delimited values. Default is xml.
number (optional)
Filter the Broadcast results to only show results for the given number

Example URL

https://secure.ifbyphone.com/ibp_api.php
?access_key=ACCESS_KEY
&secret_access_key=SECRET_ACCESS_KEY
&action=report.broadcast
&start_date=20090601
&end_date=20090722

Example Response

<record>

<Scheduled_Time>2009-06-05 10:00:00</Scheduled_Time>

<Actual_Time>2009-06-05 10:00:51</Actual_Time>

<Delay_if_Any>00:00:51</Delay_if_Any>

<Number_Called>8475551234</Number_Called>

<Result_of_Call>Live Person</Result_of_Call>

<Response_ID></Response_ID>

<Broadcast_ID>1234</Broadcast_ID>

<Broadcast_Parameters>usr_survey_id=0001</Broadcast_Parameters>

</record>

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: