» REST SMS Gateway API – sms resource

This blog post has been superseded with our website documentation

sms

This resource deals with sending SMS to customer.

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

Resource URI:

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

Actions relating to sending SMS messages.

• POST method - Used to send an SMS message.

POST

POST method

Attempts to send the specified SMS message.

Example usage:

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

Post arguments:

* Can be found by logging in to your account, Settings->API Settings

CONCATENATION

CONCATENATION

If you exceed 160 characters you automatically invoke concatenation sending, this has the following consequences: Each message consists of a 153 character ‘chunk’, i.e. no longer 160 chars; the extra characters are used to glue the messages together. Therefore a message that is 307 characters long will require 3 messages to send (153 + 153 + 1).

Example POST response:

<response processed_date="2010-03-23T10:31:39+00:00">
	<message_id>4172870907</message_id>
	<credits_used>1</credits_used>
</response>

• message_id – the unique message ID attributed to the sent SMS
• credits_used – the number of credits used to send the SMS

Read the advanced specification of this response.

Specific error codes:

CONCATENATION

Example XML error response:

<response processed_date="2010-03-24T14:37:41+00:00">
<errors>
	<error code="10">invalid number or not an integer</error>
	<error code="9">invalid number or too short</error>
</errors>
</response>

Example PHP code:

<?php
/**
 * POST request on the 'sms' resource (send an SMS)
 */
$url = 'http://www.textmarketer.biz/services/rest/sms';
//$url = 'http://sandbox.textmarketer.biz/services/rest/sms';

$username = 'myAPIusername'; // CHANGE THIS!!!
$password = 'myAPIpassword'; // CHANGE THIS!!!

$data = array('message'=>'hello','mobile_number'=>'447777123123', 'originator'=>'me',
	'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 "Message ID: $xml_obj->message_id\n";
	echo "Credits used: $xml_obj->credits_used\n";

	var_dump($responseBody);

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

NOTE

It is important to understand the difference between the status of a message in a delivery report, and getting a success or failure when using the API to send a message. A ’success’ response from the SMS send only confirms that the number and message appear to be in the correct format – this does not mean that the number actually exists, or that the message was received by the recipient. Delivery reports, however, confirm to you what has actually happened to the sent message. See the deliveryReport resource.

Popularity: 14%

Related posts:

1. 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 –...
2. REST SMS Gateway API – deliveryReports resource
   This blog post has been superseded with our website documentation deliveryReports This document is referred to by the REST SMS Gateway API – Specification...
3. REST SMS Gateway API – deliveryReport resource
   This blog post has been superseded with our website documentation deliveryReport This document is referred to by the REST SMS Gateway API – Specification...
4. 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...
5. 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...
6. 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...
7. 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...
8. 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...
9. 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...
10. 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...