Web Hooks
IVR Web Hook SurVo NetGet Custom Audio Prompts Post Call Action Agent Panel Lookup Distributor FormCall 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-AgentAdministration API
addonsbroadcastclicktoconference- attendee.add
- attendee.call
- attendee.details
- attendee.kick
- attendee.list
- attendee.mute
- attendee.remove
- attendee.unmute
- details
- list
- remove
- schedule
- add_number
- create
- delete
- delete_number
- delete_recorded_call
- empty
- get_findme_list
- get_phone_list
- get_recorded_calls_list
- update_list_settings
broadcast.create
Create a new Voice Broadcast and optionally create a campaign for that Voice Broadcast.
Arguments
- access_key (required)
- Your Access Key.
- secret_access_key (required)
- Your Secret Access Key.
- name (required)
- Name for the Basic Broadcast Dialog
- recording_phone_number (required)
- Number to dial to record the audio message
- phone (required)
- Required if schedule is set. Either a bar delimited list of numbers, or url of a csv file
- machine_detection (optional)
- Option to record a separate message for answering machines
- use_transfer (optional)
- Option to transfer a call during the broadcast message
- transfer_number (optional)
- Required if use_transfer is set. This is the number calls will be transffered to.
- schedule (optional)
- Option to schedule the Basic Broadcast
- simul (optional)
- Optional if using schedule. Number of calls to make every 2 minutes. Maximum is defined by your account type (usually 25).
- timestamp (optional)
- Optional if using schedule. If not specified, calls will be delivered right away. Format is YYYY-MM-DD HH:ii GMT. Ex: 2008-09-12 15:00 -0500
- dstime (optional)
- Optional if using schedule. If not specified, system will use 00:01. Format is HH:ii. Calls will go out after this time.
- detime (optional)
- Optional if using schedule. If not specified, system will use 23:59. Format is HH:ii. Calls will go out before this time.
- recording_cid (optional)
- Set the caller ID for the phone call the user receives to record the broadcast message.
- desc (optional)
- Description of the voice broadcast.
Example URL
https://secure.ifbyphone.com/ibp_api.php
?access_key=ACCESS_KEY
&secret_access_key=SECRET_ACCESS_KEY
&action=broadcast.create
&name=Voice+Broadcast+%2312+at+2008-11-11+07%3A13
&phone_number_list=7735551212
&recording_phone_number=7735550000
Example Response
<response>
<result>success</result>
<result_description>Basic Audio Dialog Created</result_description>
<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: