phpExt / Plivo REST API / Delete an Application
Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
$http->put_BasicAuth(true);
$http->put_Login('{{auth_id}}');
$http->put_Password('password');
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "cascade": "true",
// "new_endpoint_application": "77506472664956327"
// }
$json = new CkJsonObject();
$json->UpdateString('cascade','true');
$json->UpdateString('new_endpoint_application','77506472664956327');
$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);
// resp is a CkHttpResponse
$resp = $http->PTextSb('DELETE','https://api.plivo.com/v1/Account/{auth_id}/Application/{app_id}/',$sbRequestBody,'utf-8','application/json',false,false);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode != 204) {
print 'Response Header:' . "\n";
print $resp->header() . "\n";
print 'Response Body:' . "\n";
print $resp->bodyStr() . "\n";
print 'Failed.' . "\n";
exit;
}
print 'Success.' . "\n";
?>
Curl Command
curl -X DELETE
-u '{{auth_id}}:password'
-d '{
"cascade":"true",
"new_endpoint_application":"77506472664956327"
}'
https://api.plivo.com/v1/Account/{auth_id}/Application/{app_id}/
Postman Collection Item JSON
{
"name": "Delete an Application",
"request": {
"method": "DELETE",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"cascade\":\"true\",\n \"new_endpoint_application\":\"77506472664956327\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.plivo.com/v1/Account/{auth_id}/Application/{app_id}/",
"protocol": "https",
"host": [
"api",
"plivo",
"com"
],
"path": [
"v1",
"Account",
"{auth_id}",
"Application",
"{app_id}",
""
]
},
"description": "This API would delete the Application permanently.\n\nBelow is the list of arguments that can be passed in this API request, more information can be found [here](https://www.plivo.com/docs/sms/api/message#send-a-message)\n\n| Arguments | Description | Required/Conditional/Optional |\n| :--- | :----: | ---: |\n| cascade | If cascade is set to true, the Endpoints associated with the Application, if any, are also deleted.When set to false, the Endpoints associated with the Application, if any, are not deleted. <br />If a new_endpoint_application has been specified, then the Endpoints are reassociated with the given Application. If a new_endpoint_application is not specified, then the Endpoints remain orphaned. (i.e. not associated with any Application.)cascade is set to true by default when not specified.| Optional |\n| new_endpoint_application | The app_id of the new Application to which the Endpoints should be associated upon deletion of this Application. | Required |"
},
"response": [
{
"name": "Delete an Application",
"originalRequest": {
"method": "DELETE",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"cascade\":\"true\",\n \"new_endpoint_application\":\"77506472664956327\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.plivo.com/v1/Account/{auth_id}/Application/{app_id}/",
"protocol": "https",
"host": [
"api",
"plivo",
"com"
],
"path": [
"v1",
"Account",
"{auth_id}",
"Application",
"{app_id}",
""
]
}
},
"code": 204,
"_postman_previewlanguage": "Text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}