Get Line Details - Revision history

Admin at 21:05, 23 May 2013

2013-05-23T21:05:23Z

← Older revision		Revision as of 23:05, 23 May 2013
Line 1:		Line 1:
	=~~SMS~~ Function: getLineDetails=		=VoIP Function: getLineDetails=

	With this command, you are able to view history of sending text messages		With this command, you are able to view history of sending text messages

Admin: /* Example using our PHP Class */

2013-05-23T13:04:00Z

Example using our PHP Class

← Older revision		Revision as of 15:04, 23 May 2013
Line 113:		Line 113:

	/* API COMMAND DETAILS */		/* API COMMAND DETAILS */
	$apitype = '~~sms~~';		$apitype = 'voip';
	$command = '~~getHistory~~';		$command = 'getLineDetails';
	$params = array(		$params = array(
	'returntype' => 'xml',		'returntype' => 'xml',
	'~~datefrom~~' => '~~2012-05-09 10:00:00',~~		'number' => '4122XXXXXX1'
	~~'dateto' => '2012-05-09 11:00:00~~'
	);		);

Admin: /* Example in JSON (Success) */

2013-05-23T13:02:52Z

Example in JSON (Success)

← Older revision		Revision as of 15:02, 23 May 2013
Line 76:		Line 76:
	"resulttxt":"success",		"resulttxt":"success",
	"params":{		"params":{
	"~~history~~":{		"line":"4122XXXXXX1",
	"~~sms1~~":{		"date_created":"2013-04-01",
	"~~sender~~":"~~boxis~~.~~net~~",		"firstpayment":"3.99",
	"~~reciptient~~":"~~48514151563~~",		"total":"3.99",
	"~~date~~":"~~2012~~-05-~~09 10:28:00~~",		"billingcycle":"Monthly",
	"~~parts~~":"1","~~credit~~":"1",		"next_due":"2013-06-01",
	"~~type~~":"~~scheduled~~"},		"next_invoice":"2013-05-25",
	"~~sms2~~":{		"status":"Active",
	"~~sender~~":"~~boxis~~.~~net~~",		"username":"4122XXXXXX1",
	"~~reciptient~~":"~~48614606553~~",		"fullcontact":"sip:4122XXXXXX1@78.40.77.163",
	"~~date~~":"~~2012-05-09 10~~:~~20:00~~",		"allowed_ips":"0.0.0.0/0.0.0.0",
	"~~parts~~":"1",		"port":"5060",
	"~~credit~~":"1",		"regseconds":"1369310543",
	"~~type~~":"~~sent~~"}}		"current_ip":"78.40.77.163",
			"useragent":"Asterisk PBX 1.6.2.10",
			"lastms":"1",
			"simultaneouscalls":"1"
			}
	"timestamp":1335777400}		"timestamp":1335777400}
	</pre>		</pre>

Admin: Created page with "=SMS Function: getLineDetails= With this command, you are able to view history of sending text messages == Input params == *'''version'''::String - ''API version (e.g. '1...."

2013-05-23T12:03:35Z

Created page with "=SMS Function: getLineDetails= With this command, you are able to view history of sending text messages == Input params == *'''version'''::String - ''API version (e.g. '1...."

New page

=SMS Function: getLineDetails=

With this command, you are able to view history of sending text messages

== 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 'getLineDetails' value

*'''number'''::String - ''Line number you wich to get details. (e.g '4122XXXXXX1')''

== Example URL with POST values ==

<pre>
http://api.boxis.net/
POST: version=1.0&returntype=xml&timestamp=1337853467&username=your@mail.com&authcode=1234567890&section=voip&action=getLineDetails&number=4122XXXXXX1
</pre>

== Output params ==

==== Example in XML (Success) ====

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<return>
<result>1</result>
<resulttxt>success</resulttxt>
<params>
<line>4122XXXXXX1</line>
<date_created>2013-04-01</date_created>
<firstpayment>3.99</firstpayment>
<total>3.99</total>
<billingcycle>Monthly</billingcycle>
<next_due>2013-06-01</next_due>
<next_invoice>2013-05-25</next_invoice>
<status>Active</status>
<username>4122XXXXXX1</username>
<fullcontact>sip:4122XXXXXX1@78.40.77.163</fullcontact>
<allowed_ips>0.0.0.0/0.0.0.0</allowed_ips>
<port>5060</port>
<regseconds>1369310543</regseconds>
<current_ip>78.40.77.163</current_ip>
<useragent>Asterisk PBX 1.6.2.10</useragent>
<lastms>1</lastms>
<simultaneouscalls>1</simultaneouscalls>
</params>
<timestamp>1369310526</timestamp>
</return>
</pre>

==== Example in XML (Error) ====

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

==== Example in JSON (Success) ====

<pre>
{"result":"1",
"resulttxt":"success",
"params":{
"history":{
"sms1":{
"sender":"boxis.net",
"reciptient":"48514151563",
"date":"2012-05-09 10:28:00",
"parts":"1","credit":"1",
"type":"scheduled"},
"sms2":{
"sender":"boxis.net",
"reciptient":"48614606553",
"date":"2012-05-09 10:20:00",
"parts":"1",
"credit":"1",
"type":"sent"}}
"timestamp":1335777400}
</pre>

==== Example in JSON (Error) ====

<pre>
{"result":"0",
"resulttxt":"Error: {error description}",
"timestamp":1335777400}
</pre>

== Example using our PHP Class ==
<pre>
/* API LOGIN DETAILS */
$email = 'your@mail.com'; // your username
$apikey = '1234567890'; // your apikey

/* API COMMAND DETAILS */
$apitype = 'sms';
$command = 'getHistory';
$params = array(
'returntype' => 'xml',
'datefrom' => '2012-05-09 10:00:00',
'dateto' => '2012-05-09 11:00:00'
);

/* 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);
}
/*

</pre>