Queue Call

post

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.

Body Params

string

required

Sender login name (max length 128)

string

required

Sender PIN code (max length 16)

phone_number

string

required

Phone number to be dialed (include a 1 before the area code) (max length 128)

Example: 16172003000;ani=6177123000

start_url

string

required

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

result_url

string

URL for post-call processing (max length 255)

message_reference

string

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

call_parameters

string

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

max_retries

integer

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

retry_interval

integer

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

scheduled_timestamp

integer

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

expiration_timestamp

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

string

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

expiration_time

string

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

is_pci

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

Example: 16172003000;ani=6177123000

200OK