Get Sender Names - Revision history

Admin: /* Example URL with POST values */

2012-10-26T12:58:06Z

Example URL with POST values

← Older revision		Revision as of 14:58, 26 October 2012
Line 22:		Line 22:

	<pre>		<pre>
	~~https~~://boxis.net/~~xmlapi.php~~		http://api.boxis.net/
	POST: version=1.0&returntype=xml&timestamp=1337853229&username=yout@mail.com&authcode=1234567890&section=sms&action=getSenderNames		POST: version=1.0&returntype=xml&timestamp=1337853229&username=yout@mail.com&authcode=1234567890&section=sms&action=getSenderNames
	</pre>		</pre>


	== Output params ==		== Output params ==

Admin: /* Example using our PHP Class */

2012-06-26T13:09:11Z

Example using our PHP Class

@@ Line 89: / Line 89: @@
 /* PROCESS THE ACTION */
 $boxisAPI = new BoxisAPIConnection($email, $apikey);
-$return = $boxisAPI->call($apitype, $command, $params);
+$return = $boxisAPI->call($apitype, $command, $params, $timestamp);
 </pre>

Admin at 09:55, 24 May 2012

2012-05-24T09:55:18Z

← Older revision		Revision as of 11:55, 24 May 2012
Line 23:		Line 23:
	<pre>		<pre>
	https://boxis.net/xmlapi.php		https://boxis.net/xmlapi.php
	POST:		POST: version=1.0&returntype=xml&timestamp=1337853229&username=yout@mail.com&authcode=1234567890&section=sms&action=getSenderNames
	</pre>		</pre>

Admin at 09:48, 24 May 2012

2012-05-24T09:48:21Z

← Older revision		Revision as of 11:48, 24 May 2012
Line 17:		Line 17:

	*'''action'''::String - ''API module function. Use 'getSenderNames' value		*'''action'''::String - ''API module function. Use 'getSenderNames' value


			== Example URL with POST values ==

			<pre>
			https://boxis.net/xmlapi.php
			POST:
			</pre>

Admin at 09:03, 24 May 2012

2012-05-24T09:03:25Z

← Older revision		Revision as of 11:03, 24 May 2012
Line 47:		Line 47:
	</pre>		</pre>

	==== Example in ~~Json~~ (Success) ====		==== Example in JSON (Success) ====

	<pre>		<pre>
Line 59:		Line 59:
	</pre>		</pre>

	==== Example in ~~Json~~ (Error) ====		==== Example in JSON (Error) ====

	<pre>		<pre>

Admin at 09:00, 24 May 2012

2012-05-24T09:00:03Z

@@ Line 3: / Line 3: @@
 With this command, you are able to get sender names list.
-=== Output params ===
+== Input params ==
 ==== Example in XML (Success) ====
@@ Line 72: / Line 65: @@
   "resulttxt":"Error: {error description}",
   "timestamp":1335777400}
 </pre>

Admin: /* Input params */

2012-05-09T11:42:52Z

Input params

← Older revision		Revision as of 13:42, 9 May 2012
Line 22:		Line 22:
	\|-		\|-
	\| - '''action''' (String)		\| - '''action''' (String)
	''API module function. Use '~~getCreditLimit~~' value		''API module function. Use 'getSenderNames' value
	\|-		\|-
	\|}		\|}

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

2012-05-09T11:03:35Z

Example in XML (Success)

← Older revision		Revision as of 13:03, 9 May 2012
Line 38:		Line 38:
	<sender1>HQSMS</sender1>		<sender1>HQSMS</sender1>
	<sender2>boxis.net</sender2>		<sender2>boxis.net</sender2>
	</senders>		</senders>
	<timestamp>1336558351</timestamp>		<timestamp>1336558351</timestamp>
	</return>		</return>

Admin: Created page with "=SMS Function: getSenderNames= With this command, you are able to get sender names list. === Input params === {| |- | - '''version''' (string) ''API version (e.g. '1.0')'' |..."

2012-05-09T11:03:08Z

Created page with "=SMS Function: getSenderNames= With this command, you are able to get sender names list. === Input params === {| |- | - '''version''' (string) ''API version (e.g. '1.0')'' |..."

New page

=SMS Function: getSenderNames=

With this command, you are able to get sender names list.

=== 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 'sms' value
|-
| - '''action''' (String)
''API module function. Use 'getCreditLimit' value
|-
|}

=== Output params ===

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

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<return>
<result>1</result>
<resulttxt>success</resulttxt>
<senders>
<sender1>HQSMS</sender1>
<sender2>boxis.net</sender2>
</senders>
<timestamp>1336558351</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":{
"senders":{
"sender1":"HQSMS",
"sender2":"boxis.net"}}
"timestamp":1335777400}
</pre>

==== Example in Json (Error) ====

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