Use the Basic Voice Broadcasting API to create and schedule and update basic, voice broadcasts.
The Basic Voice Broadcasting API allows the user to create and schedule basic voice broadcasts, check the status of an existing voice broadcast, or stop a previously scheduled voice broadcast from airing.
The Click-to-SurVo or Click-to-IVR methods are used to create Smart Voice Broadcasts using SurVo or IVR.
The user may utilize the Basic Voice Broadcasting API with the Create, Get Optout, History, Optout, Schedule, Status, and Stop methods.
Create
broadcast.create
Use the Create method to create a new voice broadcast with an option to create a campaigns.
The parameters listed in the following table may be needed to complete this action:
PARAMETER | REQUIRED | OPTIONAL |
---|---|---|
API Key | X | |
Desc | X | |
Detime | X | |
Dstime | X | |
Machine Detection | X | |
Name | X | |
Phone | X | |
Recording CID | X | |
Recording Phone Number | X | |
Schedule | X | |
Simul | X | |
Time Stamp | X | |
Transfer Number | X | |
User Transfer | X |
Get Optout
broadcast.get_optout
Use the Get Optout method to obtain a list of phone numbers that have opted out of voice broadcasts.
The parameters listed in the following table may be needed to complete this action:
PARAMETER | REQUIRED | OPTIONAL |
---|---|---|
Active | X | |
API Key | X | |
Broadcast ID | X | |
Create Date | X |
History
broadcast.history
Use the History method to obtain a list of all future and completed voice broadcasts.
The parameters listed in the following table may be needed to complete this action:
PARAMETER | REQUIRED | OPTIONAL |
---|---|---|
API Key | X |
Optout
broadcast.optout
Use the Optout method to add a phone number to the opt-out list.
The parameters listed in the following table may be needed to complete this action:
PARAMETER | REQUIRED | OPTIONAL |
---|---|---|
API Key | X |
Schedule
broadcast.schedule
Use the Schedule method to schedule a basic voice broadcast.
The parameters listed in the following table may be needed to complete this action:
PARAMETER | REQUIRED | OPTIONAL |
---|---|---|
API Key | X | |
Attempts | X | |
Audio Dialog ID | X | |
cid | X | |
Desc | X | |
Detime | X | |
Dstime | X | |
Edate | X | |
Phone Number List | X | |
Retry | X | |
Simul | X | |
Time Stamp | X | |
Type | X |
Status
broadcast.status
Use the Status method to obtain a status of all phone calls made during a voice broadcast.
The parameters listed in the following table may be needed to complete this action:
PARAMETER | REQUIRED | OPTIONAL |
---|---|---|
API Key | X | |
Basic Broadcast ID | X | |
GMT | X |
Stop
broadcast.stop
Use the Stop method to stop and delete a voice broadcast.
The parameters listed in the following table may be needed to complete this action:
PARAMETER | REQUIRED | OPTIONAL |
---|---|---|
API Key | X | |
Basic Broadcast ID | X |
API Test Panel
Use the DialogTech API Wizard and Test Panel to make changes to a customer account.
Please note that this tool works with the live data in a customer account. The user must be careful when adding, editing, or deleting data.
/ibp_api.php?api_key=foofoofoo&action=broadcast.create&name=Voice+Broadcast+%2312+at+2008-11-11+07%3A13&phone_number_list=7735551212&recording_phone_number=7735550000
/ibp_api.php?api_key=foofoofoo&action=broadcast.get_optout
/ibp_api.php?api_key=foofoofoo&action=broadcast.history
/ibp_api.php?api_key=foofoofoo&action=broadcast.optout&phone_number=3125551234
/ibp_api.php?api_key=foofoofoo&action=broadcast.schedule&audio_dialog_id=20901&phone_number_list=http%3A%2F%2Fwww.example.com%2Ffiles%2Fnumberstocall.csv×tamp=2008-11-13%2016%3A08%20-0600&edate=2008-11-22%2016%3A08
&desc=campaign%2012&type=2&dstime=00%3A00&detime=23%3A59
/ibp_api.php?api_key=foofoofoo&action=broadcast.status&basic_broadcast_id=20921
/ibp_api.php?api_key=foofoofoo&action=broadcast.stop&basic_broadcast_id=1826
<response>
<result>success</result>
<result_description>Basic Audio Dialog Created</result_description>
<audio_dialog_id>20901</audio_dialog_id>
</response>
<response>
<result>success</result>
<opt_out>
<phone_number>6302025723</phone_number>
<broadcast_id></broadcast_id>
<active>1</active>
<created_date>2009-06-12 14:11:45</created_date>
</opt_out>
</response>
<response>
<result>success</result>
<broadcast>
<broadcast_id>1826</broadcast_id>
<broadcast_name>Demo Broadcast</broadcast_name>
</broadcast>
<broadcast>
<broadcast_id>1773</broadcast_id>
<broadcast_name>broadcasst</broadcast_name>
</broadcast>
</response>
<response>
<result>success</result>
<result_description>Successfully opted 3125551234 out of Voice Broadcasts for this account</result_description>
</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>
<response>
<result>success</result>
<call>
<call_time_scheduled>2009-06-03 14:53</call_time_scheduled>
<call_time_actual>2009-06-03 14:54</call_time_actual>
<call_delay>00:01:02</call_delay>
<number_called>8475551234</number_called>
<call_result>Live Person</call_result>
</call>
<call>
<call_time_scheduled>2009-06-03 14:55</call_time_scheduled>
<call_time_actual>2009-06-03 14:54</call_time_actual>
<call_delay>-00:00:50</call_delay>
<number_called>3125554321</number_called>
<call_result>Answering Machine</call_result>
</call>
</response>
<response>
<result>success</result>
<result_description>1 Basic Broadcast(s) Stopped</result_description>
</response>