SMPP API. Simon Spencer // January 2, 2009

Transcription

1 SMPP API Simon Spencer // January 2,

2 Contents 1 Introduction 3 2 General Outline 3 3 Protocol Overview 4 4 Detailed Method Desc SMPPAPI low SMPPAPI Examples Sending a Single SMS Starting SMS Reciever

3 1 Introduction This document outlines the start of the SMPP API for PHP. The API is currently only half created and less than half tested, but it is a good starting point for anyone experimenting with PHP and SMPP. 2 General Outline The PEAR libraries contain some SMPP related functions which pack a message string into a binary PDU so that it can be sent. Using these methods, it is possible to create the data to be sent, however the actual sending needs to be done by opening sockets and sending the correct packets, according to the protocol specification. This spec can be found with this document. There are two types of file here, PEAR classes and the SMPP API files themselves. The PEAR classes should be installed under <pearroot>/net/smpp/command as they extend the current PEAR SMPP implementation to include messages such as bind reciever messages, that are missing from the PEAR library. I believe the intention of the PEAR library is just to have the ability to send SMS messages, rather than recieve them which is why this extension is necessary. The API itself needs to be included in the PHP class you re using, however this only needs to be the SMPPAPI.php file (see example section). 3

4 3 Protocol Overview You should have read the protocol document, but if not, this diagram sums it up pretty well. Figure 1: Simple version of Protocol 4

5 4 Detailed Method Desc 4.1 SMPPAPI low This class contains much of the low level functions for creating sockets and sending data. function printpack($data) Prints out the pack in base 10, so two PDUs can easily be compared. $data needs to be a generated PDU. function readsocket($readbytes) Reads a certain number of bytes from the socket specified as a global parameter. function decodepack($msg) Decodes a PDU into human readable form. Returns a PEAR PDU object. function nextseq() Gets the next sequence number based on the previous packets. This is done automatically through the PEAR methods, so this method is only needed rarely. function writesocket($msg, $len) Writes $msg to the socket. $len is the length of the message. function opensocket($host, $port) Opens the socket defined in the global variables. function createsocket() Creates the socket defined in the global variables. function bindsocket($host, $port) Binds the socket to a host/port if the socket needs to act as a server. function debug($msg) Standard debug output stream. 5

6 4.2 SMPPAPI This class has higher level functions for sending SMPP messages. function unbind() Attempts to unbind the machine from an SMPP server. function raisepduevent($newpdu) Event handler for new PDU s coming in. Currently set to just print a message. function getpdu() Retrives a PDU from the socket. function sendunbind() Constructs the unbind packet and sends it. function getunbind_resp($oldpdu) Waits for an unbind response and returns it. function getgeneralresp($oldpdu) Waits for any response on the socket and returns what it finds. function sendresponse($newpdu,$sysid, $password, $systype, $host, $port) Automatically sends a response packet in response to a $newpdu. function transmitsinglesms($sysid, $password, $systype, $host, $port,$fromuri, $touri, $msg){ Function for sending a single SMS message. function transmitsms($fromuri, $touri, $msg) 6

7 Lower function for SMS message sending. function sendbind_transmitter($sysid, $password, $systype, $host, $port) Constructs the bind package and sends it. function getbind_trans_resp($oldpdu) Waits for a bind response and returns it. function sendsubmit_sm($fromuri, $touri, $msg) Sends a submit sm PDU. function getsubmit_sm_resp($oldpdu) Waits for a response to the submit and returns it. function startreceiver($sysid, $password, $systype, $host, $port) Starts a reciever for recieving SMPP messages. Currently untested due to lack of available SMPP server. function sendbind_receiver($sysid, $password, $systype, $host, $port){ Sends a bindreciever PDU. function getbind_receiver_resp($oldpdu) Waits for a bind receiver response and returns it. function senddeliver_sm($sysid, $password, $systype, $host, $port) Sends a deliver sm PDU. function pdurecv() Server loop for recieving PDUs. function handlepdu($newpdu) Handler for incomming PDUs. Currently very low level implementation. 7

8 4.3 Examples Two examples to get a better feel for the API Sending a Single SMS require_once SMPPAPI.php ; $host = " xxx.xxx"; $port = xxxx; $SMPP = new SMPPAPI(); $SMPP->transmitSingleSMS( VarsHere ); Starting SMS Reciever require "SMPPAPI.php"; $SMPP = new SMPPAPI(); echo "\n"; $SMPP->startReceiver( VarsHere ); 8