Queue Call
API for queuing a single outbound call
- NEW! - Interactive API docs, now live!
Visit api-docs.plumvoice.com to read Plum API documentation, build and test requests in our interactive API sandbox, review the responses, and share it all with your team.
If you plan to queue more than one call at a time, use the Queue Multiple Calls API Method. Looping the Single Call API for individual calls can cause DDoS, which will result in all calls failing.
Queuing An Outbound Call
POST
https://fuse.plumvoice.com/api/apps/{application_id}/{deployment_id}/queue
Queue an outbound call
Path Parameters
application_id
number
Application ID number.
deployment_id
number
Deployment ID number.
Headers
Content-type
string
multipart/form-data
Accept
string
application/x-www-form-urlencoded, application/json
Request Body
phone_number
string
This is the destination phone number for the outbound call. There are multiple ways to format phone numbers. They can include the 'tel:' prefix and/or the ANI and postd suffixes, e.g. ani=8009957586 and/or postd=2. tel:+16175551234;ani=8009957586 (this sets the caller ID) A masking number should be used for outbound calls calls as Fuse do not have a default caller ID value, and shows a destination for the person to respond and return the call.
start_timestamp
string
Unix timestamp indicating when to begin the outbound dialing attempts. If not specified, the calls go out immediately.
end_timestamp
string
Unix timestamp indicating when to stop attempting the outbound call.
max_attempts
integer
Total number of times (integer between 1-10) to attempt calling a specific number (if previous attempts are not completed successfully). This field requires reattempt_wait field to be set.
reattempt_wait
integer
Interval (in seconds) to wait before retrying the outbound call after a failure. This is only required when you set a max_attempts value greater than one, which indicates additional retry attempts. Valid values range from 60 to 86400 (1 minute to 1 day).
metadata
string
JSON object of key⇒value pairs of variables and their related values for use with an application at run time. Ex: {“first_name”:“Steve”,“last_name”:“Smith”} These variables can be access as first_name and last_name respectively within the application.
result_url
string
Callback URL to your REST service that processes the call status results when the call is completed, canceled, or all attempts have been exhausted. The POST body matches the format of the call_details attribute from the outbound call status API response.
is_pci
integer
For customers who have been granted access to our HIPAA / PCI compliant secure environment setting this flag to 1 will cause connected outbound calls to execute within that secure environment. (Integer 0 or 1).
Possible Response Codes
200: success, call successfully queued.
400: supplied data improperly formatted or invalid
401: authentication headers invalid or the account is inactive
403: the user attempting to queue the outbound call does not have appropriate permissions
404: deployment not found
405: invalid HTTP method supplied (only POST allowed)
409: user, deployment, or application previously deleted
500: database error
The return structure will contain the following item(s):
Name
Data Type
Always Present
Description
error
string
no
This indicates which error occurred if the HTTP code is not 200.
call_id
int
no
A 200 HTTP code returns this value, which is the unique identifier for an outbound call when the request is successful. Users can use the call_id value to look up call details in the call details API method outlined below.
Note: The returned 'Link' header provides the URI for checking the status of the most recent outbound call attempt.
Sample Code
This sample PHP code makes a request to queue a new outbound call. This triggers an outbound call that goes out immediately and makes a single attempt to connect:
Last updated