Tuesday, March 30, 2010

Sending SMS with PHP

ntroduction

SMS (also known as text-messaging) has grown into a very popular method of communication. It has been around in Europe and Asia since the early nineties and its use is steadily increasing in the US as well.

SMS stands for "Short Message Service" and uses mobile phones to transmit (surprise, surprise) short messages to and from mobile phones and whilst many of us might not know this, it is also possible to send SMS messages from a website or a piece of software.

There are an infinite number of reasons why you might want to use your website to send SMS. You might want to add a "send by SMS" option to your headlines, for example, or you might want to provide 24/7 support in which your technician is alerted by SMS or you might simply want to provide your viewers with Free SMS to drive traffic to your site.

Although it is also possible to send SMS via e-mail, this tutorial will teach you how to send SMS using GET and POST HTTP methods in PHP (since it's the language I know).

For those of us that many not know this, using HTTP basically means the use of forms, just like a contact form, except that these will be submitted automatically as opposed to manually.

Although this tutorial can be used for any gateway that provides access via HTTP, it is based on TM4B's SMS Gateway because

1. they are the only gateway I know that have a simulation mode for tweaking your scripts
2. they don't have any set-up fees
3. their prices are low
4. they are reliable and
5. I use them

1. Understand the Requirements of the Gateway

Full details about connecting to TM4B are provided on their SMS API page.
They basically require us to provide six mandatory pieces of data:
username: our username
password: our password
msg: our SMS message(s)
to: the recipient(s) of our message
from: our sender id
route: the route of the message (i.e. first class or business class)

And we will add a seventh, which is "sim". This identifies that our message is only a simulation and so credits won't be removed from our account and messages won't actually be delivered.

2. Prepare the Request

Now the actual message-delivery process is handled by the gateway. All they want us to do is pass them the details of the message(s) in the form of an HTTP request, similar to this one:

http://www.tm4b.com/client/api/send.php? username=abcdef&password=12345&msg=This+is+sample+message.& to=447768254545%7C447956219273%7C447771514662& from=MyCompany&route=frst∼=yes

You can test the above example (which uses GET) by pasting it into your browser's address bar. You should get a response saying that the username is invalid, which is normal because this is just to demonstrate.

The first step is to save our data as variables and then convert them into a URL request. There are different ways of doing this, but this is a very innovative and useful way:
//initialize the request variable
$request = "";
//this is the username of our TM4B account
$param["username"] = "abcdef";
//this is the password of our TM4B account
$param["password"] = "12345";
//this is the message that we want to send
$param["msg"] = "This is sample message.";
//these are the recipients of the message
$param["to"] = "447768254545|447956219273|447771514662";
//this is our sender
$param["from"] = "MyCompany";
//we want to send the message via first class
$param["route"] = "frst";
//we are only simulating a broadcast
$param["sim"] = "yes";
//traverse through each member of the param array
foreach($param as $key=>$val){
//we have to urlencode the values
$request.= $key."=".urlencode($val);
//append the ampersand (&) sign after each paramter/value pair
$request.= "&";
}
//remove the final ampersand sign from the request
$request = substr($request, 0, strlen($request)-1);

We assign our credentials and routing information in the $param array. You'll notice that multiple recipients can be defined by separating them with the pipe-character. Each parameter value needs to be urlencoded and multiple key/value pairs are separated by ampersands. A final ampersand probably would not cause any problems but substr is still used to produce a tidy request.

The script will produce the following request that can be sent to the SMS gateway: username=abcdef&password=12345&msg=This+is+sample+message.& to=447768254545%7C447956219273%7C447771514662& from=MyCompany&route=frst∼=yes

3. Sending the request with CURL

Previously we saw that the request could be executed by pasting it into the browser window. But what we really want is for this to take place behind the scenes. The following code does exactly that using CURL.

CURL is a very impressive library that allows you to connect and communicate to many different types of servers with many different types of protocols. You can find more info in the PHP Manual.

This code opens up a connection with the gateway, sends the SMS message(s) and collects their message IDs which are presented within the response header.
//this is the url of the gateway's interface
$url = "http://www.tm4b.com/client/api/send.php";
//initialize curl handle
$ch = curl_init;
curl_setopt($ch, CURLOPT_URL, $url); //set the url
curl_setopt($ch, CURLOPT_RETURNTRANSFER,1); //return as a variable
curl_setopt($ch, CURLOPT_POST, 1); //set POST method
curl_setopt($ch, CURLOPT_POSTFIELDS, $request); //set the POST variables
$response = curl_exec($ch); //run the whole process and return the response
curl_close($ch); //close the curl handle
//show the result onscreen for debugging
//print $response;

First, we initialize a new CURL session.
Then we set our desired options; this includes setting CURLOPT_POST because TM4B's SMS API requires us to send multiple messages using POST.
Finally we execute the call and then close the handle.

4. Sending the Request with Sockets

CURL functions depend on an external library and PHP must have been compiled with the --with-curl flag.
So while CURL is very flexible and useful, it may not be available with your PHP installation.
If this is the case, you can still communicate with the SMS gateway using sockets.
//First prepare the info that relates to the connection
$host = "tm4b.com";
$script = "/client/api/send.php";
$request_length = strlen($request);
$method = "POST"; // must be POST if sending multiple messages
if ($method == "GET")
{
$script .= "?$request";
}
//Now comes the header which we are going to post.
$header = "$method $script HTTP/1.1rn";
$header .= "Host: $hostrn";
$header .= "Content-Type: application/x-www-form-urlencodedrn";
$header .= "Content-Length: $request_lengthrn";
$header .= "Connection: closernrn";
$header .= "$requestrn";

//Now we open up the connection
$socket = @fsockopen($host, 80, $errno, $errstr);
if ($socket) //if its open, then...
{
fputs($socket, $header); // send the details over
while(!feof($socket))
{
$output[] = fgets($socket); //get the results
}
fclose($socket);
}
/*
the message id's will be kept in one of the $output values
print "";
print_r($output);
print "";
*/

First we layout the information we'll need to send our SMS and use it construct the HTTP header. A socket connection is established to our gateway using fsockopen. Information is sent and received in the same manner PHP would read and write to a file. After our transfer is complete we close the socket using fclose.

5. Conclusion

That's It! Although it took me a long time to find CURL, I think it is the best, neatest and quickest option assuming your version of PHP supports it. Furthermore, whilst both fsockopen and CURL can send thousands of messages in one go, fsockopen might give you difficulties when parsing responses for large requests as the responses are transferred in chunks.

The above took me ages; I hope it saves you time.

Read more: http://www.webdesign.org/web-programming/php/sending-sms-with-php.14782.html#ixzz0jjEtZRSz

No comments:

Post a Comment