{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"Number Remove","type":"basic","slug":"number-remove","excerpt":"","body":"[block:api-header]\n{\n \"title\": \"Use the Number Remove API to remove tracking numbers\"\n}\n[/block]\nUse the Number Removal API to remove existing tracking numbers from a DialogTech's account.\n[block:callout]\n{\n \"type\": \"info\",\n \"title\": \"Base URL for Number Remove\",\n \"body\": \"https://secure.dialogtech.com/ibp_api.php\"\n}\n[/block]\n\n[block:api-header]\n{\n \"title\": \"Parameter List\"\n}\n[/block]\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Required\",\n \"h-2\": \"Accepts\",\n \"h-3\": \"Max Length\",\n \"h-4\": \"Notes\",\n \"h-5\": \"Usage\",\n \"0-0\": \"action\",\n \"0-1\": \"Yes\",\n \"0-2\": \"String: **numbers.remove**\",\n \"0-3\": \"n/a\",\n \"0-4\": \"Only accepts **numbers.remove** to remove numbers\",\n \"0-5\": \"Defines the API Call as \\\"Number Order\\\" type\",\n \"1-0\": \"access_key\",\n \"1-1\": \"Yes\",\n \"1-2\": \"String\",\n \"1-3\": \"n/a\",\n \"2-0\": \"secret_access_key\",\n \"2-1\": \"Yes\",\n \"2-2\": \"String\",\n \"2-3\": \"n/a\",\n \"1-4\": \"Access Key from the Key Manager within a DialogTech account\",\n \"1-5\": \"Credentials used for access to the API for a particular DialogTech account\",\n \"2-5\": \"Credentials used for access to the API for a particular DialogTech account\",\n \"2-4\": \"Secret Access Key from the Key Manager within a DialogTech account\",\n \"3-0\": \"number\",\n \"4-0\": \"value\",\n \"3-1\": \"Yes\",\n \"3-2\": \"String: Unformatted Phone Number\",\n \"4-2\": \"area code, or area code + exchange\",\n \"4-1\": \"Yes\",\n \"3-3\": \"n/a\",\n \"4-3\": \"6\",\n \"3-4\": \"Must be a tracking number within the account\",\n \"4-4\": \"If searching by area code it must be 3 digits and for NpaNxx it must be 6 digits. *Toll free numbers are not supported.*\",\n \"3-5\": \"Defines the number being removed from the account\",\n \"4-5\": \"Defines the pattern being searched for within inventory\",\n \"5-0\": \"quantity\",\n \"5-1\": \"Yes\",\n \"5-2\": \"String\",\n \"5-3\": \"**Range 0-50**\",\n \"5-4\": \"*Default: 10*\",\n \"5-5\": \"Amount of phone numbers to return if available\",\n \"6-0\": \"fill_quantity\",\n \"6-1\": \"Yes\",\n \"6-2\": \"String**0** or **1**\",\n \"6-3\": \"n/a\",\n \"6-4\": \"**0** - Allow a partial order\\n**1** - Do not allow a partial order\",\n \"6-5\": \"Determines if a partial order is acceptable. If 5 numbers are requested, and only 3 are available, a **0** on this value will purchase those 3 numbers. **1** will purchase no numbers as not all 5 are available to fulfill the order.\"\n },\n \"cols\": 6,\n \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n \"title\": \"Using this API\"\n}\n[/block]\nThese code examples are meant to show a basic method of accessing DialogTech's IVR Report API.\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"<?php\\n /*\\n Order Removal EX:\\n This example will remove a number\\n from a DialogTech account.\\n */\\n\\n // Create cURL resource\\n $ch = curl_init(); \\n $baseuri = \\\"https://secure.dialogtech.com/ibp_api.php?\\\";\\n\\n // API Specific Static Parameters\\n $action = \\\"numbers.remove\\\";\\n\\n // Required User Parameters To Request the API\\n $access_key = \\\"foo\\\";\\n $secret_access_key = \\\"bar\\\";\\n $number = \\\"5556667777\\\";\\n\\n // Construct the full URL\\n $full_url = $baseuri . \\\"&action=\\\" . $action .\\n \\\"&access_key=\\\" . $access_key .\\n \\\"&secret_access_key=\\\" . $secret_access_key .\\n \\\"&number=\\\" . $number;\\n\\n // Set the URL\\n curl_setopt($ch, CURLOPT_URL, $full_url);\\n\\n // Sets the return options of the cURL to return the actual result from the curl request, and FALSE on failure\\n curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);\\n\\n // Sets the $output variable to the result of the curl\\n $output = curl_exec($ch);\\n\\n // Close curl resource to free up system resources\\n curl_close($ch);\\n\\n // Echo the XML response to the page\\n echo $output;\\n?>\",\n \"language\": \"text\",\n \"name\": \"PHP Example\"\n },\n {\n \"code\": \"curl -X \\\"\\\"\",\n \"language\": \"text\",\n \"name\": \"cURL\"\n }\n ]\n}\n[/block]\n**Example Response**\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<!DOCTYPE response [\\n <!ELEMENT response (result,result_description)>\\n <!ELEMENT result (#PCDATA)>\\n <!ELEMENT result_description (#PCDATA)>\\n \\n ]>\\n<response>\\n<result>success</result>\\n<result_description>5556667777 was removed from your account</result_description>\\n</response>\",\n \"language\": \"xml\",\n \"name\": \"xml\"\n }\n ]\n}\n[/block]","updates":[],"order":5,"isReference":false,"hidden":true,"sync_unique":"","link_url":"","link_external":false,"_id":"59082c2a192e1b0f0036ed24","__v":0,"githubsync":"","user":"58cadf93d223510f005d27db","createdAt":"2017-05-02T06:50:18.235Z","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["558d9c33beb7c719007f631d","558db0bc7afc102f008ed863","558db0d07afc102f008ed864","558db3c84cd25f0d00b7ecb2","558dbace7afc102f008ed894","558dbd104cd25f0d00b7ecca","558dbd4c4cd25f0d00b7eccb","559d3e858639bd21008e90a6","55bb8ca5a8400c2d00873e70","58fdfb438fbd2819000db9eb","590829c7ade4172d006a87b8","59082a11beedcf0f00235d87","5908bd2cba2afd23007d6d12","5908d1f64f544425002b6aae","591e5e9e2c1b1f0f000fa4e5","5a283434aba91f002834ea86","5a69fe5cde745d002c936c66","5a81e6ef761cf300127317f8","5a81e7d63b1e120012bed5a1","5f6cf225ba56a40011bff62d","5f970e8b7617eb041ae758bb","602adb88243fbc0056918566","602adbb91828a600535980c4"],"_id":"558d9c33beb7c719007f631c","createdAt":"2015-06-26T18:38:43.154Z","project":"558d9c32beb7c719007f6319","releaseDate":"2015-06-26T18:38:43.153Z","__v":23},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Administration APIs","slug":"administration-apis","order":1,"from_sync":false,"reference":false,"_id":"590829c7ade4172d006a87b8","createdAt":"2017-05-02T06:40:07.955Z","project":"558d9c32beb7c719007f6319","__v":0,"version":"558d9c33beb7c719007f631c"},"parentDoc":null,"project":"558d9c32beb7c719007f6319"}
Number Remove
Use the Number Removal API to remove existing tracking numbers from a DialogTech's account.
Base URL for Number Remove
action
Yes
String: numbers.remove
n/a
Only accepts numbers.remove to remove numbers
Defines the API Call as "Number Order" type
access_key
Yes
String
n/a
Access Key from the Key Manager within a DialogTech account
Credentials used for access to the API for a particular DialogTech account
secret_access_key
Yes
String
n/a
Secret Access Key from the Key Manager within a DialogTech account
Credentials used for access to the API for a particular DialogTech account
number
Yes
String: Unformatted Phone Number
n/a
Must be a tracking number within the account
Defines the number being removed from the account
These code examples are meant to show a basic method of accessing DialogTech's IVR Report API.
<?php
/*
Order Removal EX:
This example will remove a number
from a DialogTech account.
*/
// Create cURL resource
$ch = curl_init();
$baseuri = "https://secure.dialogtech.com/ibp_api.php?";
// API Specific Static Parameters
$action = "numbers.remove";
// Required User Parameters To Request the API
$access_key = "foo";
$secret_access_key = "bar";
$number = "5556667777";
// Construct the full URL
$full_url = $baseuri . "&action=" . $action .
"&access_key=" . $access_key .
"&secret_access_key=" . $secret_access_key .
"&number=" . $number;
// Set the URL
curl_setopt($ch, CURLOPT_URL, $full_url);
// Sets the return options of the cURL to return the actual result from the curl request, and FALSE on failure
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
// Sets the $output variable to the result of the curl
$output = curl_exec($ch);
// Close curl resource to free up system resources
curl_close($ch);
// Echo the XML response to the page
echo $output;
?>
curl -X ""
Example Response
<response>
<result>success</result>
<result_description>5556667777 was removed from your account</result_description>
</response>