{"_id":"59082bf85c7b492f00b40c65","project":"558d9c32beb7c719007f6319","version":{"_id":"558d9c33beb7c719007f631c","project":"558d9c32beb7c719007f6319","__v":19,"createdAt":"2015-06-26T18:38:43.154Z","releaseDate":"2015-06-26T18:38:43.153Z","categories":["558d9c33beb7c719007f631d","558db0bc7afc102f008ed863","558db0d07afc102f008ed864","558db3c84cd25f0d00b7ecb2","558dbace7afc102f008ed894","558dbd104cd25f0d00b7ecca","558dbd4c4cd25f0d00b7eccb","559d3e858639bd21008e90a6","55bb8ca5a8400c2d00873e70","58fdfb438fbd2819000db9eb","590829c7ade4172d006a87b8","59082a11beedcf0f00235d87","5908bd2cba2afd23007d6d12","5908d1f64f544425002b6aae","591e5e9e2c1b1f0f000fa4e5","5a283434aba91f002834ea86","5a69fe5cde745d002c936c66","5a81e6ef761cf300127317f8","5a81e7d63b1e120012bed5a1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"590829c7ade4172d006a87b8","project":"558d9c32beb7c719007f6319","__v":0,"version":"558d9c33beb7c719007f631c","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-05-02T06:40:07.955Z","from_sync":false,"order":1,"slug":"administration-apis","title":"Administration APIs"},"githubsync":"","user":"58cadf93d223510f005d27db","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-05-02T06:49:28.086Z","link_external":false,"link_url":"","sync_unique":"","hidden":true,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"[block:api-header]\n{\n  \"title\": \"Use the Number Search API to search available tracking numbers\"\n}\n[/block]\nUse the Number Search API to search available tracking numbers within DialogTech's available inventory.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Base URL for Number Search\",\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.search**\",\n    \"0-3\": \"n/a\",\n    \"0-4\": \"Only accepts **numbers.search** to search numbers\",\n    \"0-5\": \"Defines the API Call as \\\"Number Search\\\" 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\": \"type\",\n    \"4-0\": \"value\",\n    \"3-1\": \"Yes\",\n    \"3-2\": \"String: **local** or **tollfree**\",\n    \"4-2\": \"area code, or area code + exchange\",\n    \"4-1\": \"No*\",\n    \"3-3\": \"n/a\",\n    \"4-3\": \"6\",\n    \"3-4\": \"**local** - Search for a local number\\n**tollfree** - Search for a toll free number\",\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 type of number being searched for\",\n    \"4-5\": \"Defines the pattern being searched for within inventory\",\n    \"5-0\": \"quantity\",\n    \"5-1\": \"No\",\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  },\n  \"cols\": 6,\n  \"rows\": 6\n}\n[/block]\n*Required when `type=local`\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    Search Number EX:\\n    This example will search DialogTech's\\n    inventory for a local number matching\\n    the area code of 555.\\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.search\\\";\\n\\n  // Required User Parameters To Request the API\\n  $access_key = \\\"foo\\\";\\n  $secret_access_key = \\\"bar\\\";\\n  $type = \\\"local\\\";\\n  $value = \\\"555\\\";\\n  \\n  // Non required parameters used to request toe API\\n  $quantity = \\\"3\\\";\\n\\n\\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    \\\"&type=\\\" . $type .\\n    \\\"&value=\\\" . $value .\\n    \\\"&quantity=\\\" . $quantity;\\n\\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>\\n  <quantity>3</quantity>\\n  <numbers>\\n    <number>\\n      <tenDigit>5556666666</tenDigit>\\n    </number>\\n    <number>\\n      <tenDigit>5557777777</tenDigit>\\n    </number>\\n    <number>\\n      <tenDigit>5558888888</tenDigit>\\n    </number>\\n  </numbers>\\n</result_description>\\n</response>\\n\",\n      \"language\": \"xml\",\n      \"name\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"API to search available tracking numbers","slug":"number-search","type":"basic","title":"Number Search"}

Number Search

API to search available tracking numbers

Use the Number Search API to search available tracking numbers

Use the Number Search API to search available tracking numbers within DialogTech's available inventory.

Base URL for Number Search

https://secure.dialogtech.com/ibp_api.php

Parameter List

Parameter
Required
Accepts
Max Length
Notes
Usage

action

Yes

String: numbers.search

n/a

Only accepts numbers.search to search numbers

Defines the API Call as "Number Search" 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

type

Yes

String: local or tollfree

n/a

local - Search for a local number
tollfree - Search for a toll free number

Defines the type of number being searched for

value

No*

area code, or area code + exchange

6

If searching by area code it must be 3 digits and for NpaNxx it must be 6 digits. Toll free numbers are not supported.

Defines the pattern being searched for within inventory

quantity

No

String

Range 0-50

Default: 10

Amount of phone numbers to return if available

*Required when type=local

Using this API

These code examples are meant to show a basic method of accessing DialogTech's IVR Report API.

<?php
  /*
    Search Number EX:
    This example will search DialogTech's
    inventory for a local number matching
    the area code of 555.
  */

  // Create cURL resource
  $ch = curl_init(); 
  $baseuri = "https://secure.dialogtech.com/ibp_api.php?";

  // API Specific Static Parameters
  $action = "numbers.search";

  // Required User Parameters To Request the API
  $access_key = "foo";
  $secret_access_key = "bar";
  $type = "local";
  $value = "555";
  
  // Non required parameters used to request toe API
  $quantity = "3";



  // Construct the full URL
  $full_url = $baseuri . "&action=" . $action .
    "&access_key=" . $access_key .
    "&secret_access_key=" . $secret_access_key .
    "&type=" . $type .
    "&value=" . $value .
    "&quantity=" . $quantity;


  // 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

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE response [
    <!ELEMENT response (result,result_description)>
    <!ELEMENT result (#PCDATA)>
    <!ELEMENT result_description (#PCDATA)>
    
    ]>
<response>
<result>success</result>
<result_description>
  <quantity>3</quantity>
  <numbers>
    <number>
      <tenDigit>5556666666</tenDigit>
    </number>
    <number>
      <tenDigit>5557777777</tenDigit>
    </number>
    <number>
      <tenDigit>5558888888</tenDigit>
    </number>
  </numbers>
</result_description>
</response>