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

broadcast.schedule

Schedule a basic Voice Broadcast.

Arguments

access_key (required)
Your Access Key.
secret_access_key (required)
Your Secret Access Key.
phone_number_list (required)
Either a bar delimited list of numbers, or url of a csv file
audio_dialog_id (required)
ID of the Basic Broadcast Dialog that is being scheduled
timestamp (optional)
If not specified, calls will be delivered right away. Format is YYYY-MM-DD HH:ii GMT. Ex: 2008-09-12 15:00 -0500
edate (optional)
Required if broadcast type is 1.
type (optional)
Set to 1 if you want to spread calls evenly between the broadcasts start and end date. Set to 2 if you wish to deliver broadcast message as quickly as possible. Default is 2.
attempts (optional)
Number of times you want to call each number on list if we detect busy or no answer. Default is 1 - meaning no retries. Max is 3.
retry (optional)
Number of minutes between retry attempts on a phone number Default is 5. Valid values are: 5, 10, 15, 30, 60, 90, 120
cid (optional)
Caller ID that shows up to the recipients of the Broadcast. Valid values are any number on the account, or listed within accounts Registered Numbers list.
dstime (optional)
If not specified, system will use 00:01. Format is HH:ii. Calls will go out after this time.
detime (optional)
If not specified, system will use 23:59. Format is HH:ii. Calls will go out before this time.
simul (optional)
Number of calls to make every 2 minutes. Maximum is defined by your account type (usually 25).
desc (optional)
Identifier for the Broadcast used for GUI management. Valid Values contain alphanumeric characters and spaces.

Example URL

https://secure.ifbyphone.com/ibp_api.php
?access_key=ACCESS_KEY
&secret_access_key=SECRET_ACCESS_KEY
&action=broadcast.schedule
&audio_dialog_id=20901
&phone_number_list=http%3A%2F%2Fwww.example.com%2Ffiles
%2Fnumberstocall.csv
&timestamp=2008-11-13%2016%3A08%20-0600
&edate=2008-11-22%2016%3A08
&desc=campaign%2012
&type=2
&dstime=00%3A00
&detime=23%3A59

Example Response

<response>

<result>success</result>

<result_description>

Basic Audio Broadcast Created

</result_description>

<basic_broadcast_id>60451</basic_broadcast_id>

<audio_dialog_id>20901</audio_dialog_id>

</response>

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: