Cancel Outbound Calls

Please refer to Locating your Application and Deployment ID to get the correct application_id and deployment_Id

delete
Cancelling All Pending Outbound Calls

https://fuse.plumvoice.com/api/apps/{application_id}/{deployment_id}/cancel
Cancel all pending outbound calls
Request
Response
Request
Path Parameters
application_id
required
string
Application ID number
deployment_id
required
string
Deployment ID number
Response
202: Accepted
Call(s) successfully canceled.
No response body returned in either JSON or XML
404: Not Found
User, deployment, or application not found. Example: deployment not found.
JSON
XML
JSON
{"error": "No deployment was found by that application id and deployment id."}
XML
<?xml version="1.0"?>
<result>
<error>No deployment was found by that application id and deployment id.</error>
</result>

Possible Response Codes

  • 202: calls successfully canceled

  • 401: authentication headers invalid or the account is inactive

  • 403: the account attempting to cancel calls does not have appropriate permissions

  • 404: user, deployment, or application not found

  • 405: invalid HTTP method supplied (only DELETE allowed)

  • 500: database error

The return structure contains the following item(s):

Note: No body is returned for a successful response (HTTP code 202).

Name

Data Type

Always Present

Description

error

string

no

If the HTTP code is not 202, this provides a message indicating what error occurred.

Sample Code

This sample PHP code that makes a request to this method:

<?php
// account and application settings
$email = '<your_email_address>';
$developer_key = '<your_developer_key>';
$application_id = '<your_application_id>';
$deployment_id = '<your_deployment_id>';
// build the URL
$url = 'https://fuse.plumvoice.com/api/apps/'.$application_id.'/'.$deployment_id.'/cancel';
$ch = curl_init();
curl_setopt($ch, CURLOPT_USERPWD, $email.':'.$developer_key);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, array("Accept: application/json"));
$result = curl_exec($ch);
$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($result);
var_dump($http_code);