https://apidocs.boxis.net/index.php?title=Special:NewPages&feed=atom&hidebots=1&hideredirs=1&limit=50&offset=&namespace=0&username=&tagfilter=
Boxis.net API Docs - New pages [en]
2024-03-29T02:06:33Z
From Boxis.net API Docs
MediaWiki 1.23.5
https://apidocs.boxis.net/index.php/List_Available_Phone_Numbers
List Available Phone Numbers
2013-05-23T21:02:21Z
<p>Admin: </p>
<hr />
<div><br />
=VoIP Function: ListAvailablePhoneNumbers=<br />
<br />
With this command, you are able to get the list of all the available phone numbers.<br />
<br />
<br />
== Input params ==<br />
<br />
*'''version'''::String - ''API version (e.g. '1.0')''<br />
<br />
*'''timestamp'''::String - ''Sequence of characters, denoting the date and time (e.g '1336553826')''<br />
<br />
*'''username'''::String - ''User e-mail address (e.g 'mail1@example.com')''<br />
<br />
*'''authcode'''::String - '' md5 hash consisting of the concatenation of timestamp and user_key (e.g md5(1336553826BX3KwWU2SuqvoEWnjYmOibf'))''<br />
<br />
*'''section'''::String - ''API module name. Use 'voip' value<br />
<br />
*'''action'''::String - ''API module function. Use 'ListAvailablePhoneNumbers' value<br />
<br />
<br />
== Example URL with POST values ==<br />
<br />
<pre><br />
https://api.boxis.net/<br />
POST: version=1.0&returntype=xml&timestamp=1337853135&username=your@mail.com&authcode=1234567890&section=voip&action=ListAvailablePhoneNumbers<br />
</pre><br />
<br />
== Output params ==<br />
<br />
==== Example in XML (Success) ====<br />
<br />
<pre><br />
<return><br />
<result>1</result><br />
<resulttxt>success</resulttxt><br />
<params><br />
<numbers><br />
<number1><br />
<country>Switzerland</country><br />
<country_calling_code>41</country_calling_code><br />
<zone>Geneva (022)</zone><br />
<zone_calling_code>22</zone_calling_code><br />
<number>41225100590</number><br />
<topnumber>yes</topnumber><br />
<unique_price>50.00</unique_price><br />
<monthly_price>0.00</monthly_price><br />
</number1><br />
<number2><br />
<country>Switzerland</country><br />
<country_calling_code>41</country_calling_code><br />
<zone>Geneva (022)</zone><br />
<zone_calling_code>22</zone_calling_code><br />
<number>41225100594</number><br />
<topnumber>no</topnumber><br />
<unique_price>0.00</unique_price><br />
<monthly_price>0.00</monthly_price><br />
</number2><br />
<number3><br />
...<br />
</number3><br />
<total_available>282</total_available><br />
</numbers><br />
</params><br />
<timestamp>1369342854</timestamp><br />
</return><br />
</pre><br />
<br />
==== Example in XML (Error) ====<br />
<br />
<pre><br />
<?xml version="1.0" encoding="UTF-8"?><br />
<return><br />
<result>0</result><br />
<resulttxt>error: {error description}</resulttxt><br />
<timestamp>1335767184</timestamp><br />
</return><br />
</pre><br />
<br />
==== Example in JSON (Success) ====<br />
<br />
<pre><br />
{"result":"1",<br />
"resulttxt":"success",<br />
"params":{<br />
"lines":{<br />
"line1":"4122XXXXXX1",<br />
"line2":"4122XXXXXX2",<br />
"line3":"4122XXXXXX3"<br />
}<br />
}<br />
"timestamp":1335777400}<br />
</pre><br />
<br />
==== Example in JSON (Error) ====<br />
<br />
<pre><br />
{"result":"0",<br />
"resulttxt":"Error: {error description}",<br />
"timestamp":1335777400}<br />
</pre><br />
<br />
<br />
== Example using our PHP Class ==<br />
<pre><br />
/* API LOGIN DETAILS */<br />
$email = 'your@mail.com'; // your username<br />
$apikey = '1234567890'; // your apikey<br />
<br />
/* API COMMAND DETAILS */<br />
$apitype = 'voip';<br />
$command = 'ListAvailablePhoneNumbers';<br />
$params = array();<br />
<br />
/* PROCESS THE ACTION */<br />
$boxisAPI = new BoxisAPIConnection($email, $apikey);<br />
$return = $boxisAPI->call($apitype, $command, $params, $timestamp);<br />
<br />
/* TIMESTAMP SYNCHRONIZATION (JSON EXAMPLE)<br />
if($return['timestamperror']) {<br />
$timestamp = $return['timestamp'];<br />
$return = $boxisAPI->call($apitype, $command, $params, 'json', $timestamp);<br />
}<br />
*/<br />
<br />
/* TIMESTAMP SYNCHRONIZATION (XML EXAMPLE)*/<br />
/*<br />
if($return->timestamperror) {<br />
$timestamp = $return->timestamp;<br />
$return = $boxisAPI->call($apitype, $command, $params, 'xml', $timestamp);<br />
}<br />
/*<br />
<br />
</pre></div>
Admin
https://apidocs.boxis.net/index.php/Get_Calls_History
Get Calls History
2013-05-23T15:01:18Z
<p>Admin: </p>
<hr />
<div>=VoIP Function: getCallsHistory=<br />
<br />
With this command, you are able to view history of calls that has been made from a line<br />
<br />
<br />
== Input params ==<br />
<br />
*'''version'''::String - ''API version (e.g. '1.0')''<br />
<br />
*'''timestamp'''::String - ''Sequence of characters, denoting the date and time (e.g '1336553826')''<br />
<br />
*'''username'''::String - ''User e-mail address (e.g 'mail1@example.com')''<br />
<br />
*'''authcode'''::String - '' md5 hash consisting of the concatenation of timestamp and user_key (e.g md5(1336553826BX3KwWU2SuqvoEWnjYmOibf'))''<br />
<br />
*'''section'''::String - ''API module name. Use 'voip' value<br />
<br />
*'''action'''::String - ''API module function. Use 'getCallsHistory' value<br />
<br />
*'''line'''::String - ''The line number that you wich to get calls history (e.g '4122XXXXXX1')''<br />
<br />
*'''datefrom'''::String - ''Start date in 'yyyy-mm-dd hh:mm' format. When datefrom and dateto value is empty function returns information about all sms<br />
<br />
*'''dateto'''::String - ''End date in 'yyyy-mm-dd hh:mm' format. When datefrom and dateto value is empty function returns information about all sms<br />
<br />
== Example URL with POST values ==<br />
<br />
<pre><br />
https://api.boxis.net/<br />
POST: version=1.0&returntype=xml&timestamp=1337853467&username=your@mail.com&authcode=1234567890&section=voip&action=getCallsHistory&line=4122XXXXXX1&datefrom=2012-05-09 10:00:00&dateto=2012-05-09 11:00:00<br />
</pre><br />
<br />
== Output params ==<br />
<br />
==== Example in XML (Success) ====<br />
<br />
<pre><br />
<?xml version="1.0" encoding="UTF-8"?><br />
<return><br />
<result>1</result><br />
<resulttxt>success</resulttxt><br />
<history><br />
<sms1><br />
<sender>boxis.net</sender><br />
<reciptient>48514151563</reciptient><br />
<date>2012-05-09 10:28:00</date><br />
<parts>1</parts><br />
<credit>1</credit><br />
<type>scheduled</type><br />
</sms1><br />
<sms2><br />
<sender>boxis.net</sender><br />
<reciptient>48717609573</reciptient><br />
<date>2012-05-09 10:20:00</date><br />
<parts>1</parts><br />
<credit>1</credit><br />
<type>sent</type><br />
</sms2><br />
</history><br />
<timestamp>1336558351</timestamp><br />
</return><br />
</pre><br />
<br />
==== Example in XML (Error) ====<br />
<br />
<pre><br />
<?xml version="1.0" encoding="UTF-8"?><br />
<return><br />
<result>0</result><br />
<resulttxt>error: {error description}</resulttxt><br />
<timestamp>1335767184</timestamp><br />
</return><br />
</pre><br />
<br />
==== Example in JSON (Success) ====<br />
<br />
<pre><br />
{"result":"1",<br />
"resulttxt":"success",<br />
"params":{<br />
"history":{<br />
"sms1":{<br />
"sender":"boxis.net",<br />
"reciptient":"48514151563",<br />
"date":"2012-05-09 10:28:00",<br />
"parts":"1","credit":"1",<br />
"type":"scheduled"},<br />
"sms2":{<br />
"sender":"boxis.net",<br />
"reciptient":"48614606553",<br />
"date":"2012-05-09 10:20:00",<br />
"parts":"1",<br />
"credit":"1",<br />
"type":"sent"}}<br />
"timestamp":1335777400}<br />
</pre><br />
<br />
==== Example in JSON (Error) ====<br />
<br />
<pre><br />
{"result":"0",<br />
"resulttxt":"Error: {error description}",<br />
"timestamp":1335777400}<br />
</pre><br />
<br />
<br />
== Example using our PHP Class ==<br />
<pre><br />
/* API LOGIN DETAILS */<br />
$email = 'your@mail.com'; // your username<br />
$apikey = '1234567890'; // your apikey<br />
<br />
/* API COMMAND DETAILS */<br />
$apitype = 'voip';<br />
$command = 'getCallsHistory';<br />
$params = array(<br />
'returntype' => 'xml',<br />
'line' => '4122XXXXXX1',<br />
'datefrom' => '2012-05-09 10:00:00',<br />
'dateto' => '2012-05-09 11:00:00'<br />
);<br />
<br />
/* PROCESS THE ACTION */<br />
$boxisAPI = new BoxisAPIConnection($email, $apikey);<br />
$return = $boxisAPI->call($apitype, $command, $params, $timestamp);<br />
<br />
/* TIMESTAMP SYNCHRONIZATION (JSON EXAMPLE)<br />
if($return['timestamperror']) {<br />
$timestamp = $return['timestamp'];<br />
$return = $boxisAPI->call($apitype, $command, $params, 'json', $timestamp);<br />
}<br />
*/<br />
<br />
/* TIMESTAMP SYNCHRONIZATION (XML EXAMPLE)*/<br />
/*<br />
if($return->timestamperror) {<br />
$timestamp = $return->timestamp;<br />
$return = $boxisAPI->call($apitype, $command, $params, 'xml', $timestamp);<br />
}<br />
/*<br />
<br />
</pre></div>
Admin
https://apidocs.boxis.net/index.php/Get_Line_Details
Get Line Details
2013-05-23T12:03:35Z
<p>Admin: </p>
<hr />
<div>=VoIP Function: getLineDetails=<br />
<br />
With this command, you are able to view history of sending text messages<br />
<br />
<br />
== Input params ==<br />
<br />
*'''version'''::String - ''API version (e.g. '1.0')''<br />
<br />
*'''timestamp'''::String - ''Sequence of characters, denoting the date and time (e.g '1336553826')''<br />
<br />
*'''username'''::String - ''User e-mail address (e.g 'mail1@example.com')''<br />
<br />
*'''authcode'''::String - '' md5 hash consisting of the concatenation of timestamp and user_key (e.g md5(1336553826BX3KwWU2SuqvoEWnjYmOibf'))''<br />
<br />
*'''section'''::String - ''API module name. Use 'voip' value<br />
<br />
*'''action'''::String - ''API module function. Use 'getLineDetails' value<br />
<br />
*'''number'''::String - ''Line number you wich to get details. (e.g '4122XXXXXX1')''<br />
<br />
== Example URL with POST values ==<br />
<br />
<pre><br />
http://api.boxis.net/<br />
POST: version=1.0&returntype=xml&timestamp=1337853467&username=your@mail.com&authcode=1234567890&section=voip&action=getLineDetails&number=4122XXXXXX1<br />
</pre><br />
<br />
== Output params ==<br />
<br />
==== Example in XML (Success) ====<br />
<br />
<pre><br />
<?xml version="1.0" encoding="UTF-8"?><br />
<return><br />
<result>1</result><br />
<resulttxt>success</resulttxt><br />
<params><br />
<line>4122XXXXXX1</line><br />
<date_created>2013-04-01</date_created><br />
<firstpayment>3.99</firstpayment><br />
<total>3.99</total><br />
<billingcycle>Monthly</billingcycle><br />
<next_due>2013-06-01</next_due><br />
<next_invoice>2013-05-25</next_invoice><br />
<status>Active</status><br />
<username>4122XXXXXX1</username><br />
<fullcontact>sip:4122XXXXXX1@78.40.77.163</fullcontact><br />
<allowed_ips>0.0.0.0/0.0.0.0</allowed_ips><br />
<port>5060</port><br />
<regseconds>1369310543</regseconds><br />
<current_ip>78.40.77.163</current_ip><br />
<useragent>Asterisk PBX 1.6.2.10</useragent><br />
<lastms>1</lastms><br />
<simultaneouscalls>1</simultaneouscalls><br />
</params><br />
<timestamp>1369310526</timestamp><br />
</return><br />
</pre><br />
<br />
==== Example in XML (Error) ====<br />
<br />
<pre><br />
<?xml version="1.0" encoding="UTF-8"?><br />
<return><br />
<result>0</result><br />
<resulttxt>error: {error description}</resulttxt><br />
<timestamp>1335767184</timestamp><br />
</return><br />
</pre><br />
<br />
==== Example in JSON (Success) ====<br />
<br />
<pre><br />
{"result":"1",<br />
"resulttxt":"success",<br />
"params":{<br />
"line":"4122XXXXXX1",<br />
"date_created":"2013-04-01",<br />
"firstpayment":"3.99",<br />
"total":"3.99",<br />
"billingcycle":"Monthly",<br />
"next_due":"2013-06-01",<br />
"next_invoice":"2013-05-25",<br />
"status":"Active",<br />
"username":"4122XXXXXX1",<br />
"fullcontact":"sip:4122XXXXXX1@78.40.77.163",<br />
"allowed_ips":"0.0.0.0/0.0.0.0",<br />
"port":"5060",<br />
"regseconds":"1369310543",<br />
"current_ip":"78.40.77.163",<br />
"useragent":"Asterisk PBX 1.6.2.10",<br />
"lastms":"1",<br />
"simultaneouscalls":"1"<br />
}<br />
"timestamp":1335777400}<br />
</pre><br />
<br />
==== Example in JSON (Error) ====<br />
<br />
<pre><br />
{"result":"0",<br />
"resulttxt":"Error: {error description}",<br />
"timestamp":1335777400}<br />
</pre><br />
<br />
<br />
== Example using our PHP Class ==<br />
<pre><br />
/* API LOGIN DETAILS */<br />
$email = 'your@mail.com'; // your username<br />
$apikey = '1234567890'; // your apikey<br />
<br />
/* API COMMAND DETAILS */<br />
$apitype = 'voip';<br />
$command = 'getLineDetails';<br />
$params = array(<br />
'returntype' => 'xml',<br />
'number' => '4122XXXXXX1'<br />
);<br />
<br />
/* PROCESS THE ACTION */<br />
$boxisAPI = new BoxisAPIConnection($email, $apikey);<br />
$return = $boxisAPI->call($apitype, $command, $params, $timestamp);<br />
<br />
/* TIMESTAMP SYNCHRONIZATION (JSON EXAMPLE)<br />
if($return['timestamperror']) {<br />
$timestamp = $return['timestamp'];<br />
$return = $boxisAPI->call($apitype, $command, $params, 'json', $timestamp);<br />
}<br />
*/<br />
<br />
/* TIMESTAMP SYNCHRONIZATION (XML EXAMPLE)*/<br />
/*<br />
if($return->timestamperror) {<br />
$timestamp = $return->timestamp;<br />
$return = $boxisAPI->call($apitype, $command, $params, 'xml', $timestamp);<br />
}<br />
/*<br />
<br />
</pre></div>
Admin
https://apidocs.boxis.net/index.php/Get_Lines_List
Get Lines List
2013-05-22T22:03:44Z
<p>Admin: moved Get Lines List to Get Line List</p>
<hr />
<div><br />
=VoIP Function: getLineList=<br />
<br />
With this command, you are able to get the list of the telephony lines.<br />
<br />
<br />
== Input params ==<br />
<br />
*'''version'''::String - ''API version (e.g. '1.0')''<br />
<br />
*'''timestamp'''::String - ''Sequence of characters, denoting the date and time (e.g '1336553826')''<br />
<br />
*'''username'''::String - ''User e-mail address (e.g 'mail1@example.com')''<br />
<br />
*'''authcode'''::String - '' md5 hash consisting of the concatenation of timestamp and user_key (e.g md5(1336553826BX3KwWU2SuqvoEWnjYmOibf'))''<br />
<br />
*'''section'''::String - ''API module name. Use 'voip' value<br />
<br />
*'''action'''::String - ''API module function. Use 'getLineList' value<br />
<br />
<br />
== Example URL with POST values ==<br />
<br />
<pre><br />
https://api.boxis.net/<br />
POST: version=1.0&returntype=xml&timestamp=1337853135&username=your@mail.com&authcode=1234567890&section=voip&action=getLineList<br />
</pre><br />
<br />
== Output params ==<br />
<br />
==== Example in XML (Success) ====<br />
<br />
<pre><br />
<?xml version="1.0" encoding="UTF-8"?><br />
<return><br />
<result>1</result><br />
<resulttxt>success</resulttxt><br />
<params><br />
<lines><br />
<line1>4122XXXXXX1</line1><br />
<line2>4122XXXXXX2</line2><br />
<line3>4122XXXXXX3</line3><br />
</lines><br />
</params><br />
<timestamp>1369259943</timestamp><br />
</return><br />
</pre><br />
<br />
==== Example in XML (Error) ====<br />
<br />
<pre><br />
<?xml version="1.0" encoding="UTF-8"?><br />
<return><br />
<result>0</result><br />
<resulttxt>error: {error description}</resulttxt><br />
<timestamp>1335767184</timestamp><br />
</return><br />
</pre><br />
<br />
==== Example in JSON (Success) ====<br />
<br />
<pre><br />
{"result":"1",<br />
"resulttxt":"success",<br />
"params":{<br />
"lines":{<br />
"line1":"4122XXXXXX1",<br />
"line2":"4122XXXXXX2",<br />
"line3":"4122XXXXXX3"<br />
}<br />
}<br />
"timestamp":1335777400}<br />
</pre><br />
<br />
==== Example in JSON (Error) ====<br />
<br />
<pre><br />
{"result":"0",<br />
"resulttxt":"Error: {error description}",<br />
"timestamp":1335777400}<br />
</pre><br />
<br />
<br />
== Example using our PHP Class ==<br />
<pre><br />
/* API LOGIN DETAILS */<br />
$email = 'your@mail.com'; // your username<br />
$apikey = '1234567890'; // your apikey<br />
<br />
/* API COMMAND DETAILS */<br />
$apitype = 'voip';<br />
$command = 'getLineList';<br />
$params = array();<br />
<br />
/* PROCESS THE ACTION */<br />
$boxisAPI = new BoxisAPIConnection($email, $apikey);<br />
$return = $boxisAPI->call($apitype, $command, $params, $timestamp);<br />
<br />
/* TIMESTAMP SYNCHRONIZATION (JSON EXAMPLE)<br />
if($return['timestamperror']) {<br />
$timestamp = $return['timestamp'];<br />
$return = $boxisAPI->call($apitype, $command, $params, 'json', $timestamp);<br />
}<br />
*/<br />
<br />
/* TIMESTAMP SYNCHRONIZATION (XML EXAMPLE)*/<br />
/*<br />
if($return->timestamperror) {<br />
$timestamp = $return->timestamp;<br />
$return = $boxisAPI->call($apitype, $command, $params, 'xml', $timestamp);<br />
}<br />
/*<br />
<br />
</pre></div>
Admin