REST SMS Gateway API – credits resource

This blog post has been superseded with our website documentation

credits

This document is referred to by the REST SMS Gateway API – Specification Document.

Resource URI:

http://www.textmarketer.biz/services/rest/credits

Actions on the account credits.

• GET method - get the number of credits currently available on your account
• POST method - transfer credits between accounts

GET

GET method

Get the number of credits currently available on your account.

Example usage

http://www.textmarketer.biz/services/rest/credits

Example GET response

<response processed_date="2010-03-19T15:19:33+00:00">
<credits>37</credits>
</response>

Read the advanced specification of this response.

Specific error codes

N/A

Example PHP code

<?php
/**
 * GET request on the 'credits' resource
 */
$url = 'http://www.textmarketer.biz/services/rest/credits';
$username = 'myAPIusername'; // CHANGE THIS!!!
$password = 'myAPIpassword'; // CHANGE THIS!!!
$url = "$url?username=$username&password=$password";

// we're using the curl library to make the request
$curlHandle = curl_init();
curl_setopt($curlHandle, CURLOPT_URL, $url);
curl_setopt($curlHandle, CURLOPT_RETURNTRANSFER, true);
$responseBody = curl_exec($curlHandle);
$responseInfo  = curl_getinfo($curlHandle);
curl_close($curlHandle);

// deal with the response
if ($responseInfo['http_code']==200)
{
	$xml_obj = simplexml_load_string($responseBody);
	$credits = (int) $xml_obj->credits;
	// do something with the result
	echo $credits;

} else {
	// handle the error
	var_dump($responseBody);
}

?>

P

POST method

Transfer credits from the source/master account to the target/sub account.

Example usage

http://www.textmarketer.biz/services/rest/credits

Post arguments

or

OR you can specify the target account user name and password, rather than the target account number

Example POST

Example POST response

<response processed_date="2010-03-23T10:31:39+00:00">
	<source_credits_before>1000</source_credits_before>
	<source_credits_after>900</source_credits_after>
	<target_credits_before>0</target_credits_before>
	<target_credits_after>100</target_credits_after>
</response>

Read the advanced specification of this response.

Specific error codes

Example XML

Example XML error response

<response processed_date="2010-03-24T14:37:41+00:00">
<errors>
	<error code="0">Invalid number of credits specified: -1</error>
	<error code="1">Invalid destination account number</error>
</errors>
</response>

Example PHP code

<?php
/**
 * POST request on the 'credits' resource (credit transfer)
 */
$url = 'http://www.textmarketer.biz/services/rest/credits';
// uncomment for testing:
//$url = 'http://sandbox.textmarketer.biz/services/rest/credits';
$username = 'myAPIusername'; // CHANGE THIS!!! - the username of the account you're transferring FROM
$password = 'myAPIpassword'; // CHANGE THIS!!!
$targetAccountNumber = 0; // CHANGE THIS!!

$data = array('quantity'=>'1',
	'target'=>$targetAccountNumber,
	// or you could use the target username/password instead of 'target'
	// 'target_username'=>$targetUserName, 'target_password'=>$targetPassword,
	'username'=>$username, 'password'=>$password);
$data = http_build_query($data, '', '&');
// we're using the curl library to make the request
$curlHandle = curl_init();
curl_setopt($curlHandle, CURLOPT_URL, $url);
curl_setopt($curlHandle, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curlHandle, CURLOPT_POSTFIELDS, $data);
curl_setopt($curlHandle, CURLOPT_POST, 1);
$responseBody = curl_exec($curlHandle);
$responseInfo  = curl_getinfo($curlHandle);
curl_close($curlHandle);

// deal with the response
if ($responseInfo['http_code']==200)
{
	$xml_obj = simplexml_load_string($responseBody);
	// do something with the result
	echo "Source account credits before: $xml_obj->source_credits_before\n";
	echo "Source account credits after: $xml_obj->source_credits_after\n";
	echo "Target account credits before: $xml_obj->target_credits_before\n";
	echo "Target account credits after: $xml_obj->target_credits_after\n";
} else {
	// handle the error here
	var_dump($responseInfo);
	var_dump($responseBody);
}
?>

Popularity: 6%

Related posts:

1. REST SMS API Code Examples
   This blog post has been superseded with our website documentation In our REST API specification document we saw, in general terms, how to...
2. REST SMS Gateway API – Specification Document
   This blog post has been superseded with our website documentation For an overview of what REST and our RESTful SMS API is all...
3. RESTful Web Services SMS Gateway API Overview
   This blog post has been superseded with our website documentation In addition to our simple HTTP SMS Gateway API, explained here, we also...
4. PHP 5 Simple SMS send Class
   This blog post has been superseded with our website documentation 2 classes available in php 5, SendSMS and SendSMSXML (recommended) Class Name: SendSMS...
5. SMS Gateway API – Specification
   This blog post has been superseded with our website documentation It is recommended that you use the  RESTful version of the API which has largely superseded this document...
6. Buying SMS credits and payment processing
   Topping up your account with text credits. Download the PDF instruction manual for the main functions of the system How...
7. Example of a Delphi/Pascal Interface for the Bulk SMS Gateway / API
   For more information regarding the bulk sending API click here. A code example for sending SMS via a Delphi Pascal...
8. Using the SMS Gateway API, Automating Delivery Report Collection
   This blog post has been superseded with our website documentation Introduction If you are using the API / Gateway to send bulk SMS...
9. How to integrate our SMS Gateway API into your systems
   Introduction Adding SMS as a communication method to a system is often very useful, for instance you don’t have issues...
10. PHP 5 SMS Send Class implementing listeners on our SMS Gateway
    Class Name: SendSMSNotifier This class is designed around the FREE Text Marketer SMS API, you need to sign up here...