List Available Phone Numbers

From Boxis.net API Docs
Revision as of 21:03, 23 May 2013 by Admin (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

VoIP Function: ListAvailablePhoneNumbers

With this command, you are able to get the list of all the available phone numbers.


Input params

  • version::String - API version (e.g. '1.0')
  • timestamp::String - Sequence of characters, denoting the date and time (e.g '1336553826')
  • username::String - User e-mail address (e.g 'mail1@example.com')
  • authcode::String - md5 hash consisting of the concatenation of timestamp and user_key (e.g md5(1336553826BX3KwWU2SuqvoEWnjYmOibf'))
  • section::String - API module name. Use 'voip' value
  • action::String - API module function. Use 'ListAvailablePhoneNumbers' value


Example URL with POST values

https://api.boxis.net/
POST: version=1.0&returntype=xml&timestamp=1337853135&username=your@mail.com&authcode=1234567890&section=voip&action=ListAvailablePhoneNumbers

Output params

Example in XML (Success)

<return>
  <result>1</result>
  <resulttxt>success</resulttxt>
  <params>
    <numbers>
      <number1>
        <country>Switzerland</country>
        <country_calling_code>41</country_calling_code>
        <zone>Geneva (022)</zone>
        <zone_calling_code>22</zone_calling_code>
        <number>41225100590</number>
        <topnumber>yes</topnumber>
        <unique_price>50.00</unique_price>
        <monthly_price>0.00</monthly_price>
      </number1>
      <number2>
        <country>Switzerland</country>
        <country_calling_code>41</country_calling_code>
        <zone>Geneva (022)</zone>
        <zone_calling_code>22</zone_calling_code>
        <number>41225100594</number>
        <topnumber>no</topnumber>
        <unique_price>0.00</unique_price>
        <monthly_price>0.00</monthly_price>
      </number2>
      <number3>
...
      </number3>
      <total_available>282</total_available>
    </numbers>
  </params>
  <timestamp>1369342854</timestamp>
</return>

Example in XML (Error)

<?xml version="1.0" encoding="UTF-8"?>
<return>
  <result>0</result>
  <resulttxt>error: {error description}</resulttxt>
  <timestamp>1335767184</timestamp>
</return>

Example in JSON (Success)

{"result":"1",
 "resulttxt":"success",
 "params":{
   "lines":{
     "line1":"4122XXXXXX1",
     "line2":"4122XXXXXX2",
     "line3":"4122XXXXXX3"
     }
   }
 "timestamp":1335777400}

Example in JSON (Error)

{"result":"0",
 "resulttxt":"Error: {error description}",
 "timestamp":1335777400}


Example using our PHP Class

/* API LOGIN DETAILS */
$email    = 'your@mail.com';    // your username
$apikey   = '1234567890';        // your apikey

/* API COMMAND DETAILS */
$apitype  = 'voip';
$command  = 'ListAvailablePhoneNumbers';
$params   = array();

/* PROCESS THE ACTION */
$boxisAPI = new BoxisAPIConnection($email, $apikey);
$return = $boxisAPI->call($apitype, $command, $params, $timestamp);

/* TIMESTAMP SYNCHRONIZATION (JSON EXAMPLE)
if($return['timestamperror']) {
    $timestamp = $return['timestamp'];
    $return = $boxisAPI->call($apitype, $command, $params, 'json', $timestamp);
}
*/

/* TIMESTAMP SYNCHRONIZATION (XML EXAMPLE)*/
/*
if($return->timestamperror) {
    $timestamp = $return->timestamp;
    $return = $boxisAPI->call($apitype, $command, $params, 'xml', $timestamp);
}
/*