DEV Outbound APIs

Queue a Single Call with the queuecall web service

This default campaign and the calls within it are visible in and controlled from your campaign management interface after you login with your login name and PIN.‌ If you do not already have a PIN for outbound calling, contact Plum's Account Management team.

If you plan to queue more than one call at a time, use the Queue Multiple Calls API Method

post
Queue A Single Call

http://outbound.plumvoice.com/webservice/queuecall.php‌
The queuecall API method allows users to initiate a call to a specific phone number. Initiating an outbound call in this manner places the call into the default calling campaign for your account.
Request
Response
Request
Form Data Parameters
login
required
string
Sender login name (max length 128)
pin
required
string
Sender PIN code (max length 16)
phone_number
required
string
Phone number to be dialed (include a 1 before the area code) (max length 128)
start_url
required
string
URL for the VoiceXML script used for the call (max length 255)
result_url
optional
string
URL for post-call processing (max length 255)
message_reference
optional
string
The message_reference string is POSTed to the URL specified by start_url (max length 255)
call_parameters
optional
string
The call_parameters string is POSTed to the URL specified by start_url (max length 255)
max_retry
optional
integer
An integer between 0 and 10 for the number of failed call attempts before giving up
retry_interval
optional
integer
An integer from 60 to 172800 indicating the number of seconds between retries
scheduled_timestamp
optional
integer
0 to start immediately or a UNIX-time integer indicating when to start attempting the call
expiration_timestamp
optional
integer
0 to never expire or a UNIX-time integer indicating when the outbound system should give up attempting to complete an uncompleted call
scheduled_time
optional
string
Alternative option to scheduled_timestamp. See call control settings below. (max length 80)
expiration_time
optional
string
Alternative option to expiration_timestamp. See call control settings below. (max length 80)
is_pci
optional
integer
0 or 1. For customers who have been granted access to our HIPAA-/PCI-compliant secure environment, setting this flag to 1 causes connected outbound calls to execute within that secure environment.
Response
200: OK
Required Parameters
Required & Optional Parameters
Required Parameters
<?xml version="1.0"?>
<queuecall status="queued" call_id="112850593">
<login>user</login>
<pin>98765432</pin>
<phone_number>+1234567890;ani=8001234567</phone_number>
<start_url>http://charles.plumgroup.com/~schan/src/charles/vxml/start.php</start_url>
</queuecall>
Required & Optional Parameters
<?xml version="1.0"?>
<queuecall status="queued" call_id="112852724">
<login>user</login>
<pin>98765432</pin>
<phone_number>+1234567890;ani=8001234567</phone_number>
<start_url>http://charles.plumgroup.com/~schan/src/charles/vxml/start.php</start_url>
<max_retries>1</max_retries>
<retry_interval>70</retry_interval>
<scheduled_timestamp>1596832808</scheduled_timestamp>
<scheduled_time>Fri, 07 Aug 2020 16:40:08 -0400</scheduled_time>
</queuecall>

See the Outbound API parameter notes for additional information on these single call API parameters.

Queue Multiple Calls with the queuecalls web service

The campaign manager interface allows users to assign campaigns a unique name and to manage various aspects of the campaign. Use your login name and PIN to access the campaign manager.‌ If you do not already have a PIN for outbound calling, contact Plum's Account Management team.

post
Queue Multiple Calls

http://outbound.plumvoice.com/webservice/queuecalls.php‌
The queuecalls API method allows users to initiate calls to any number of callers listed in an uploaded text file. Initiating a group of outbound calls in this manner creates a calling campaign.
Request
Response
Request
Headers
content-type
required
string
multipart/form-data
Form Data Parameters
login
required
string
Sender login name (max length 128)
pin
required
string
Sender PIN code (max length 16)
campaign_name
required
string
Unique name for the new calling campaign
phone_list
required
object
CSV file containing the list of phone numbers to be dialed, and optionally the message_reference and call_parameter. Each line will include the following items, delimited by a comma: 1) Phone number destination, include "1" before the area code (required) 2) message_reference - string posted to start_url and result_url (max length 128, optional) 3) call_parameter - string posted to start_url (max length 255, optional)
start_url
required
string
URL for the VoiceXML script used for the call (max length 255)
result_url
optional
string
URL for post-call processing (max length 255)
message_reference
optional
string
The message_reference string is POSTed to the URL specified by start_url (max length 255)
call_parameters
optional
string
The call_parameters string is POSTed to the URL specified by start_url (max length 255)
max_retry
optional
integer
An integer between 0 and 10 for the number of failed call attempts before giving up
retry_interval
optional
integer
An integer from 60 to 172800 indicating the number of seconds between retries
scheduled_timestamp
optional
integer
0 to start immediately or a UNIX-time integer indicating when to start attempting the call
expiration_timestamp
optional
integer
0 to never expire or a UNIX-time integer indicating when the outbound system should give up attempting to complete an uncompleted call
scheduled_time
optional
string
Alternative option to scheduled_timestamp. See call control settings below. (max length 80)
expiration_time
optional
string
Alternative option to expiration_timestamp. See call control settings below. (max length 80)
is_pci
optional
integer
0 or 1. For customers who have been granted access to our HIPAA-/PCI-compliant secure environment, setting this flag to 1 causes connected outbound calls to execute within that secure environment.
Response
200: OK
<?xml version="1.0"?>
<queuecalls status="success">
<login>user</login>
<pin>98765432</pin>
<campaign_name>SunnyCamp</campaign_name>
<start_url>http://charles.plumgroup.com/~schan/src/charles/vxml/start.php</start_url>
<phone_list>
<call call_id="112897970">
<phone_number>tel:+19492222222;ani=8009957586</phone_number>
</call>
<call call_id="112897971">
<phone_number>tel:+19492222223;ani=8009957586</phone_number>
</call>
</phone_list>
</queuecalls>

You must POST with multipart/form-data encoding in order for the queuecalls webservice to properly receive and process the uploaded file .‌

All settings are applied to all calls in the campaign. However, message_reference and call_parameters (see below) are set on a per-call basis and are specified in the uploaded text file with each phone number.‌

Required Settings

Calls are listed in the phone number list file on comma-delimited lines where the first field is the phone number and the second and third fields contain a message_reference string and call_parameters string, respectively, for the call as described here. The second and third fields are optional.‌

See the Outbound API parameter notes for additional information on these multi-call API parameters.