Queue Multiple Calls

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.

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Sender login name (max length 128)

string
required

Sender PIN code (max length 16)

string

Unique name for the new calling campaign

file
required

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)
string
required

URL for the VoiceXML script used for the call (max length 255)

string

URL for post-call processing (max length 255)

string

The message_reference string is POSTed to the URL specified by start_url (max length 255)

string

The call_parameters string is POSTed to the URL specified by start_url (max length 255)

integer

An integer between 0 and 10 for the number of failed call attempts before giving up

integer

An integer from 60 to 172800 indicating the number of seconds between retries

integer

0 to start immediately or a UNIX-time integer indicating when to start attempting the call

integer

0 to never expire or a UNIX-time integer indicating when the outbound system should give up attempting to complete an uncompleted call

string

Alternative option to scheduled_timestamp. See call control settings below. (max length 80)

string

Alternative option to expiration_timestamp. See call control settings below. (max length 80)

string

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

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json